Előregyártott dokumentációs index

Amikor a felhasználó egy termék súgótartalmát keresi, a keresés a dokumentációs indexben kerül végrehajtásra.  Ez az index alapértelmezés szerint  létrejön a súgókeresés első meghívásakor, de egy termékbe előre be is építhető és minden bedolgozóval együtt biztosítható a felhasználó számára a 3.1 változat óta, illetve a termékhez teljes indexként.  Ez megakadályozza, hogy az indexelés a felhasználó gépén történjen, és lehetővé teszi a felhasználó számára, hogy gyorsabban hozzájusson az első keresési eredményekhez.

Dokumentációindex létrehozása egy bedolgozóhoz.

Index készítéséhez tegye a következőket:

Index készítése egy termékhez

A termékenkénti index a termék összes dokumentációjának egyesített indexe. Olyan példahelyzetekben kell használni, amelyben a dokumentáció-bedolgozók halmaza nem változik. Információs központ esetén például a termékenkénti index előnyös.

Index készítéséhez tegye a következőket:

Futtassa például a következőt:

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

Ennek eredményeképp a doc_index.zip fájl mentésre kerül az nl/en könyvtárba, amely a d:/build/com.my.plugin elérési útvonalon jön létre.  A zip tartalmazni azon dokumentumok indexét, amelyek a rendelkezésre állnak a termék futtatásakor en területi beállítással.

A termék előregyártott indexének csomagolása és telepítése

Az előregyártott indexeket (a doc_index.zip fájlokat) bedolgozóként kell csomagolni.   Választhatja az elsődleges szolgáltatáshoz rendelt bedolgozók használatát, vagy azt, hogy minden nyelvhez külön töredékekben hozzácsomagolja az indexet.

Ha a termékdokumentáció például három különböző nyelven érhető el (mondjuk angolul, németül és egyszerűsített kínai nyelven), a com.my.plugin bedolgozó szerkezete a következő lesz:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
a bedolgozó egyép fájljai

A bedolgozó azonosítóját productIndex beállításként kell megadni az org.eclipse.help.base bedolgozóhoz. A fenti példában szereplő bedolgozóhoz a plugin_customization.ini fájlnak tartalmaznia kell a következő bejegyzést:
org.eclipse.help.base/productIndex=com.my.plugin