Kontexte

Kennung: org.eclipse.help.contexts

Beschreibung: An diesem Erweiterungspunkt kann kontextbezogene Hilfe für ein einzelnes Plug-in definiert werden.

Konfigurationsbefehle:

   <!ELEMENT contexts EMPTY>
   <!ATTLIST contexts file CDATA #REQUIRED>

Konfigurationsbefehle für Kontexte (werden in die Manifestdatei für Kontexte gestellt):

    <!ELEMENT contexts (context)* ) >

    <!ELEMENT context (description?,topic*) >
    <!ATTLIST context id ID #REQUIRED >

    <!ELEMENT description (#PCDATA)>

    <!ELEMENT topic EMPTY >
    <!ATTLIST topic label CDATA #REQUIRED >
    <!ATTLIST topic href CDATA #IMPLIED >

Die Manifestdateien für Kontexte stellen alle Informationen bereit, die benötigt werden, wenn der Benutzer die kontextbezogene Hilfe anfordert. Die ID wird durch die Plattform übergeben, um den gegenwärtig aktiven Kontext zu kennzeichnen. Die Kontextdefinitionen mit übereinstimmenden IDs werden dann abgerufen. Das Objekt IContext wird anschließend vom Hilfesystem erstellt; es enthält Beschreibungen und Themen von allen Kontextdefinitionen für eine gegebene ID. Die Beschreibung wird für den Benutzer angezeigt; verwandte Themen sind für den Benutzer hilfreich, um den aktuellen Kontext zu verstehen. Die verwandten Themen sind html-Dateien, die in einer doc.zip zusammen mit Themen, die Teil der Onlinehilfe sind, gepackt sind.
 

Beispiele:

Das folgende Beispiel verwendet den Erweiterungspunkt contexts.

Angaben in der Datei plugin.xml:

   <extension point="org.eclipse.help.contexts">
      <contexts file="xyzContexts.xml"/>
   </extension>
 

Angaben in der Datei xyzContexts.xml:

    <contexts>
      <context  id="generalContextId">
        <description>Dies ist eine Beispielzeichenfolge für den Hilfetext zur Taste F1.</description>
        <topic href="contexts/RelatedContext1.html"  label="Verwandtes Hilfethema 1"/>
        <topic href="contexts/RelatedContext2.html"  label="Verwandtes Hilfethema 2"/>
      </context>
    </contexts>
 

Zeichenfolgen auslagern

Die Context XML-Dateien können übersetzt werden und die resultierende Kopie (mit übersetzten Beschreibungskennsätzen) müssen in das Verzeichnis nl/<sprache>/<land> oder nl/<sprache> gestellt werden. Hierbei steht nl/<sprache>/<land> für den aus zwei Buchstaben bestehenden Code für Land und Sprache, wie in den Codes für Ländereinstellungen verwendet. Beispielsweise müssen die Übersetzungen für Traditionelles Chinesisch in das Verzeichnis nl/zh/TW gestellt werden. Das Verzeichnis nl/<sprache>/<land> hat eine höhere Priorität als nl/<sprache> Nur dann, wenn keine Datei in nl/<sprache>/<land> gefunden wird, wird die in nl/<sprache> vorhandenen Datei verwendet. Das Stammverzeichnis eines Plug-Ins wird zuletzt durchsucht.

Die in doc.zip enthaltenen verwandten Themen können durch Erstellen der Datei doc.zip mit den übersetzten Versionen von Dokumenten und durch Stellen von doc.zip in das Verzeichnis
nl/<sprache>/<land> oder nl/<sprache> lokalisiert werden. Das Hilfesystem sucht nach Dateien in diesem Verzeichnis, bevor das Standardverzeichnis plugin durchsucht wird.

 
API-Informationen: Zur Verwendung dieses Erweiterungspunkts ist kein Code erforderlich. Sie müssen lediglich die entsprechende(n) Manifestdatei(en) bereitstellen, die in der Datei plugin.xml angegeben ist/sind.
 

Bereitgestellte Implementierung: Die Standardimplementierung der Benutzerschnittstelle für das Hilfesystem, die durch die Eclipse-Plattform bereitgestellt wird, unterstützt den Erweiterungspunkt contexts ohne Einschränkungen.


Copyright IBM Corp. und Andere 2000, 2002. Alle Rechte vorbehalten.