<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Konfigurációs kód az indexfájlhoz:
<!ELEMENT index (entry)* >
<!ELEMENT entry (entry | topic)* >
<!ATTLIST entry keyword CDATA #REQUIRED >
<!ELEMENT topic EMPTY >
<!ATTLIST topic href CDATA #REQUIRED >
<!ATTLIST topic title CDATA #IMPLIED >
Az indexelem
Az indexelem az index egy példányát ábrázolja. Az index bejegyzésekből áll, amelyek mindegyike egy adott kulcsszónak felel meg. Minden hozzáadott index összevonásra kerül egy elsődleges indexbe, amelyet a Súgórendszer biztosít a felhasználó számára. Ha az index elő lett állítva, akkor a bejegyzések ábécérendben kerülnek hozzáfűzésre.
A bejegyzéselem
A bejegyzéselem az index kulcsszavát ábrázolja. Minden bejegyzés számos hivatkozást tartalmazhat a kulcsszóhoz tartozó témakörökre. A bejegyzés más bejegyzések (albejegyzések) tárolója is lehet a kulcsszavak hierarchiájának kialakítása érdekében. Ez lehetővé teszi, hogy a bejegyzés albejegyzések tárolója legyen és egyszerre témakörökkel is rendelkezzen.
A témakör elem
A témakör elem a kulcsszóval kapcsolatos súgótartalomra mutató hivatkozást biztosít. A href attribútum ahhoz a bedolgozóhoz viszonyított, amelyhez a leírófájl tartozik. Másik bedolgozóban található fájl eléréséhez a következő szintaxis használható:
<topic label="témakör egy másik bedolgozóban" href="../other.plugin.id/concepts/some_other_file.html" />
A title attribútum nevet ad a súgótartalomra mutató hivatkozásnak, ha több témakör van egy kulcsszóhoz rendelve. Ha az attribútum nincs megadva, akkor a cím a hivatkozást birtokló TOC-ből ered. Ha a hivatkozás egy TOC-hez sem tartozik, akkor a title attribútumot meg kell adni, ellenkező esetben a cím meghatározatlan lesz.
(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.
Copyright (c) 2006 Intel Corporation és mások.
Minden jog fenntartva. Jelen program és annak kísérőanyagai a csomaghoz
tartozó, illetve a
http://www.eclipse.org/legal/epl-v10.html
címen is elérhető Eclipse Public License 1.0 verziójának hatálya alatt lettek
közzétéve.