Quando o utilizador procura os conteúdos de ajuda de um produto, a pesquisa é executada dentro de um índice da documentação. Por predefinição, este índice é criado na primeira invocação da pesquisa da ajuda, mas pode ser pré-construído e entregue ao utilizador com cada plug-in, desde a edição 3.1, ou como um índice completo para um produto. Isto impede que ocorra a indexação num computador do utilizador e permite ao utilizador obter os resultados da pesquisa mais rapidamente.
Para construir um índice siga os passos seguintes:
index
à extensão org.eclipse.help.toc
num plug-in de documentação, para especificar o directório onde irá existir o índice;help.buildHelpIndex
para cada plug-in e fragmento com documentação. O índice anterior ao produto é um índice agregado de toda a documentação existente no produto. Deverá ser utilizado em cenários nos quais o conjunto de plug-ins de documentação não é alterado. Por exemplo, uma instalação do infocenter irá beneficiar com um índice anterior ao produto.
Para construir um índice siga os passos seguintes:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localeno directório que contém o produto. É necessário definir os seguintes argumentos:
Por exemplo, executar
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
irá fazer com que o ficheiro doc_index.zip seja guardado no directório nl/en criado sob d:/build/com.my.plugin. O ficheiro zip irá conter o índice dos conteúdos dos documentos que estão disponíveis para os utilizadores quando executam o produto no locale en.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
outros ficheiros para este plug-in
org.eclipse.help.base/productIndex=com.my.plugin