Chapter 24. Full-text Search in Documentation

The installer of MeVisLab is shipped with index files of all available HTML pages, so that users can perform a full-text search in the documentation.

Index files for user-editable packages can be generated with the module IndexUserPackagesHTMLFiles. These files can be regenerated with that module as often as necessary, for example, after each update of the user's documentation.

Selecting Full-text Search In Documentation... or pressing CTRL+SHIFT+F opens a panel that provides a full-text search in MeVisLab's documentation and module help pages.

Figure 24.1. Full-text Search in Documentation Window

Full-text Search in Documentation Window

The full-text search supports boolean and compound search queries. If single words separated by SPACE are given, the search concatenates the words implicitly with AND. If multiple words are given enclosed in quotes, the search will look for the exact phrase. Boolean operators AND, OR, and NOT can be used, as well as brackets.

Compound and boolean operators can be mixed:

Clicking the cog icon opens a modal dialog where the suggestions feature and the maximum number of results can be adjusted.

The settings are saved per user when changed.

Figure 24.2. Full-text Search Settings

Full-text Search Settings

[Tip]Tip

When using a compound phrase, it is recommended to turn off suggestions.

If the query term is found, a number of results are displayed. Each result includes a score, a package group, a package, and a title. Click on any header to sort the list of results by that criterion.

Hovering over a result displays a tooltip with context.

Double-clicking a result opens a simple HTML browser with the corresponding HTML page. The search term is highlighted where possible on that page, and all previously folded sections are expanded.

Figure 24.3. Full-text Search Results Browser

Full-text Search Results Browser