Instrument IconHelp View

The Help View provides you assistance inside the workbench. The view consists of several pages. Each page presents help in a different fashion. Hyperlinks at the bottom of the view allow switching among pages. Clicking any topic will display its contents.

Pages

The Help View contains the following pages:

Related Topics IconRelated Topics

The Related Topics Page shows descriptions and help topics related to the currently selected element (editor or view). The About Section shows context help specific to your current context, and the Dynamic Help Section shows some search results that may be related. This page tracks the changes in the workbench and continuously updates displayed information.

All Topics IconAll Topics

The All Topics Page shows the table of contents. It is a hierarchy of all help topics.

Search IconSearch

The Search Page allows browsing local topics and other documents given a search query. Links to the search results are displayed along with a summary of the topic contents. The search scope controls a subset of documentation being searched.

Bookmarks IconBookmarks

The Bookmarks Page shows topics marked as personal bookmarks.

Toolbar

The toolbar of the Help View contains the following actions. The available actions depend on the currently displayed page.

Back IconBack

Returns to the last page or topic you have viewed.

Forward IconForward

Once you have pressed the Back button, the Forward button moves you ahead through pages and topics you have already viewed prior to the current display.

Collapse All IconCollapse All

Collapses the expanded tree structure of all topics on the page.

Show All Topics IconShow All Topics

When the filtering of workbench elements is enabled, this action enables displaying topics for disabled elements.

Show in external window IconShow in external window

Display the currently selected topic in an external window.

Show in All Topics IconShow in All Topics

Shows the currently displayed topic in the table of contents hierarchy.

Bookmark document IconBookmark document

Bookmarks the currently displayed document.

Show Result Categories IconShow Result Categories

Switches between sorting search results by relevance and by logical containers (for example books).

Show Result Descriptions IconShow Result Descriptions

Displays a short description of each search hit, if available.

Menu

The menu of the Help View provides menu items that allow you switching Help View pages.

Icon Description
Book (closed)Icon Book (closed)
Book (open)Icon Book (open)
Topic (container) Icon Topic (container)
Topic Icon Topic
Search of local help Icon Search of local help
Search of remote help Icon Search of remote help
Search of web engine Icon Search of web engine
Bookmark Icon Bookmark

Related topics

Workbench → Preferences → Help