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. In the Search field at the top of the Help browser, type the term or terms for which you want to search.
2. Click Go or press Enter. The result set will be shown in the Search Results view of the Help browser.
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 the documentation from inside the Workbench by selecting Search > Search..., and then Help Search tab. Type in search terms, optionally select the books you want to search, and click Search. The results will be shown in the Search view. Double-click a result to open the help browser to that topic.

Remember the following search expression rules:

• Unless otherwise stated, there is an implied AND between all search terms. In other words, topics that contain all the search terms will be returned. For example:

  Java project

  returns topics that contain the word Java and the word project, but does not return topics that contain only one of these words.

• Use OR before optional terms . For example:

  applet OR application

  returns topics that contain the word applet or the word application (or both).

• Use NOT before terms you want to exclude from search results. For example:

  servlet NOT ejb

  returns topics that contain the word servlet and do not contain the word ejb. Note: NOT only works as a binary operator (that is, "NOT servlet" is not a valid expression).

• Use ? for a single-character wildcard and * for a multi-character wildcard. For example:

  par?

  returns topics that contain part or park, but not participate. On the other hand:

  par*

  returns topics that contain part, park, participate, pardon, and so on. Note: The search engine does not accept terms with a wild card at first character position.

• Use double quotation marks around terms you want treated as a phrase. For example:

  "creating projects"

  returns topics that contain the entire phrase creating projects, and not creating or project on its own.

• Punctuation acts as term delimiters. For example:

  plugin.xml

  returns hits on topics that contain plugin.xml, plugin, and xml, which is likely broader than you want. If you want to find just those topics containing plugin.xml, use double quotes, as in:

  "plugin.xml"

• The search engine ignores character case. For example:

  Workbench

  returns topics that contain 'workbench', 'Workbench', 'WorkBench', and 'WORKBENCH'.

• The following stop words are common English words which will be ignored (not searched for) if they appear in the search expression: a, and, are, as, at, be, but, by, in, into, is, it, no, not, of, on, or, s, such, t, that, the, their, then, there, these, they, to, was, will, with.
• The search engine does "fuzzy" searches and word stemming. If you enter create, it will return hits on topics that contain creates, creating, creator, and so on. To prevent search engine from stemming terms, enclose them in double quotes.

 

Refining the search results

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.
2. Click New button to define a new search scope.
3. In the window that opened, select the topics to which you want to narrow the search.
4. Give the selected list a name and click OK.
5. Click OK, to activate the new search scope.
6. Click Go again. The results will be shown in the Search Results view in the Help browser.

 

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. 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.

Accessing and navigating online help