Preindexar la documentación

Cuando el usuario busca en el contenido de la ayuda de un producto, la búsqueda se realiza dentro de un índice de la documentación.  Por omisión, este índice  se crea en la primera invocación de la búsqueda de ayuda, pero puede preconstruirse y entregarse al usuario con cada plug-in, a partir de la versión 3.1, o como un índice completo de un producto.  Con ello se evita que se produzca la indexación en la máquina del usuario y permite a éste obtener los primeros resultados de búsqueda con mayor rapidez.

Construir un índice de documentación para un plug-in

Para construir un índice, siga estos pasos:

Construir el índice de un producto

El índice por producto es un índice agregado de toda la documentación del producto. Debe utilizarse en aquellos escenarios en que no cambie el conjunto de plug-ins de documentación. Por ejemplo, una instalación de infocenter se beneficiará de un índice por producto.

Para construir un índice, siga estos pasos:

Por ejemplo, si se ejecuta

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

el archivo doc_index.zip se guardará en el directorio nl/en que se creará en d:/build/com.my.plugin.  El zip contendrá el índice de contenidos de los documentos que están disponibles para los usuarios cuando éstos ejecutan el producto en el entorno local en.

Empaquetado e instalación del índice preconstruido del producto

Los índices preconstruidos, es decir, los archivos doc_index.zip, deben empaquetarse en forma de plug-in.   Puede optar por utilizar un plug-in asociado con la característica primaria o empaquetar el índice correspondiente a cada idioma en fragmentos separados.

Por ejemplo, si la documentación del producto está disponible en tres idiomas, inglés, alemán y chino simplificado, el plug-in com.my.plugin puede tener la estructura siguiente:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
otros archivos de este plug-in

El ID del plug-in tiene que especificarse como una preferencia de productIndex para el plug-in org.eclipse.help.base. Para el plug-in del ejemplo anterior, el archivo plugin_customization.ini debe contener la entrada
org.eclipse.help.base/productIndex=com.my.plugin