Index de documentation préconstruit

Lorsque l'utilisateur effectue une recherche dans l'aide d'un produit, la recherche s'exécute dans un index de documentation.  Par défaut, cet index  est créé lors du premier appel de la recherche de l'aide, mais il peut être préconstruit et fourni à l'utilisateur en même temps qu'un produit.  Cela évite que l'indexation se produise sur la machine utilisateur et permet à l'utilisateur d'obtenir les résultats de sa première recherche plus rapidement.

Construction d'un index pour un produit

Pour construire un index, procédez comme suit :

Par exemple, l'exécution de

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

entraîne l'enregistrement du fichier doc_index.zip en cours de sauvegarde dans le répertoire nl/en qui sera créé sous d:/build/com.my.plugin.  Le zip contiendra l'index du sommaire des documents qui sont disponibles pour les utilisateurs lorsqu'ils exécutent le produit dans l'environnement local en.

Mise en forme et installation de l'index préconstruit

Les indices préconstruits, les fichiers doc_index.zip, doivent être mis en forme en tant que plug-in.   Vous pouvez choisir d'utiliser un plug-in associé au dispositif principal ou de mettre en forme l'index pour chaque langue dans des fragments séparés.

Par exemple, si la documentation du produit est disponible en deux langues, par exemple en anglais et en allemand, un plug-in com.my.plugin peut avoir la structure suivante :
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
autres fichiers de ce plug-in

L'ID du plug-in doit être spécifié en tant que préférence productIndex pour le plug-in org.eclipse.help.  Pour le plug-in de l'exemple précédent, le fichier plugin_customization.ini doit contenir l'entrée
org.eclipse.help/productIndex=com.my.plugin


Copyright IBM Corporation and others 2000, 2003.