När användaren söker efter hjälpinnehåll för en produkt utförs sökningen i ett dokumentationsindex. Som standard skapas indexet när hjälpsökning görs för första gången, men kan skapas och levereras till användaren med varje insticksprogram, fr.o.m. version, eller som ett fullständigt index för en produkt. Det förhindrar att indexering görs i användarens dator vilket ger snabbare sökresultat.
Så här skapar du ett index:
index
-element till org.eclipse.help.toc extension
i ett innehållsförteckning för dokumentation för att ange den katalog där indexet ska placeras,help.buildHelpIndex
för varje insticksprogram och fragment med dokumentation.Ett index för en produkt är ett aggregerat index för all dokumentation i produkten. Det bör användas i scenarion där uppsättningen insticksprogram för dokumentation inte ändras. Produktindex kan till exempel med fördel användas för infocenterinstallationer.
Så här skapar du ett index:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localefrån den katalog där produkten finns. Följande argument måste anges:
Om du till exempel kör
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
innebär det att filen doc_index.zip sparas i katalogen nl/en
som skapas i d:/build/com.my.plugin. Zip-filen innehåller indexet för dokument som är tillgängliga för användare när de kör produkten i språkmiljön en.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
andra filer för insticksprogrammet
org.eclipse.help.base/productIndex=com.my.plugin