Documentatie vooraf indexeren

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.

Een documentatie-index voor een plugin genereren

Voor het genereren van een index gaat u als volgt te werk:

Een index voor een product genereren

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:

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.

Een vooraf gegenereerde index van een product inpakken en installeren

Vooraf gegenereerde indexen, de doc_index.zip-bestanden, moeten als plugin worden ingepakt. U kunt ervoor kiezen een plugin te gebruiken die bij de primaire feature hoort of u kunt ervoor kiezen de index voor iedere taal in afzonderlijke fragmenten in te pakken.

Als de documentatie van een product bijvoorbeeld in de drie talen, Engels, Duits en Vereenvoudigd Chinees beschikbaar is, kan de plugin com.my.plugin de volgende structuur hebben:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
andere bestanden van deze plugin

Het ID van de plugin moet worden opgegeven als een productIndex-voorkeur voor de plugin org.eclipse.help.base.  Voor de plugin van het bovenstaande voorbeeld, moet het bestand plugin_customization.ini het volgende item bevatten
org.eclipse.help.base/productIndex=com.my.plugin