Navigating and searching online help

You can use the search and navigation features to find information that explains how to work with your product.

Navigating

You can perform the following navigation tasks:

Expanding and collapsing the Table of Contents

You can control how many levels of topics are displayed in the Table of Contents.

To expand and collapse the Table of Contents:

  • Do one of the following:

    • Click a Show TOC level button to change the level of topics that are displayed in the Table of Contents.

    • On the left side of the navigation pane, click to open the Table of Contents – Tools menu and then choose the appropriate level.

Creating a bookmark

You can create bookmarks to identify topics that you want to review.

To create a bookmark:

  • Click the bookmark icon to the left of a topic title. A yellow bookmark icon indicates bookmarked topics.

Viewing all bookmarks

You can filter the Table of Contents to show only the topics you have bookmarked.

To view all bookmarks:

  • On the top left side of the navigation pane, click to open the Table of Contents - Tools menu, and then choose Show only bookmarks.

The list of bookmarks appears in the Table of Contents view.

Showing and hiding chapter and section numbers in the Table of Contents

You can show or hide the chapter numbers that are displayed in the Table of Contents.

To show or hide chapter and section numbers:

  • On the top left side of the navigation pane, click to open the Table of Contents - Tools menu and then choose Hide/Display section numbers.

Listing recently viewed topics

You can create a list of all of the topics that you have viewed during your current session. A yellow bar to the left of a topic indicates that you have viewed that topic during the current session. Dark yellow bars indicate the topics that you viewed most recently.

To list most recently viewed topics:

  • On the top left side of the navigation pane, click to open the Table of Contents - Tools menu and then choose Show previously viewed pages only.

The list of recently viewed topics appears in the Table of Contents view.

Searching

You can perform the following search tasks:

Performing a simple search

You can perform a basic search of a single document.

To perform a simple search:

  • Enter the search criteria in the search box and then press ENTER or click .

Specifying matching criteria

You can further refine your search by specifying how you want the search criteria to be matched. The results will be displayed in the Table of Contents view.

To specify matching criteria:

  1. On the top right side of the navigation pane, click to open the Search Options menu and then click one of the following:

    • Any of the words to return results that contain any of the words specified in the search criteria.

    • All words to return results that contain all of the words specified in the search criteria.

    • This exact phrase to return results that exactly match the search criteria.

  2. In the search box, enter the search criteria and then press ENTER or click .

Specifying where to search

Depending on your configuration, you may be able to perform a search across multiple documents or just a single document.

To specify where you want to search:

  1. On the top right side of the navigation pane, click to open the Search Options menu and then do one of the following:

    • Click All documentation modules to search all available documents.

    • Click Entire document to search the current document.

    • Click Current section and subsections to search the selected section and all of its subsections.

    • Click Current page only to search the currently displayed topic.

  2. In the search box, enter the search criteria and then press ENTER or click .

Setting display options for search results

You can specify how search results are presented in the result list.

To specify search result display options:

  • On the top right side of the navigation pane, click to open the Search Options menu and then click one of the following:

    • Sort by match count to display results starting with the closest matches.

    • Sort by main divisions to group the results by chapter first and then by closest match within each chapter.

    • Show in Table of Contents (TOC) to display the results in the Table of Contents view. In the Table of Contents, a green number to the left of the topic title indicates the match score. The darkest shades of green indicate the topics with the highest frequency of matches. There is also a summary of all matches at the top of the Table of Contents view.

Saving search settings

You can save the search settings that you specified for use in future sessions.

To save search settings:

  • On the top right side of the navigation pane, click to open the Search Options menu and then click Save settings for later sessions.

    The selections that you made in the Search Options menu are retained for future sessions.

Performing an on-the-fly search

The Show in TOC on-the-fly feature performs a search and dynamically displays the results while you are typing your search criteria. This feature is only available for single document searches and therefore is not available if you select All documentation modules.

To perform an on-the-fly search:

  1. On the top right side of the navigation pane, click to open the Search Options menu and then click Show in TOC on-the-fly.

  2. In the search box, enter your search criteria and then pause.

    The results will be displayed in the Table of Contents view.

Top of page