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 a product. This avoids indexing from occurring on
the user machine and lets user obtain first search results faster.
To build an index follow the steps:
eclipse -nosplash -application org.eclipse.help.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localefrom the directory containing the product. The following arguments need to be set :
For example, running
eclipse -nosplash -application org.eclipse.help.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
will result in file doc_index.zip being saved in the nl/en
directory that will be created under d:/build/com.my.plugin. The
zip will contain index of contents of documents that are available to users
when they run the product in the en locale.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
other files of this plugin
org.eclipse.help/productIndex=com.my.plugin