The Help view provides user assistance inside the CICS Explorer® workbench. The view consists of several pages. Each page presents help in a different fashion. Hyperlinks in the help view allow switching between pages, and clicking any topic displays its contents.
The dynamic help view provides a framework
in which help information is displayed. The help displayed in the
view depends on the action performed, and is one of the following
types:
- Related Topics
- The Related Topics page shows a description and help topics relating
to the current workbench context. The About section shows context
help specific to your current context, and the Dynamic Help section
shows some search results that might be related. The search is performed
automatically using the selected view name as the search argument.
- All Topics
- The All Topics page shows the help table of contents. It is a
hierarchy of all help topics arranged in a tree. You can expand the
tree branches using a single mouse click to browse topics. You can
view the help contents in a new, larger window by placing your mouse
cursor anywhere in the view, right-clicking, and selecting Open
in Help Contents. A Help window is displayed containing the help
table of contents.
- Search
- The Search page shows the results from a search query. Links to
search hits are displayed with a summary of topic contents. Search
scope controls a subset of documentation being searched. You can configure
multiple search scopes, each defining a custom set of resources from
among local documentation, additional local search engines, or remote
engines on the Web.
- Bookmarks
- The Bookmarks help displays any topics you have bookmarked in
the CICS Explorer. Click
the bookmark to display the help for the topic.
- Index
- The Index page provides an index of keywords that direct you to
specific help topics, similar to indexes found at the back of a book.
As you type in the text field, the best match is highlighted in the
list of keywords. Pressing enter or clicking on a keyword displays
the given topic.
Toolbars
The Help view toolbar contains the following buttons. The available buttons depend on the currently displayed page. The name of the button is displayed when you hover over the button.
- Back
- Displays the page or the topic that was displayed immediately before to the current display.
- Forward
- Displays the page or the topic was displayed immediately after the current display. If no forward topics are available, the button is inactive.
- Collapse All
- Collapses the tree expansion for all topics on the page.
- Dynamic Link
- Dynamically links the help with the CICS® attribute selected in the Properties view or an editor view.
- Show All Topics
- When viewing a topic, clicking this button displays the All Topics tree, and highlights the position of this topic in the tree.
- 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 result, when available.
- View Menu
- Provides menu items so that you can switch help view pages.