Índice de Documentação Pré-construído

Quando o usuário pesquisa por conteúdo de ajuda de um produto, a pesquisa é executada no índice de uma documentação.  Por padrão, esse índice  é criado na primeira chamada da pesquisa de ajuda, mas pode ser pré-construído e entregue ao usuário com cada plug-in, desde o 3.1, ou como um índice completo para um produto.  Isso evita que a indexação ocorra na máquina do usuário e permite que o usuário obtenha os primeiros resultados da procura mais rapidamente.

Construindo um Índice de Documentação para um Plug-in.

Para construir um índice, siga essas etapas:

Construindo um Índice para um Produto

O índice por produto é um índice agregado de toda a documentação no produto. Ele deve ser utilizado em cenários nos quais o conjunto de plug-ins de documentação não estão sendo alterados. Por exemplo, uma instalação do info-center se beneficiará do índice por produto.

Para construir um índice, siga essas etapas:

Por exemplo, a execução de

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

resultará na gravação do arquivo doc_index.zip no diretório nl/en que será criado em d:/build/com.my.plugin.  O arquivo zip conterá um índice do conteúdo dos documentos que estão disponíveis aos usuários quando eles executam o produto no locale en.

Empacotamento e Instalação do Índice Pré-construído do Produto

Os índices pré-construídos, os arquivos de doc_index.zip, precisam ser empacotados como um plug-in.   É possível escolher utilizar um plug-in associado ao recurso principal, ou escolher empacotar o índice para cada idioma em fragmentos separados.

Por exemplo, se a documentação do produto estiver disponível em três idiomas, digamos inglês, alemão e chinês simplificado, um plug-in com.my.plugin poderá ter a seguinte estrutura:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
outros arquivos desse plug-in

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