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

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html>
 <head>
 <meta name="copyright" content=
 "Copyright (c) IBM Corporation and others 2000, 2005. 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">
 <title>Help view</title>
 </head>

 <body bgcolor="#ffffff">
 <h1>Help view</h1>

 <p class="Intro">The Help view provides user assistance inside the
 Workbench. The view consists of four pages providing user
 assistance. Each page presents help topics in a slightly 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 class="Para"><img src="../images/helpview-related.png" alt=
 "Picture of Help view turned to related topics page. List of topics related to some workbench part is displayed."
  border="0"></p>

 <p class="Para">The Related Topics page shows description and help
 topics related to the current workbench context. The topics include
 context help, as well as the result of a local help search on the
 current context, presented in "Dynamic Help" section of the page.
 For example, if the currently active workbench part is 'Package
 Explorer' inside the Java perspective, local help will find and
 present topics describing "Package Explorer view" or "Java
 perspective". The Related Topics page tracks changes in the
 workbench and continuously updates displayed information.</p>

 <h2>All Topics</h2>

 <p class="Para"><img src="../images/helpview-all.png" alt=
 "Picture of Help view turned to all topics page. Page contains a navigation tree of all help topics."
  border="0"></p>

 <p class="Para">The All Topics 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 class="Para"><img src="../images/helpview-search.png" alt=
 "Picture of Help view turned to search page. Search exprssion entry field, and search results topic list."
  border="0"></p>

 <p class="Para">The Search page allows locating local topics,
 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>Bookmarks</h2>

 <p class="Para"><img src="../images/helpview-bookmarks.png" alt=
 "Picture of Help view turned to the bookmarks page. Page contains a bookmark to one of the topics."
  border="0"></p>

 <p class="Para">The Bookmarks 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 class="Para">The following icons can appear in 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.png" 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.png" alt="Folder icon" border="0"></td>
 <td rowspan="1" colspan="1" valign="top" align="left">Book
 (closed)</td>
 </tr>

 <tr>
 <td colspan="1" valign="top" align="left"><img src=
 "../images/container_obj.png" 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.png" 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.png" 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/sinfocenter_obj.png" 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.png" 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/openseparate_co.png" 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.png" 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.png" alt="File icon" border="0"></td>
 <td colspan="1" valign="top" align="left">Bookmarked document</td>
 </tr>
 </tbody>
 </table>

 <p><img border="0" src="../images/ngrelc.png" alt=
 "Related concepts"><br>
 <a href="concepts-5.htm">Views</a></p>

 <p><img border="0" src="../images/ngrelt.png" alt=
 "Related tasks"><br>
 <a href="../tasks/tasks-3.htm">Opening views</a><br>
 <a href="../tasks/tasks-3e.htm">Moving and docking views</a><br>
 <a href="../tasks/tasks-9b.htm">Creating fast views</a></p>

 <p><img border="0" src="../images/ngrelr.png" alt=
 "Related reference"><br>
 <a href="../reference/ref-34.htm">Help window</a></p>
 </body>
 </html>
	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html>
	<head>
	<meta name="copyright" content=
	"Copyright (c) IBM Corporation and others 2000, 2005. 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">
	<title>Help view</title>
	</head>

	<body bgcolor="#ffffff">
	<h1>Help view</h1>

	<p class="Intro">The Help view provides user assistance inside the
	Workbench. The view consists of four pages providing user
	assistance. Each page presents help topics in a slightly 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 class="Para"><img src="../images/helpview-related.png" alt=
	"Picture of Help view turned to related topics page. List of topics related to some workbench part is displayed."
	border="0"></p>

	<p class="Para">The Related Topics page shows description and help
	topics related to the current workbench context. The topics include
	context help, as well as the result of a local help search on the
	current context, presented in "Dynamic Help" section of the page.
	For example, if the currently active workbench part is 'Package
	Explorer' inside the Java perspective, local help will find and
	present topics describing "Package Explorer view" or "Java
	perspective". The Related Topics page tracks changes in the
	workbench and continuously updates displayed information.</p>

	<h2>All Topics</h2>

	<p class="Para"><img src="../images/helpview-all.png" alt=
	"Picture of Help view turned to all topics page. Page contains a navigation tree of all help topics."
	border="0"></p>

	<p class="Para">The All Topics 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 class="Para"><img src="../images/helpview-search.png" alt=
	"Picture of Help view turned to search page. Search exprssion entry field, and search results topic list."
	border="0"></p>

	<p class="Para">The Search page allows locating local topics,
	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>Bookmarks</h2>

	<p class="Para"><img src="../images/helpview-bookmarks.png" alt=
	"Picture of Help view turned to the bookmarks page. Page contains a bookmark to one of the topics."
	border="0"></p>

	<p class="Para">The Bookmarks 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 class="Para">The following icons can appear in 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.png" 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.png" alt="Folder icon" border="0"></td>
	<td rowspan="1" colspan="1" valign="top" align="left">Book
	(closed)</td>
	</tr>

	<tr>
	<td colspan="1" valign="top" align="left"><img src=
	"../images/container_obj.png" 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.png" 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.png" 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/sinfocenter_obj.png" 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.png" 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/openseparate_co.png" 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.png" 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.png" alt="File icon" border="0"></td>
	<td colspan="1" valign="top" align="left">Bookmarked document</td>
	</tr>
	</tbody>
	</table>

	<p><img border="0" src="../images/ngrelc.png" alt=
	"Related concepts"><br>
	<a href="concepts-5.htm">Views</a></p>

	<p><img border="0" src="../images/ngrelt.png" alt=
	"Related tasks"><br>
	<a href="../tasks/tasks-3.htm">Opening views</a><br>
	<a href="../tasks/tasks-3e.htm">Moving and docking views</a><br>
	<a href="../tasks/tasks-9b.htm">Creating fast views</a></p>

	<p><img border="0" src="../images/ngrelr.png" alt=
	"Related reference"><br>
	<a href="../reference/ref-34.htm">Help window</a></p>
	</body>
	</html>