Suchbegriffindex

org.eclipse.help.index

3.2

Dieser Erweiterungspunkt dient zur Registrierung eines Suchbegriffindexes für den ergänzten Inhalt der Hilfe.

<!ELEMENT extension (index*)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

file CDATA #REQUIRED>


Das folgende Beispiel zeigt die Verwendung des Erweiterungspunktes für Indizes.

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.

Zur Verwendung dieses Erweiterungspunkts ist kein Code erforderlich. Es ist lediglich erforderlich, die entsprechenden Manifestdateien bereitzustellen, die in der Datei "plugin.xml" angegeben sind.

Die Standardimplementierung der Benutzerschnittstelle der Hilfefunktion, die mit der Eclipse-Plattform ausgeliefert wird, bietet eine vollständige Unterstützung des Erweiterungspunkts index.