<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Indeksitiedoston merkintärakenne on seuraava:
<!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 >
Index-elementti
Index-elementti kuvaa indeksin ilmentymää. Indeksi koostuu merkinnöistä, joista kukin vastaa tiettyä avainsanaa. Kaikki lisätyt indeksit yhdistetään yhteen pääindeksiin, jonka ohjejärjestelmä toimittaa käyttäjän käyttöön. Kun indeksi luodaan, merkinnät liitetään aakkosjärjestyksessä.
Entry-elementti
Entry-elementti kuvaa indeksin avainsanaa. Kukin merkintä voi sisältää useita linkkejä ohjeaiheisiin, jotka liittyvät avainsanaan. Merkintä voi olla muiden merkintöjen (alimerkintöjen) säilö. Näin voi muodostaa avainsanojen hierarkioita. Merkintä voi samaan aikaan sisältää alimerkintöjä ja ohjeita.
Topic-elementti
Topic-elementti antaa viittauksen avainsanaan liittyvään ohjesisältöön. Href-määritteen arvo on määritettävä suhteessa lisäosaan, johon manifest-tiedosto kuuluu. Jos halutaan käyttää jonkin toisen lisäosan tiedostoa, voidaan käyttää seuraavaa rakennetta:
<topic label="Toisen lisäosan ohjeaihe" href="../other.plugin.id/concepts/some_other_file.html" />
Title-määritteen avulla nimetään linkki ohjesisältöön silloin, kun samaan avainsanaan liittyy useita ohjeaiheita. Jos määritettä ei määritetä, otsikko tulee linkin omistavasta sisällysluettelosta. Jos linkki ei kuulu mihinkään sisällysluetteloon, title-määrite on määritettävä tai otsikosta tulee määrittämätön.
(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.
Copyright (c) 2006 Intel Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html