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 conector, 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.
Para construir un índice, siga estos pasos:
index
a la
extensión org.eclipse.help.toc
de un conector de documentación
para especificar el directorio donde estará el índice.
help.buildHelpIndex
ANT para cada conector y fragmento con
documentación.
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 conectores de documentación. Por ejemplo, una instalación de infocenter se beneficiará de un índice por producto.
Para construir un índice, siga estos pasos:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localedesde el directorio que contiene el producto. Deben establecerse los siguientes atributos:
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.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
otros archivos de este conector
org.eclipse.help.base/productIndex=com.my.plugin