Índice de documentación preconstruido

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 durante la primera invocación de la búsqueda en la ayuda, pero puede preconstruirse y entregarse al usuario con el 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 el índice de un producto

Para construir un índice, siga estos pasos:

Por ejemplo, si se ejecuta

eclipse -nosplash -application org.eclipse.help.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

Los índices preconstruidos, es decir, los archivos doc_index.zip, deben empaquetarse en forma de conector.   Puede optar por utilizar un conector 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 dos idiomas, inglés y alemán, el conector com.my.plugin puede tener la estructura siguiente:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
otros archivos de este conector

El ID del conector debe especificarse en forma de preferencia de productIndex para el conector org.eclipse.help.  Para el conector del ejemplo anterior, el archivo plugin_customization.ini debe contener la entrada
org.eclipse.help/productIndex=com.my.plugin


Copyright IBM Corporation y otros 2000, 2003.