事前に作成された文書の索引

ユーザーが製品のヘルプ目次を検索する場合、検索は文書の索引内で実行されます。デフォルトでは、この索引は、ヘルプ検索を最初に呼び出したときに作成されますが、3.1 以降は、事前に作成して各プラグインと共に、または製品の完全な索引としてユーザーに配布することができます。これにより、ユーザーのマシンで索引付けが行われなくなるので、ユーザーは最初の検索結果をより迅速に得ることができます。

プラグイン用の文書索引の作成

索引を作成するには、次のステップを実行します。

製品の索引作成

製品ごとの索引は、製品内のすべての文書の索引を集約したものです。この索引は、文書プラグインのセットが変更されないシナリオで使用する必要があります。例えば、InfoCenter をインストールすると、製品ごとの索引を活用できます。

索引を作成するには、次のステップを実行します。

たとえば、次のコマンドを実行したとします。

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

すると、ファイル doc_index.zipd:/build/com.my.plugin のもとに作成される nl/en ディレクトリーに保存されます。この zip には、 ユーザーが製品を en ロケールで実行するときに使用できる文書の内容の索引が含まれます。 

製品の事前作成された索引のパッケージ化およびインストール

事前に作成された索引である doc_index.zip ファイルは、プラグインとしてパッケージ化する必要があります。  1 次フィーチャーに関連したプラグインを使用するか、 または各言語の索引を別々のフラグメントにパッケージ化することができます。

例えば、製品の文書が英語、ドイツ語、中国語 (簡体字) など、3 つの言語から選択可能な場合、 プラグイン com.my.plugin は次の構造を持ちます。
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
このプラグインの別ファイル

プラグインの ID は、org.eclipse.help.base プラグインの productIndex の設定として指定する必要があります。上の例のプラグインの場合、plugin_customization.ini ファイルに次のエントリーを含める必要があります。
org.eclipse.help.base/productIndex=com.my.plugin