Avainsanaindeksi

org.eclipse.help.index

3.2

Käytetään lisätyn ohjesisällön avainsanaindeksin rekisteröintiin.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


Seuraavassa on indeksin laajennuspisteen käyttöesimerkki.

(Määritystiedosto plugin.xml.)

 

<extension point=

"org.eclipse.help.index"

>

<index file=

"index.xml"

/>

</extension>

(tiedostossa index.xml)

<index>
    <entry keyword="Vehicle">
        <topic href="inventory_of_wheel.html"/>
        <entry keyword="Car">
            <topic href="car.html"/>
        </entry>
        <entry keyword="Ship">
            <topic href="ship.html"/>
        </entry>
        <entry keyword="Airplane">
            <topic href="airplane.html" title="History of aviation"/>
            <topic href="jet.html" title="Jet engine"/>
        </entry>
    </entry>
    <entry keyword="Engine">
        <entry keyword="Horse">
            <topic href="horse.html"/>
        </entry>
        <entry keyword="Steamer">
            <topic href="steamer.html"/>
        </entry>
        <entry keyword="Wankel engine">
            <topic href="wankel.html"/>
        </entry>
        <entry keyword="Jet engine">
            <topic href="jet.html"/>
        </entry>
    </entry>
    <entry keyword="Electricity">
        <topic href="electricity.html"/>
    </entry>
</index>

Kansainvälistys Indeksin XML-tiedostot voidaan kääntää ja käännetyt tiedostot (joiden avainsanat on myös käännetty) sijoittaa hakemistoon nl/<kieli>/<maa> tai nl/<kieli>. Hakemistopolkujen <kieli>- ja <maa>-osat ovat paikallistunnuskoodien mukaiset kaksikirjaimiset kieli- ja maakoodit. Esimerkiksi perinteisen kiinan käännösten tallennushakemisto olisi nl/zh/TW. Nl/<kieli>/<maa>-hakemisto on ensisijainen nl/<kieli>-hakemistoon verrattuna. Nl/<kieli>-hakemistossa olevaa tiedostoa käytetään vain, jos tiedostoa ei löydy nl/<kieli>/<maa>-hakemistosta. Tiedostoa etsitään viimeisenä lisäosan päähakemistosta.

Tämän laajennuspisteen käyttö ei edellytä koodia. Riittää, että plugin.xml-tiedoston mukaiset manifest-tiedostot on luotu.

Eclipse-käyttöympäristön mukana toimitettava ohjejärjestelmän käyttöliittymän oletustoteutus tukee index-laajennuspistettä.