Searching online help

The help system includes a powerful text search engine that runs simple or complex queries on the documentation to help you find the information you are looking for.

To search the online help:

  1. Select Help > Search. type the term or terms for which you want to search.
  2. Click Go or press Enter. The result set will be shown below.
  3. To view the content of a topic in the result set, select it. Hits within the selected topic are highlighted.

Tip: You can also search local documentation from inside help browser by typing the term in the search field of the toolbar. The results will be shown in the Search view. Click a result to open the topic in the contents area.

Refining the search results in the help view

If the result set is very large, the information you are looking for might not appear in the top 10 or 15 results. You can then refine the search to reduce the number of results.

To refine a search:

  1. Click the Search Scope link. to expand search scope section.
  2. Click the Advanced Settings link. Search Scope preference dialog opens.
  3. Click Local Help from the list.
  4. Select Search only the following topics button to narrow down the search scope.
  5. In the working set content tree, select the topics to which you want to narrow the search.
  6. Click OK, to activate the changes and return to search page in the help view.
  7. Click Go again. The results will be shown in the Search Results view in the Help browser.

Extending the search scope

If you cannot locate information in the local help, you can extend search scope to remote info-center or search engines.

To enable search engines:

  1. Click the Search Scope link. to expand search scope section. The list of search engine is displayed.
  2. Select the ones that contain information you are looking for.

In addition to search engines provided, you may define additional search engines.

To define a new search engine:

  1. Click the Search Scope link. to expand search scope section.
  2. Click the Advanced Settings link. Search Scope preference dialog opens.
  3. Click New.
  4. Select the search engine type.
  5. Click OK.
  6. Provide a name and a description
  7. Select engine specific settings and scope below. For the remote search engines, accessed using URL, fill in a full URL to query the engine. Use {expression} in the place of search expression.

Defining multiple search scopes

By default, changing search scope modifies the search scope named "default". You can define multiple search scope. They will be saved, allowing to quickly change search scope to one of them.

To define a new search scope:

  1. Click the current search scope name, beside the Search Scope link. .Search Scope Sets dialog appears.
  2. Click New.
  3. Type a name, and confirm.
  4. Select the newly created search scope.
  5. Click OK. The new search scope becomes current.

Changes to the search scope affect current search scope.

Local search query syntax

Remember the following search expression rules:

Search index generation

The first time you search the online help, the help system might initiate an index-generation process. This process builds the indexes for the search engine to use. It may take several minutes, depending on the amount of documentation and whether prebuilt indexes are installed. Results of the search will be available upon completion of the indexing process.

Each time you add or modify the documentation set (for example, when you install a new feature or update an existing one), the index will be updated to reflect the new information set.

Related tasks
Accessing and navigating online help