Als de gebruiker de inhoudsopgave Help doorzoekt, wordt de zoekopdracht uitgevoerd binnen een documentatie-index. Standaard wordt deze index bij de eerste oproep van een Helpzoekopdracht gemaakt, maar de index kan ook vooraf worden gegenereerd en bij elke plugin vanaf versie 3.1 of als volledige index bij het product worden geleverd aan de gebruiker. Dit voorkomt dat het indexeren plaatsvindt op de computer van de gebruiker en zorgt ervoor dat de gebruiker de zoekresultaten van de eerste zoekopdracht eerder ontvangt.
Voor het genereren van een index gaat u als volgt te werk:
index
element toe aan de extensie org.eclipse.help.toc
in een documentatieplugin, om de directory op te geven waar de index zal worden geplaatst. help.buildHelpIndex
voor elke plugin en elk fragment met documentatie uit te voeren. De index per product is een samengevoegde index van alle documentatie in het product. Deze kan worden gebruikt voor scenario's waarin de verzameling documentatieplugins niet meer wordt gewijzigd. Voor bijvoorbeeld een Informatiecentruminstallatie is het handig een index per product te gebruiken.
Voor het genereren van een index gaat u als volgt te werk:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localevanaf de directory die het product bevat. De volgende argumenten moeten worden ingesteld:
Bijvoorbeeld het uitvoeren van
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
heeft tot gevolg dat het bestand doc_index.zip wordt opgeslagen in de directory nl/en die wordt gemaakt onder d:/build/com.my.plugin. Het ZIP-bestand bevat een index met de inhoud van documenten die beschikbaar zijn voor gebruikers als zij het product in de locale en verwerken.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
andere bestanden van deze plugin
org.eclipse.help.base/productIndex=com.my.plugin