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.
Para construir um índice, siga essas etapas:
index
no org.eclipse.help.toc
extension
em um plug-in de documentação, para especificar o diretório no qual
o índice existe,help.buildHelpIndex
ANT
para cada plug-in e fragmento com documentação.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:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localea partir do diretório que contém o produto. Os seguintes argumentos precisam ser definidos:
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.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
outros arquivos desse plug-in
org.eclipse.help.base/productIndex=com.my.plugin