<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Configuratiemarkup voor indexbestand:
<!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 >
Het element index
Het element index duidt een instance van de index aan. De index bestaat uit vermeldingen, die alle aan een bepaald trefwoord zijn gekoppeld. Alle aangeleverde indices worden in één hoofdindex samengevoegd, die door het Help-systeem vervolgens wordt getoond aan de gebruiker. Tijdens het samenstellen van de index worden de vermeldingen alfabetisch gesorteerd.
Het element entry
Het element entry duidt een trefwoord uit de index aan. Elk trefwoord kan diverse links bevatten naar Help-onderwerpen die aan het trefwoord zijn gekoppeld. Het element kan verder als container voor andere elementen (subelementen) fungeren om zo een hiërarchie van trefwoorden te vormen. Het element entry kan als container voor subelementen fungeren en tegelijkertijd aan onderwerpen zijn gekoppeld.
Het element topic
Het element topic biedt een verwijzing naar de Help-content die bij het trefwoord hoort. Het kenmerk href is relatief aan de plugin waartoe het manifestbestand behoort. Als u een bestand in een andere plugin wilt gebruiken, kunt u deze syntaxis hanteren:
<topic label="Een onderwerp in een andere plugin" href="../other.plugin.id/concepts/some_other_file.html" />
Wanneer meerdere onderwerpen aan hetzelfde onderwerp zijn gekoppeld, kunnen de koppelingen met het kenmerk title van een naam worden voorzien. Als u het kenmerk weglaat, wordt de titel bepaald aan de hand van de inhoudsopgave waarin de link is opgenomen. Als de link in geen enkele inhoudsopgave voorkomt, moet u het kenmerk title opgeven. Anders is de titel niet gedefinieerd.
(in bestand plugin.xml)
<extension point=
"org.eclipse.help.index"
>
<index file=
"index.xml"
/>
</extension>
(in bestand index.xml)
<index>
<entry keyword="Voertuig">
<topic href="inventory_of_wheel.html"/>
<entry keyword="Auto">
<topic href="car.html"/>
</entry>
<entry keyword="Schip">
<topic href="ship.html"/>
</entry>
<entry keyword="Vliegtuig">
<topic href="airplane.html" title="Geschiedenis van de luchtvaart"/>
<topic href="jet.html" title="Straalaandrijving"/>
</entry>
</entry>
<entry keyword="Motor">
<entry keyword="Paard">
<topic href="horse.html"/>
</entry>
<entry keyword="Stoomboot">
<topic href="steamer.html"/>
</entry>
<entry keyword="Wankelmotor">
<topic href="wankel.html"/>
</entry>
<entry keyword="Straalmotor">
<topic href="jet.html"/>
</entry>
</entry>
<entry keyword="Elektriciteit">
<topic href="electricity.html"/>
</entry>
</index>
Internationalisering De XML-indexbestanden kunnen worden vertaald. Vertaalde versies (met vertaalde trefwoorden) moeten in de directory's nl<taal>/<land> of nl<taal> worden geplaatst. De <taal> en het <land> worden aangeduid door een code van twee letters (zoals in locales). Een vertaling in traditioneel Chinees moet bijvoorbeeld in de directory nl/zh/TW worden geplaatst. De directory nl/<taal>/<land> heeft meer prioriteit dan nl/<taal>. Het bestand in de directory nl/<taal> wordt alleen gebruikt als de directory nl/<taal>/<land> leeg is. De hoofddirectory van de plugin wordt als laatste doorzocht.
Copyright (c) 2006 Intel Corporation en anderen.
Alle rechten voorbehouden. Dit programma en het begeleidende materiaal zijn beschikbaar gesteld onder de voorwaarden van de Eclipse Public License v1.0 die bij deze distributie is geleverd en beschikbaar is op http://www.eclipse.org/legal/epl-v10.html.