Forhåndsindeksering af dokumentation

Når en bruger søger i hjælpen til et produkt, sker søgningen i stikordene til dokumentationen.  Som standard bliver stikordsregisteret oprettet ved den første søgning i hjælpen, men stikordsregisteret kan bygges på forhånd og leveres til brugeren med alle plugins (siden version 3.1) eller som et fuldstændigt stikordsregister til et produkt. Dermed undgås, at indekseringen sker på brugerens maskine, og den første søgning kan udføres hurtigere.

Byg et stikordsregister til ddokumentation til en plugin.

Gør følgende for at bygge et stikordsregister:

Byg et stikordsregister til et produkt

Et stikordsregister pr. produkt er et samlet stikordsregister for al dokumentation i produktet. Det skal anvendes til eksempler, hvor dokumentations-plugins ikke ændres. En Infocenterinstallation kan udnytte stikordsregisteret pr. produkt.

Gør følgende for at bygge et stikordsregister:

Hvis du f.eks. udfører kommandoen

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

bliver filen doc_index.zip gemt i biblioteket nl/da, som oprettes under d:/build/com.my.plugin. Zip-filen indeholder stikordsregisteret med indholdet af de dokumenter, der er tilgængelige for brugere, når de udfører programmet på dansk (parameteren da).

Pakning og installation af produktets forhåndsbyggede stikordsregister

Stikordsregistre, der er bygget på forhånd, dvs. filerne doc_index.zip, skal pakkes som plugins. Du kan vælge at bruge en plugin, der er knyttet til den primære funktion, eller vælge at pakke stikordsregisteret til hvert sprog i separate fragmenter.

Hvis f.eks. dokumentationen til et produkt findes på tre sprog, f.eks. engelsk, tysk og dansk, kan plugin'en com.my.plugin have følgende struktur:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
da/
CN/
doc_index.zip
andre filer i denne plugin

Id'en til plugin'en skal angives som en productIndex indstilling til plugin'en org.eclipse.help.base. Til plugin'en i ovenstående eksempel skal filen plugin_customization.ini indeholde indgangen
org.eclipse.help.base/productIndex=com.my.plugin