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.
Index készítéséhez tegye a következőket:
index
elemet az
org.eclipse.help.toc kiterjesztéshez
a dokumentáció
bedolgozóban annak a könyvtárnak megadásához, amelyben az index lesz,help.buildHelpIndex
ANT feladatot minden bedolgozóhoz és töredé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:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localea terméket tartalmazó könyvtárból. A következő paramétereket kell beállítani:
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.
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
org.eclipse.help.base/productIndex=com.my.plugin