Kulcsszó index

org.eclipse.help.index

3.2

Kulcsszó bejegyzések hozzáadott súgótartalomhoz.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


Az alábbiakban egy példa látható az index kiterjesztési pont használatára:

(a plugin.xml fájlban)

 

<extension point=

"org.eclipse.help.index"

>

<index file=

"index.xml"

/>

</extension>

(az index.xml fájlban)

<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>

Nemzetközivé tétel Az index XML fájlok lefordíthatók, az eredményül kapott másolatokat (a lefordított kulcsszavakkal) pedig az nl/<language>/<country> vagy az nl/<language> könyvtárban kell elhelyezni. A <language> és <country> két betűs nyelv- és országkódokat képviselnek a területi beállítási kódokban megadottak szerint. Például a hagyományos kínai fordításokat az nl/zh/TW könyvtárban kell elhelyezni. Az nl/<language>/<country> könyvtár az nl/<language> könyvtárnál nagyobb prioritással rendelkezik. Az nl/<language> könyvtárban található fájl csak akkor kerül felhasználásra, ha az nl/<language>/<country> könyvtár üres. A bedolgozó gyökérkönyvtárában keres utoljára a rendszer.

A kiterjesztési pont használatához nem szükséges kód. Mindössze a plugin.xml fájlban említett megfelelő leírófájlokat kell biztosítani.

Az Eclipse környezettel biztosított súgórendszer felhasználói felületének alapértelmezett megvalósítása teljes mértékben támogatja az index kiterjesztési pontot.