Hinweis: Die Entwicklung der Hilfefunktion ist noch nicht abgeschlossen. Vor dem Erreichen der Stabilität kann es daher zu Änderungen kommen. Die Hilfefunktion wird im vorliegenden Status zur Verfügung gestellt, um Rückmeldungen der ersten Anwender zu erhalten, und unter der Voraussetzung, dass Details des Ergänzungsmechanismus auf erhebliche Weise geändert werden könnten.

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 name 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 (topic)* >
    <!ATTLIST topic id ID #IMPLIED >
    <!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. Dann wird die Kontextdefinition mit einer übereinstimmenden ID abgerufen. Dieses Kontextelement enthält die Kurzbeschreibung, die für den Benutzer angezeigt wird, sowie zusätzliche Themen, die dem Benutzer das Verstehen des aktuellen Kontextes erleichtern können.
 

Beispiele:

Das folgende Beispiel verwendet den Erweiterungspunkt contexts.

Angaben in der Datei plugin.xml:

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

Angaben in der Datei xyzContexts.xml:

    <contexts>
      <context  id="generalContextId">
        <description> This is a sample F1 help string.</description>
        <topic href="contexts/RelatedContext1.html"  label="Help Related Topic 1"/>
        <topic href="contexts/RelatedContext2.html"  label="Help Related Topic 2"/>
      </context>
    </contexts>
 

Zeichenfolgen auslagern

Manifestdateien für Kontexte lagern ihre Zeichenfolgen aus, indem die Zeichenfolge durch einen Schlüssel (z. B. %fooWidget) ersetzt und dann in der Datei "context.properties" ein Eintrag mit dem folgenden Format erstellt wird:
    fooWidget = "Builds the project "
Die Angaben für verwandte Hilfethemen werden mit einer ähnlichen Methode ausgelagert. Um die Angabe <topic href="fooHelp.html" label="Building Projects"> auszulagern, wird die Bezeichnung durch den Schlüssel "%buildingProjects" ersetzt. Das Thema sieht dann wie folgt aus:
    <topic href="fooHelp.html" label="%buildingProjects">
Anschließend muss in der Datei "context.properties" der folgende Eintrag erstellt werden:
    buildingProjects = Building Projects
Die Hilfefunktion sucht in der Datei "context.properties", wenn Zeichenfolgen durch eine Ergänzung für kontextbezogene Hilfe ausgelagert wurden.
 

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 optionale Standardimplementierung der Benutzerschnittstelle für die Hilfefunktion, die durch die Eclipse-Plattform bereitgestellt wird, unterstützt den Erweiterungspunkt contexts ohne Einschränkungen.
 
 
 

Copyright IBM Corp. 2000, 2001. Alle Rechte vorbehalten.