Index de documentation prédéfini

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 l'aide. Il peut s'agir d'un index prédéfini et fourni à l'utilisateur avec chaque plug-in, depuis la version 3.1, ou bien d'un index complet pour un produit.  De cette façon, l'indexation ne se fait pas sur la machine de l'utilisateur et celui-ci obtient ses premiers résultats plus rapidement.

Construction d'un index pour un plug-in.

Pour construire un index, procédez comme suit :

Construction d'un index pour un produit

Un index de produit est un index global de toute la documentation relative à ce produit. Il doit être utilisé dans des scénarios dont le groupe de plug-ins de documentation n'est pas modifié. Par exemple, une installation de centre d'informations bénéficiera d'un index de produit.

Pour construire un index, procédez comme suit :

Par exemple, l'exécution de

eclipse -nosplash -application org.eclipse.help.base.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édéfini du produit

Les indices prédéfinis, 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 trois langues (anglais, allemand et chinois simplifié), la structure d'un plug-in com.my.plugin peut être :
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
autres fichiers de ce plug-in

L'ID du plug-in doit être indiqué comme d'option productIndex pour le plug-in org.eclipse.help.base. Pour le plug-in de l'exemple précédent, le fichier plugin_customization.ini doit contenir l'entrée suivante :
org.eclipse.help.base/productIndex=com.my.plugin