Valmiiksi indeksoitu ohje

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.

Dokumentaatioindeksin koonti lisäosaan

Voit koota indeksin seuraavasti:

Tuotteen indeksin koonti

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:

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.

Tuotteen valmiiksi kootun indeksin paketointi ja asennus

Valmiiksi kootut indeksit eli doc_index.zip-tiedostot on paketoitava lisäosana.  Voit joko käyttää päätuoteominaisuuteen liitettyä lisäosaa tai paketoida kunkin kielen indeksin erillisiin fragmentteihin.

Jos esimerkiksi tuotteen dokumentaatiosta on olemassa kolme kieliversiota, jotka voivat olla vaikkapa englanti, saksa ja yksinkertaistettu kiina, com.my.plugin-lisäosa voi olla rakenteeltaan seuraavanlainen:
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

Lisäosan tunnus on määritettävä productIndex-oletusasetuksena org.eclipse.help.base-lisäosassa. Yllä olevan esimerkin lisäosassa plugin_customization.ini-tiedostossa on oltava merkintä
org.eclipse.help.base/productIndex=com.my.plugin