预先构建的文档索引

当用户搜索产品的帮助内容时,就会在文档索引内执行搜索。缺省情况下,此索引是在第一次调用帮助搜索功能时创建的,但可以预先构建并随插件交付给用户,从 3.1 开始,也可以作为产品的完整索引交付。这样就不必在用户机器上建立索引,并使用户能够更快地获取第一个搜索结果。

为插件构建文档索引

要构建索引,遵循下列步骤:

构建产品的索引

完整产品索引是产品中所有文档的聚集索引。在文档插件集不更改的情况下,应该使用此索引。例如,信息中心安装就可以从完整产品索引中受益。

要构建索引,遵循下列步骤:

例如,运行

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

将导致文件 doc_index.zip 保存在 nl/en 目录中,该目录将在 d:/build/com.my.plugin 下面创建。zip 将包含用户在 en 语言环境中运行产品时可用的文档内容的索引。

产品的预先构建的索引的打包和安装

需要将预先构建的索引(即 doc_index.zip 文件)打包为插件。可以选择使用与主要功能部件相关联的插件,也可以选择将每一种语言的索引打包为单独的段。

例如,如果提供了三种语言的产品文档(例如,英语、德语和简体中文),则插件 com.my.plugin 可以具有以下结构:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
该插件的其它文件

需要将插件的标识指定为 org.eclipse.help.base 插件的 productIndex 首选项。对于以上示例中的插件,plugin_customization.ini 文件需要包含以下条目:
org.eclipse.help.base/productIndex=com.my.plugin