bundles/org.eclipse.platform.doc.user/concepts/help_view.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, 2011. 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 view</title>
 </head>
 <body>

 <h1>Help view</h1>

 <p>
 The Help view provides user assistance inside the workbench. The view consists
 of several pages. Each page presents help in a different fashion. Hyper links at
 the bottom of the help view allow switching among pages, and clicking any topic
 will display its contents.
 </p>

 <h2>Related Topics</h2>

 <p>
 <img src="../images/help_view_context.png" alt="Related Topics">
 </p>

 <p>
 The <strong>Related Topics</strong> page shows description and help topics
 related to the current workbench context. The <b>About</b> section shows context
 help specific to your current context, and the <b>Search</b> link allows you to search
 for more results based on the name of the view or dialog that has focus.
 The Related Topics page tracks changes in the workbench and
 continuously updates displayed information.
 </p>

 <h2>Contents</h2>

 <p>
 <img src="../images/help_view_toc.png" alt="All Topics">
 </p>

 <p>
 The <strong>Contents</strong> page shows the table of contents. It is a
 hierarchy of all help topics arranged in a tree. The tree branches can be
 expanded to browse topics that can be displayed using a single mouse click.
 </p>

 <h2>Search</h2>

 <p>
 <img src="../images/help_view_search.png" alt="Search">
 </p>

 <p>
 The <strong>Search</strong> page allows locating local topics, cheat sheets,
 welcome content, remote documents, and other documents given a search query.
 Links to search hits are displayed along with a summary of topic contents.
 Search scope controls a subset of documentation being searched. Multiple search
 scopes can be configured, each defining a custom set of resources from among
 local documentation, additional local search engines or remote engines on the
 web.
 </p>

 <h2>Index</h2>

 <p>
 <img src="../images/help_view_index.png" alt="Index">
 </p>

 <p>
 The <strong>Index</strong> page provides an index of keywords that direct the
 user to specific help topics, similar to indexes found at the back of a book. As
 you type in the text field, the best match will automatically be highlighted in
 the list of keywords. Pressing enter or clicking on a keyword will display the
 given topic.
 </p>

 <p>
 <i>Note: The index page will only appear when index content is available in
 the workbench.</i>
 </p>

 <h2>Bookmarks</h2>

 <p>
 <img src="../images/help_view_bookmarks.png" alt="Bookmarks">
 </p>

 <p>
 The <strong>Bookmarks</strong> shows topics marked as personal bookmarks.
 </p>

 <h2>Toolbar</h2>

 <p>The toolbar of the Help view contains the following buttons. The
 available buttons depends on the currently displayed page.</p>

 <dl>
 <dt>Back</dt>

 <dd>Displays the page or the topic that was displayed immediately
 prior to the current display.</dd>

 <dt>Forward</dt>

 <dd>Displays the page or the topic was displayed immediately after
 the current display.</dd>

 <dt>Collapse All</dt>

 <dd>Collapses the tree expansion state of all topics on the
 page.</dd>

 <dt>Show All Topics</dt>

 <dd>When filtering of workbench elements is enabled, the buttons
 enables displaying topics for disabled elements.</dd>

 <dt>Show Result Categories</dt>

 <dd>Switches between sorting search results by relevance and by
 logical containers for example books.</dd>

 <dt>Show Result Descriptions</dt>

 <dd>Displays short description of each search hit, when
 available.</dd>

 <dt>Menu</dt>

 <dd>Provides menu items that allow you switching help view
 pages.</dd>
 </dl>

 <h2>Icons</h2>

 <p>
 The following icons can appear in the various pages of the Help view.
 </p>

 <table border="1" cellspacing="0">
 <thead>
 <tr>
 <th rowspan="1" colspan="1">
 <p class="Para">Icon</p>
 </th>
 <th rowspan="1" colspan="1">
 <p class="Para">Description</p>
 </th>
 </tr>
 </thead>

 <tbody>
 <tr>
 <td rowspan="1" colspan="1" valign="top" align="left"><img src=
 "../images/toc_closed.svg" alt="Open project icon" border="0"></td>
 <td rowspan="1" colspan="1" valign="top" align="left">Book
 (closed)</td>
 </tr>

 <tr>
 <td rowspan="1" colspan="1" valign="top" align="left"><img src=
 "../images/toc_open.svg" alt="Folder icon" border="0"></td>
 <td rowspan="1" colspan="1" valign="top" align="left">Book
 (open)</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/toc_topic_obj.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Topic (container)</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/topic_small.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Topic</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/slocalhelp_obj.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Search of local help</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/help_search.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Search of remote
 info-center</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/sweb_obj.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Search of web engine</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/highlight.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Highlight search terms</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/openseparate_co.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Open link in a help
 window</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/addbkmrk_co.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Bookmark document</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/bookmark_obj.svg" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Bookmarked document</td>
 </tr>
 </tbody>
 </table>

 <h3 class="related">Related concepts</h3>
 <a href="help.htm">Help</a>

 <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>
 <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, 2011. 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 view</title>
	</head>
	<body>

	<h1>Help view</h1>

	<p>
	The Help view provides user assistance inside the workbench. The view consists
	of several pages. Each page presents help in a different fashion. Hyper links at
	the bottom of the help view allow switching among pages, and clicking any topic
	will display its contents.
	</p>

	<h2>Related Topics</h2>

	<p>
	<img src="../images/help_view_context.png" alt="Related Topics">
	</p>

	<p>
	The <strong>Related Topics</strong> page shows description and help topics
	related to the current workbench context. The <b>About</b> section shows context
	help specific to your current context, and the <b>Search</b> link allows you to search
	for more results based on the name of the view or dialog that has focus.
	The Related Topics page tracks changes in the workbench and
	continuously updates displayed information.
	</p>

	<h2>Contents</h2>

	<p>
	<img src="../images/help_view_toc.png" alt="All Topics">
	</p>

	<p>
	The <strong>Contents</strong> page shows the table of contents. It is a
	hierarchy of all help topics arranged in a tree. The tree branches can be
	expanded to browse topics that can be displayed using a single mouse click.
	</p>

	<h2>Search</h2>

	<p>
	<img src="../images/help_view_search.png" alt="Search">
	</p>

	<p>
	The <strong>Search</strong> page allows locating local topics, cheat sheets,
	welcome content, remote documents, and other documents given a search query.
	Links to search hits are displayed along with a summary of topic contents.
	Search scope controls a subset of documentation being searched. Multiple search
	scopes can be configured, each defining a custom set of resources from among
	local documentation, additional local search engines or remote engines on the
	web.
	</p>

	<h2>Index</h2>

	<p>
	<img src="../images/help_view_index.png" alt="Index">
	</p>

	<p>
	The <strong>Index</strong> page provides an index of keywords that direct the
	user to specific help topics, similar to indexes found at the back of a book. As
	you type in the text field, the best match will automatically be highlighted in
	the list of keywords. Pressing enter or clicking on a keyword will display the
	given topic.
	</p>

	<p>
	<i>Note: The index page will only appear when index content is available in
	the workbench.</i>
	</p>

	<h2>Bookmarks</h2>

	<p>
	<img src="../images/help_view_bookmarks.png" alt="Bookmarks">
	</p>

	<p>
	The <strong>Bookmarks</strong> shows topics marked as personal bookmarks.
	</p>

	<h2>Toolbar</h2>

	<p>The toolbar of the Help view contains the following buttons. The
	available buttons depends on the currently displayed page.</p>

	<dl>
	<dt>Back</dt>

	<dd>Displays the page or the topic that was displayed immediately
	prior to the current display.</dd>

	<dt>Forward</dt>

	<dd>Displays the page or the topic was displayed immediately after
	the current display.</dd>

	<dt>Collapse All</dt>

	<dd>Collapses the tree expansion state of all topics on the
	page.</dd>

	<dt>Show All Topics</dt>

	<dd>When filtering of workbench elements is enabled, the buttons
	enables displaying topics for disabled elements.</dd>

	<dt>Show Result Categories</dt>

	<dd>Switches between sorting search results by relevance and by
	logical containers for example books.</dd>

	<dt>Show Result Descriptions</dt>

	<dd>Displays short description of each search hit, when
	available.</dd>

	<dt>Menu</dt>

	<dd>Provides menu items that allow you switching help view
	pages.</dd>
	</dl>

	<h2>Icons</h2>

	<p>
	The following icons can appear in the various pages of the Help view.
	</p>

	<table border="1" cellspacing="0">
	<thead>
	<tr>
	<th rowspan="1" colspan="1">
	<p class="Para">Icon</p>
	</th>
	<th rowspan="1" colspan="1">
	<p class="Para">Description</p>
	</th>
	</tr>
	</thead>

	<tbody>
	<tr>
	<td rowspan="1" colspan="1" valign="top" align="left"><img src=
	"../images/toc_closed.svg" alt="Open project icon" border="0"></td>
	<td rowspan="1" colspan="1" valign="top" align="left">Book
	(closed)</td>
	</tr>

	<tr>
	<td rowspan="1" colspan="1" valign="top" align="left"><img src=
	"../images/toc_open.svg" alt="Folder icon" border="0"></td>
	<td rowspan="1" colspan="1" valign="top" align="left">Book
	(open)</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/toc_topic_obj.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Topic (container)</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/topic_small.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Topic</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/slocalhelp_obj.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Search of local help</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/help_search.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Search of remote
	info-center</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/sweb_obj.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Search of web engine</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/highlight.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Highlight search terms</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/openseparate_co.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Open link in a help
	window</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/addbkmrk_co.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Bookmark document</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/bookmark_obj.svg" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Bookmarked document</td>
	</tr>
	</tbody>
	</table>

	<h3 class="related">Related concepts</h3>
	<a href="help.htm">Help</a>

	<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>
	<h3 class="related">Related reference</h3>
	<a href="../reference/help_preferences.htm">Help preferences</a>

	</body>
	</html>