Når brukeren søker i innholdet i hjelpen for et produkt, blir søket utført i en dokumentasjonsindeks. Som standard blir denne indeksen opprettet første gang et søk i hjelpen aktiveres, men fra og med 3.1 kan den forhåndsbygges og leveres til brukeren sammen med hver plugin-modul, eller som en fullstendig indeks for et produkt. Dette forhindrer at det forekommer indeksering på brukermaskinen, og brukeren får søkeresultatene raskere.
Slik bygger du en indeks:
index
-element i utvidelsen org.eclipse.help.toc
i en plugin-modul for
dokumentasjon, der katalogen for indeksen oppgishelp.buildHelpIndex
for
hver plugin-modul og hvert fragment med dokumentasjon.En indeks per produkt er en generert indeks av all dokumentasjonen i produktet. Den skal brukes i scenarier der settet med plugin-moduler for dokumentasjon ikke endres. En informasjonssenterinstallering vil for eksempel ha nytte av en indeks per produkt.
Slik bygger du en indeks:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localefra katalogen som inneholder produktet. Du må definere disse argumentene:
Hvis du for eksempel kjører
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
vil filen doc_index.zip bli lagret i katalogen nl/en, som blir opprettet under
d:/build/com.my.plugin. Zip-filen vil inneholde en indeks for innholdet i dokumentene som er
tilgjengelige for brukerne når de kjører produktet i språkmiljøet en.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
andre filer i denne plugin-modulen
org.eclipse.help.base/productIndex=com.my.plugin