bundles/org.eclipse.platform.doc.user/concepts/help.htm - platform/eclipse.platform.common - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html lang="en">
 <head>
 <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2019. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
 <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
 <meta http-equiv="Content-Style-Type" content="text/css">
 <link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
 <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script>
 <title>Help</title>
 </head>
 <body>

 <h1>Help</h1>

 <p>
 The Help system lets you browse, search, bookmark, and print help documentation.
 The documentation is organized into sets of information that are analogous to
 books. The help system also supplies a text search capability for finding the
 information you need by search phrase or keyword, and context-sensitive help for
 finding information to describe the particular function you are working with.
 </p>

 <p>
 You can interact with help system in the workbench using the <strong>Help
 view</strong> or in the separate <strong>Help window</strong>. The view and
 window provide the same information but in different ways.
 </p>

 <h2>The Help view</h2>

 <p>
 The Help view provides help inside the workbench. You can open the view from
 the main menu by selecting <b>Help &gt; Dynamic Help</b> or <b>Help &gt;
 Search</b>. The view will open showing the Related Topics or Search page,
 respectively. You can use links at the top of the help view to turn to other
 pages.
 </p>

 <p>
 You can <a href="help_view.htm">read more</a> about the Help view and its
 various pages.
 </p>

 <p>
 <img src="../images/help_view_context.png"
 alt="Help view showing Related Topics page">
 </p>

 <h2>The Help window</h2>

 <p>
 The Help window provides the same content as the Help view, but in a
 <em>separate</em> window instead of in a view. You can open the window from the
 main menu by selecting <b>Help &gt; Help Contents</b>. The first view shown in
 the window is called Contents. This view displays the table of contents for the
 product documentation. Click on one of the links to expand the navigation tree
 for a set of documentation.
 </p>

 <p>
 <img src="../images/help_window.png" alt="Help window">
 </p>

 <p>
 Note that if your browser does not have JavaScript enabled or is an does not support the features
 required to display the normal help application "basic" help which will be displayed - this can
 easily be identified because closed
 books in the table of contents do not have an expander icon. You can find the user agent of your
 browser <a href="../../../about.html?show=agent">here.</a>
 </p>

 <h2>Context-sensitive help</h2>

 <p>
 If you are working through a task and encounter a part of the interface that
 you do not understand, you can summon context-sensitive help. By default, this
 will display the Help view and give you some specific information about the
 view/editor/dialog you are using, and possibly some links to topics for further
 help.
 </p>

 <p>
 Context-sensitive help can be accessed by bringing focus to the interface part
 in question by clicking on it or using the Tab key, and then pressing
 <code>F1</code> (<code>Shift+F1</code> on GTK+, and <code>Help</code> on the
 Mac). Alternatively, in dialogs you can achieve the same result by pressing
 the <img src="../images/help.svg" alt="Help button"> help button in the
 dialog's button bar.
 </p>

 <h3>Infopops</h3>

 <p>
 An alternative way of presenting context-sensitive information is using
 <b>infopops</b>. You can use the

 <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.help.ui.browsersPreferencePage)")'>
 <img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link">
 <b>Help</b></a> preference page to configure Help to use infopops instead of the Help view for displaying
 context-sensitive help.
 </p>

 <p>
 <img src="../images/help_infopop.png" alt="Help infopop" border="0">
 </p>

 <h3 class="related">Related concepts</h3>
 <a href="help_view.htm">Help view</a><br>

 <h3 class="related">Related tasks</h3>
 <a href="../tasks/help.xhtml">Accessing help</a><br>
 <a href="../tasks/help_navigate.htm">Navigating help topics</a><br>
 <a href="../tasks/help_context.htm">Accessing context-sensitive help</a><br>
 <a href="../tasks/help_search.htm">Searching help</a>

 <h3 class="related">Related reference</h3>
 <a href="../reference/help_preferences.htm">Help preferences</a>

 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html lang="en">
	<head>
	<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2019. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
	<meta http-equiv="Content-Style-Type" content="text/css">
	<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
	<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script>
	<title>Help</title>
	</head>
	<body>

	<h1>Help</h1>

	<p>
	The Help system lets you browse, search, bookmark, and print help documentation.
	The documentation is organized into sets of information that are analogous to
	books. The help system also supplies a text search capability for finding the
	information you need by search phrase or keyword, and context-sensitive help for
	finding information to describe the particular function you are working with.
	</p>

	<p>
	You can interact with help system in the workbench using the <strong>Help
	view</strong> or in the separate <strong>Help window</strong>. The view and
	window provide the same information but in different ways.
	</p>

	<h2>The Help view</h2>

	<p>
	The Help view provides help inside the workbench. You can open the view from
	the main menu by selecting <b>Help > Dynamic Help</b> or <b>Help >
	Search</b>. The view will open showing the Related Topics or Search page,
	respectively. You can use links at the top of the help view to turn to other
	pages.
	</p>

	<p>
	You can <a href="help_view.htm">read more</a> about the Help view and its
	various pages.
	</p>

	<p>
	<img src="../images/help_view_context.png"
	alt="Help view showing Related Topics page">
	</p>

	<h2>The Help window</h2>

	<p>
	The Help window provides the same content as the Help view, but in a
	<em>separate</em> window instead of in a view. You can open the window from the
	main menu by selecting <b>Help > Help Contents</b>. The first view shown in
	the window is called Contents. This view displays the table of contents for the
	product documentation. Click on one of the links to expand the navigation tree
	for a set of documentation.
	</p>

	<p>
	<img src="../images/help_window.png" alt="Help window">
	</p>

	<p>
	Note that if your browser does not have JavaScript enabled or is an does not support the features
	required to display the normal help application "basic" help which will be displayed - this can
	easily be identified because closed
	books in the table of contents do not have an expander icon. You can find the user agent of your
	browser <a href="../../../about.html?show=agent">here.</a>
	</p>

	<h2>Context-sensitive help</h2>

	<p>
	If you are working through a task and encounter a part of the interface that
	you do not understand, you can summon context-sensitive help. By default, this
	will display the Help view and give you some specific information about the
	view/editor/dialog you are using, and possibly some links to topics for further
	help.
	</p>

	<p>
	Context-sensitive help can be accessed by bringing focus to the interface part
	in question by clicking on it or using the Tab key, and then pressing
	<code>F1</code> (<code>Shift+F1</code> on GTK+, and <code>Help</code> on the
	Mac). Alternatively, in dialogs you can achieve the same result by pressing
	the <img src="../images/help.svg" alt="Help button"> help button in the
	dialog's button bar.
	</p>

	<h3>Infopops</h3>

	<p>
	An alternative way of presenting context-sensitive information is using
	<b>infopops</b>. You can use the

	<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.help.ui.browsersPreferencePage)")'>
	<img src="PLUGINS_ROOT/org.eclipse.help/command_link.svg" alt="command link">
	<b>Help</b></a> preference page to configure Help to use infopops instead of the Help view for displaying
	context-sensitive help.
	</p>

	<p>
	<img src="../images/help_infopop.png" alt="Help infopop" border="0">
	</p>

	<h3 class="related">Related concepts</h3>
	<a href="help_view.htm">Help view</a><br>

	<h3 class="related">Related tasks</h3>
	<a href="../tasks/help.xhtml">Accessing help</a><br>
	<a href="../tasks/help_navigate.htm">Navigating help topics</a><br>
	<a href="../tasks/help_context.htm">Accessing context-sensitive help</a><br>
	<a href="../tasks/help_search.htm">Searching help</a>

	<h3 class="related">Related reference</h3>
	<a href="../reference/help_preferences.htm">Help preferences</a>

	</body>
	</html>