ユーザーが製品のヘルプ目次を検索する場合、検索は文書の索引内で実行されます。デフォルトでは、この索引は、ヘルプ検索を最初に呼び出したときに作成されますが、3.1 以降は、事前に作成して各プラグインと共に、または製品の完全な索引としてユーザーに配布することができます。これにより、ユーザーのマシンで索引付けが行われなくなるので、ユーザーは最初の検索結果をより迅速に得ることができます。
索引を作成するには、次のステップを実行します。
org.eclipse.help.toc 拡張機能
に index
要素を追加し、索引が作成されるディレクトリーを指定します。
help.buildHelpIndex
ANT タスクを実行して、該当するロケールの索引を作成します。製品ごとの索引は、製品内のすべての文書の索引を集約したものです。この索引は、文書プラグインのセットが変更されないシナリオで使用する必要があります。例えば、InfoCenter をインストールすると、製品ごとの索引を活用できます。
索引を作成するには、次のステップを実行します。
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=locale次の引数を設定する必要があります。
たとえば、次のコマンドを実行したとします。
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
すると、ファイル doc_index.zip が d:/build/com.my.plugin のもとに作成される
nl/en ディレクトリーに保存されます。この zip には、
ユーザーが製品を en ロケールで実行するときに使用できる文書の内容の索引が含まれます。
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
このプラグインの別ファイル
org.eclipse.help.base/productIndex=com.my.plugin