Kun käyttäjä tekee hakuja tuotteen ohjehakemistosta, haku tapahtuu dokumentaatioindeksissä. Oletusarvoisesti tämä indeksi luodaan kutsuttaessa ensimmäisen kerran ohjehakua, mutta se voi olla valmiiksi koottu ja se voidaan toimittaa käyttäjälle kunkin lisäosan kanssa alkaen versiosta 3.1 tai tuotteen kattavana indeksinä. Tämä estää indeksoinnin käyttäjän koneessa ja nopeuttaa käyttäjän ensimmäisten hakutulosten saantia.
Voit koota indeksin seuraavasti:
index
-elementti org.eclipse.help.toc
extension
-laajennuspisteeseen dokumentaatiolisäosassahelp.buildHelpIndex
ANT -tehtävä kussakin dokumentaatiota sisältävässä lisäosassa ja fragmentissa.Tuotekohtainen indeksi on tuotteen koko dokumentaation koosteindeksi. Sitä olisi käytettävä silloin, kun dokumentaatiolisäosien joukko ei muutu. Tuotekohtaisesta indeksistä on hyötyä esimerkiksi Info Centerin asennuksessa.
Voit koota indeksin näin:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localetuotteen sisältävästä hakemistosta. Seuraavat argumentit on määritettävä:
Esimerkiksi ajettaessa komento
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en
tiedosto doc_index.zip tallennetaan nl/en-
hakemistoon, joka luodaan polun d:/build/com.my.plugin alle.
Zip-tiedosto sisältää niiden asiakirjojen hakemistoindeksin, joita käyttäjät voivat käyttää
ajaessaan tuotteen en-paikallistunnuksessa.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
tämän lisäosan muut tiedostot
org.eclipse.help.base/productIndex=com.my.plugin