Help view

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.

Related Topics

Picture of Help view turned to related topics page. List of topics related to some workbench part is displayed.

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.

All Topics

Picture of Help view turned to all topics page. Page contains a navigation tree of all help topics.

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.

Search

Picture of Help view turned to search page. Search exprssion entry field, and search results topic list.

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.

Bookmarks

Picture of Help view turned to the bookmarks page. Page contains a bookmark to one of the topics.

The Bookmarks shows topics marked as personal bookmarks.

Toolbar

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

Back
Displays the page or the topic that was displayed immediately prior to the current display.
Forward
Displays the page or the topic was displayed immediately after the current display.
Collapse All
Collapses the tree expansion state of all topics on the page.
Show All Topics
When filtering of workbench elements is enabled, the buttons enables displaying topics for disabled elements.
Show Result Categories
Switches between sorting search results by relevance and by logical containers for example books.
Show Result Descriptions
Displays short description of each search hit, when available.
Menu
Provides menu items that allow you switching help view pages.

Icons

The following icons can appear in the Navigator view.

Icon

Description

Open project icon Book (closed)
Folder icon Book (closed)
File icon Topic (container)
File icon Topic
File icon Search of local help
File icon Search of remote info-center
File icon Search of web engine
File icon Open link in a help window
File icon Bookmark document
File icon Bookmarked document

Related concepts
Views

Related tasks
Opening views
Moving and docking views
Creating fast views

Related reference
Help window