Förindexeringsdokumentation

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.

Bygga ett dokumentationsindex för ett insticksprogram

Så här skapar du ett index:

Skapa ett index för en produkt

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:

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.

Paketering och installation av det förbyggda indexet för produkten

Förbyggda index, filerna doc_index.zip, måste paketeras som insticksprogram.   Du kan välja att använda ett insticksprogram som är associerat till primärfunktionen eller paketera indexet för varje språk i separata fragment.

Till exempel om dokumentationen för en produkt är tillgänglig på tre språk, till exempel engelska, tyska och förenklad kinesiska, kan insticksprogrammet com.my.plugin ha följande struktur:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
andra filer för insticksprogrammet

ID:t för insticksprogrammet måste anges som en productIndex-inställning för insticksprogrammet org.eclipse.help.base. För insticksprogrammet i exemplet ovan måste filen plugin_customization.ini innehålla posten
org.eclipse.help.base/productIndex=com.my.plugin