Předem sestavený rejstřík dokumentace

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.

Sestavení rejstříku dokumentace pro modul plug-in.

Při sestavení rejstříku postupujte takto:

Sestavení rejstříku produktu

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:

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.

Zabalení a instalace předem sestaveného rejstříku produktu

Předem sestavené rejstříky, tj. soubory doc_index.zip, je zapotřebí zabalit v podobě modulu plug-in.   Můžete použít modul plug-in přiřazený k primární funkci nebo rejstříky pro jednotlivé jazyky zabalit do samostatných fragmentů.

Pokud je dokumentace produktu k dispozici například ve třech jazycích, v angličtině, němčině a zjednodušené čínštině, může mít modul plug-in com.my.plugin tuto strukturu:
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

ID modulu plug-in je třeba zadat jako předvolbu productIndex pro modul plug-in org.eclipse.help.base. Ve výše uvedeném příkladu modulu plug-in musí položku obsahovat soubor plugin_customization.ini.
org.eclipse.help.base/productIndex=com.my.plugin