Preindeksere dokumentasjon

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.

Vygge en dokumentasjonsindeks for en plugin-modul

Slik bygger du en indeks:

Bygge en indeks for et produkt

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:

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.

Pakke og installere produktets forhåndsbygde indeks

De forhåndsdefinerte indeksene, doc_index.zip-filene, må pakkes som en plugin-modul.  Du kan velge å bruke en plugin-modul som er knyttet til den primære funksjonen, eller velge å pakke indeksen for hvert språk i separate fragmenter.

Hvis produktets dokumentasjon er tilgjengelig på tre språk, for eksempel engelsk, tysk og forenklet kinesisk, kan plugin-modulen com.my.plugin ha følgende struktur:
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

Iden for plugin-modulene må oppgis som productIndex-preferanser for plugin-modulen org.eclipse.help.base. For plugin-moduler i eksempelet over må filen plugin_customization.ini inneholde oppføringen
org.eclipse.help.base/productIndex=com.my.plugin