Pre-indexing documentation

When user searches help contents of a product, the search is performed within a documentation index.  By default, this index  is created on the first invocation of help search, but can be pre-built and delivered to the user with each plug-in, since 3.1, or as a complete index for a product.  This prevents indexing from occurring on the user machine and lets the user obtain first search results faster.

Building a documentation index for a plug-in.

To build an index follow the steps:

Building an index for a product

Per-product index is a one aggregate index of all documentation in the product. It should be used in scenarios in which the set of documentation plug-ins is not changing. For example an info-center installation will benefit from per-product index.

To build an index follow the steps:

For example, running

eclipse -nosplash -application -vmargs -DindexOutput=d:/build/ -DindexLocale=en

will result in file being saved in the nl/en directory that will be created under d:/build/  The zip will contain index of contents of documents that are available to users when they run the product in the en locale.

Packaging and Installation of the product's pre-built index

Pre-built indices, the files, need to be packaged as a plug-in.   You can choose to use a plug-in associated with the primary feature, or choose to package the index for each language into separate fragments.

For example, if product's documentation is available in three languages, say English, German and Simplified Chinese, a plug-in can have the following structure:
other files of this plugin

The ID of the plug-in needs to be specified as a productIndex preference for plug-in. For plug-in in the above example, the plugin_customization.ini file needs to contain the entry