Wstępne budowanie indeksu dokumentacji

Gdy użytkownik przeszukuje treść pomocy produktu, wyszukiwanie jest prowadzone w ramach indeksu dokumentacji. Domyślnie indeks ten jest tworzony przy pierwszym wywołaniu funkcji wyszukiwania w systemie pomocy, ale można go utworzyć już wcześniej i dostarczyć użytkownikom razem z każdym modułem dodatkowym lub, począwszy od wersji 3.1, jako pełny indeks dla produktu. Pozwala to uniknąć indeksowania na komputerze użytkownika i szybciej wyświetlić wyniki pierwszego wyszukiwania.

Budowanie indeksu dokumentacji dla modułu dodatkowego

Aby zbudować indeks, wykonaj poniższe kroki:

Budowanie indeksu dla produktu

Indeks dla produktu to pojedynczy, zbiorczy indeks dla całej dokumentacji w produkcie. Należy używać go w scenariuszach, w których zbiór modułów dodatkowych dokumentacji nie zmienia się. Z indeksu dla produktu skorzysta na przykład instalacja Centrum informacyjnego.

Aby zbudować indeks, wykonaj poniższe kroki:

Na przykład komenda

eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en

spowoduje zapisanie pliku doc_index.zip w katalogu nl/en, który zostanie utworzony w katalogu d:/build/com.my.plugin. Plik ZIP będzie zawierał indeks treści dokumentów, które są dostępne dla użytkowników uruchamiających produkt z użyciem ustawień narodowych en.

Pakowanie i instalacja wstępnie zbudowanego indeksu dla produktu

Wstępnie zbudowane indeksy (pliki doc_index.zip) należy pakować jako moduł dodatkowy. Można użyć modułu dodatkowego powiązanego ze składnikiem podstawowym lub spakować indeksy dla poszczególnych języków w oddzielnych fragmentach.

Jeśli na przykład dokumentacja produktu jest dostępna w trzech językach (angielskim, niemieckim i chińskim uproszczonym), moduł dodatkowy com.my.plugin może mieć następującą strukturę:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
inne pliki tego modułu dodatkowego

Identyfikator modułu dodatkowego należy określić jako wartość preferencji productIndex modułu dodatkowego org.eclipse.help.base. W przypadku modułu dodatkowego z powyższego przykładu wpis należy umieścić w pliku plugin_customization.ini tego modułu dodatkowego.
org.eclipse.help.base/productIndex=com.my.plugin