<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT index EMPTY>
<!ATTLIST index
file CDATA #REQUIRED>
Konfigurationsbefehle für Indexdatei:
<!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 >
Element "index"
Das Element "index" stellt ein Indexexemplar dar. Ein Index besteht aus Einträgen, die wiederum jeweils einem bestimmten Suchbegriff entsprechen. Alle ergänzten Indizes werden in einen Hauptindex gemischt, den die Hilfefunktion für den Benutzer zur Verfügung stellt. Bei der Erstellung des Indexes werden die Einträge in alphabetischer Reihenfolge angehängt.
Element "entry" (Eintrag)
Das Element "entry" stellt einen Suchbegriff des Indexes dar. Jeder Eintrag kann mehrere Links zu Hilfethemen enthalten, die dem Suchbegriff zugeordnet sind. Ein Eintrag kann auch als Container für andere Einträge (Untereinträge) verwendet werden, um eine Hierarchie aus Suchbegriffen zu bilden. Ein Eintrag kann gleichzeitig ein Container für Untereinträge sein und Themen enthalten.
Element "topic" (Thema)
Das Element "topic" bietet einen Verweis auf den Inhalt der Hilfe, der sich auf den Suchbegriff bezieht. Das Attribut "href" wird bezogen auf das Plug-in angegeben, zu dem die Manifestdatei gehört. Falls Sie auf eine Datei in einem anderen Plug-in zugreifen müssen, können Sie die folgende Syntax verwenden:
<topic label="Thema im anderen Plug-in" href="../other.plugin.id/concepts/some_other_file.html" />
Mit dem Attribut "title" wird der Link zum Inhalt der Hilfe benannt, wenn einem Suchbegriff mehrere Themen zugeordnet sind. Falls dieses Attribut nicht angegeben wird, stammt der Titel aus einem Inhaltsverzeichnis, das Eigner des Links ist. Gehört der Link nicht zu einem Inhaltsverzeichnis, muss das Attribut "title" angegeben werden, da der Titel andernfalls nicht definiert ist.
Angaben in der Datei plugin.xml:
<extension point=
"org.eclipse.help.index"
>
<index file=
"index.xml"
/>
</extension>
Angaben in der Datei 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>
Internationalisierung: Die XML-Dateien des Indexes können übersetzt werden. Die entstandene Kopie (mit übersetzten Suchbegriffen) sollte in ein Verzeichnis "nl/<sprache>/<land> oder "nl/<sprache>" gestellt werden. Die Variablen <sprache> und <land> stehen für die zweistelligen Sprachen- und Ländercodes, wie sie in Codes von Ländereinstellungen verwendet werden. Übersetzungen für traditionelles Chinesisch sollten beispielsweise in das Verzeichnis "nl/zh/TW" gestellt werden. Das Verzeichnis "nl/<sprache>/<land>" hat eine höhere Priorität als das Verzeichnis "nl/<sprache>". Nur dann, wenn im Verzeichnis "nl/<sprache>/<land>" keine Datei gefunden wird, wird die Datei im Verzeichnis "nl/<sprache>" verwendet. Das Stammverzeichnis eines Plug-ins wird zuletzt durchsucht.
Copyright (c) 2006 Intel Corporation und andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter
http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.