预先构建的文档索引

当用户搜索产品的帮助内容时,就会在文档索引内执行搜索。缺省情况下,索引是在第一次调用帮助搜索时创建的,但可以预先构建并随产品交付给用户。这避免在用户机器上建立索引并使用户能够更快地获取第一个搜索结果。

构建产品的索引

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

例如,运行

eclipse -nosplash -application org.eclipse.help.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
该插件的其它文件

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


Copyright IBM Corporation and others 2000, 2003.