Pré-indexação da documentação

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.

Construir um índice da documentação para um plug-in.

Para construir um índice siga os passos seguintes:

Construir um índice para um produto

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:

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.

Empacotamento e Instalação do índice pré-construído do produto

Os índices pré-construídos, os ficheiros doc_index.zip, devem ser colocados em pacotes como um plug-in.  O utilizador pode optar por usar um plug-in associado com a função principal ou pode optar por colocar em pacote o índice para cada idioma em fragmentos separados.

Por exemplo, se a documentação do produto estiver disponível em três idiomas, digamos o inglês, o alemão e o chinês simplificado, um plug-in com.my.plugin pode ter a seguinte estrutura:
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

O ID do plug-in deve ser especificado como uma preferência productIndex para o plug-in org.eclipse.help.base.  Para o plug-in no exemplo anterior, o ficheiro plugin_customization.ini deverá conter a entrada
org.eclipse.help.base/productIndex=com.my.plugin