Prohledává-li uživatel obsah nápovědy produktu, probíhá vyhledávání v rejstříku dokumentace. Ve výchozím nastavení se tento rejstřík vytváří při prvním volání hledání v nápovědě, ale lze jej sestavit předem a dodat jej uživateli s každým modulem plug-in (od verze 3.1) nebo jako kompletní rejstřík pro celý produkt. Zamezíte tak indexaci na stroji uživatele a uživatel obdrží výsledky prvního hledání rychleji.
Při sestavení rejstříku postupujte takto:
index
do org.eclipse.help.toc
extension
v modulu plug-in dokumentace a určete tak adresář, kde se bude rejstřík nacházet,
help.buildHelpIndex
pro každý modul plug-in a fragment s dokumentací.
Rejstřík celého produktu představuje jeden agregátní rejstřík veškeré dokumentace v rámci produktu. Měl by se používat v situaci, kdy se sada modulů plug-in dokumentace nemění. Jeden rejstřík celého produktu může být výhodný například při instalaci modulu InfoCenter.
Při sestavení rejstříku postupujte takto:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localev adresáři produktu. Je zapotřebí nastavit tyto argumenty:
Například spuštění
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
uloží se soubor doc_index.zip do adresáře nl/en, který bude vytvořen v adresáři d:/build/com.my.plugin. Soubor .zip bude obsahovat rejstřík obsahu dokumentů, které jsou k dispozici uživatelům, pokud spustí produkt v národním prostředí en.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
jiné soubory tohoto modulu plug-in
org.eclipse.help.base/productIndex=com.my.plugin