<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Konfigurační markup indexového souboru:
<!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 >
Prvek index
Prvek index představuje určitou instanci rejstříku. Rejstřík se skládá z položek, které představují jednotlivá konkrétní klíčová slova. Všechny přispívané rejstříky se slučují do hlavního indexu, který systém nápovědy poskytuje uživatelům. Při sestavování rejstříku se položky připojují v abecedním pořadí.
Prvek entry
Prvek entry představuje určité klíčové slovo rejstříku. Jednotlivé položky mohou obsahovat více odkazů na témata nápovědy asociovaná s klíčovým slovem. Položka může být rovněž kontejnerem jiných položek (tj. podřízených), a vytvářet tak hierarchii klíčových slov. Položka může být kontejnerem podřízených položek a zároveň může obsahovat témata nápovědy.
Prvek topic
Prvek tématu poskytuje odkaz na obsah nápovědy související s klíčovým slovem. Atribut href je relativní vzhledem k modulu plug-in, k němuž patří soubor s manifestem. Pokud potřebujete přístup k souboru v jiném modulu plug-in, můžete použít syntaxi
<topic label="heslo v jiném modulu plug-in" href="../other.plugin.id/concepts/some_other_file.html" />
Atribut title se používá k pojmenování odkazu na obsah nápovědy, je-li s určitým klíčovým slovem asociováno více témat. Pokud tento atribut není zadán, bude použit titulek pocházející z TOC, do kterého patří tento odkaz. Pokud odkaz nepatří do žádného TOC, musí být atribut title zadán. V opačném případě bude titulek nedefinovaný.
(v souboru plugin.xml)
<extension point=
"org.eclipse.help.index"
>
<index file=
"index.xml"
/>
</extension>
(v souboru 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>
Internacionalizace Soubory XML s rejstříkem lze přeložit a výslednou kopii (s přeloženými klíčovými slovy) uložit do adresáře nl/<language>/<country> nebo nl/<language>. <language> a <country> zastupují dvojpísmenné kódy jazyka a země používané v kódech národního prostředí. Například překlady do tradiční čínštiny by měly být umístěny v adresáři nl/zh/TW. Adresář nl/<language>/<country> má vyšší prioritu než adresář nl/<language>. Pouze pokud nebude v adresáři nl/<language>/<country> nalezen žádný soubor, použije se soubor umístěný v adresáři nl/<language>. Nakonec bude prohledán kořenový adresář modulu plug-in.
Copyright (c) 2006 Intel Corporation a další.
Všechna práva vyhrazena.
Tento program a doprovodné materiály jsou zpřístupněny za podmínek licence Eclipse Public License
v1.0, která je součástí této distribuce a je k dispozici na adrese
http://www.eclipse.org/legal/epl-v10.html