當使用者搜尋產品的說明內容時,就會在文件索引內執行搜尋。 依預設,第一次呼叫說明搜尋時,將建立這個索引 ,但是自 3.1 開始,可以預先建置並隨著每個外掛程式一起送給使用者,或做為產品的完整索引。 這會避免在使用者機器上編製索引,因而可讓使用者更快地取得第一個搜尋結果。
如果要建置索引,請遵循下列步驟:
index
元素新增至文件外掛程式中的 org.eclipse.help.toc
extension
,以指定要放置索引的目錄。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