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.
Aby zbudować indeks, wykonaj poniższe kroki:
index
do rozszerzenia org.eclipse.help.toc
w module dodatkowym dokumentacji, aby określić katalog, w którym powstanie indeks.help.buildHelpIndex
dla każdego modułu dodatkowego i fragmentu z dokumentacją.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:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=katalog_wynikowy -DindexLocale=ustawienia_narodowew katalogu zawierającym produkt. Należy przy tym określić następujące argumenty:
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.
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
org.eclipse.help.base/productIndex=com.my.plugin