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.
Gør følgende for at bygge et stikordsregister:
stikordsregister
element til org.eclipse.help.toc-udvidelsen
i en dokumentations-plugin for at angive et bibliotek, hvor stikordsregistret skal placeres.
help.buildHelpIndex
for hver plugin og hvert fragment med dokumentation.
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:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputbibliotek -DindexLocale=sprogfra det bibliotek, der indeholder produktet. Følgende parametre skal angives:
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).
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
da/
CN/
doc_index.zip
andre filer i denne plugin
org.eclipse.help.base/productIndex=com.my.plugin