Hilfe zum Knoten hinzufügen

Sie können für den von Ihnen erstellten Knoten Hilfetext als HTML-Datei hinzufügen.

Vorbereitungen:
Fügen Sie für den von Ihnen erstellten Knoten Hilfetext hinzu, in dem die Gründe und der Zeitpunkt der Verwendung des Knotens sowie dessen Konfiguration erläutert werden:

Alle drei Formen des Hilfetextes sind optional; Sie können eine oder mehrere der drei unten beschriebenen Ressourcen erstellen.

  1. Erstellen Sie im Projekt die Datei help.html, die die Onlinehilfe enthält, in der die Funktionsweise und Verwendung des Knotens erläutert werden. Wenn die Hilfe aus mehreren Dateien besteht, können Sie im Plug-in-Projekt ein separates Unterverzeichnis für die Dokumentation erstellen und die Onlinehilfedateien darin speichern.

    Sie können veranlassen, dass die Onlinehilfe des Knotens in das mit dem Produkt gelieferten Information Center integriert wird, und zwar unter dem Endpunktknoten namens "Benutzerdefinierte Knoten". Sie finden diesen unter Referenz > Nachrichtenflüsse. Damit die Onlinehilfe für Ihren Knoten an dieser Stelle angezeigt wird, müssen Sie folgendermaßen vorgehen:

    1. Ändern Sie die Datei plugin.xml so, dass in das Information Center der folgende Erweiterungspunkt eingefügt wird:
      <extension point="org.eclipse.help.toc">
      <toc file="toc.xml"/>
      </extension>
    2. Erstellen Sie in Ihrem benutzerdefinierten Knotenprojekt die Datei toc.xml, und ändern Sie das Attribut link_to so, dass es mit dem Anker "UDNodes" verknüpft wird, der im Inhaltsverzeichnis des Information Centers bereits definiert ist:
      <toc label="My Plugin Node" topic="my_node.htm"
      	link_to="../com.ibm.etools.mft.doc/toc.xml#UDNodes">
      <topic label="Mytopic 1" href="topic1.htm>
      </toc>
      Ihr Hilfethema wird jetzt im Inhaltsverzeichnis unter Referenz > Nachrichtenflüsse > Benutzerdefinierte Knoten angezeigt.

      Die Beispielknoten, die im Lieferumfang des Produktes enthalten sind, veranschaulichen diese Option.

      Weitere Erläuterungen zu Erweiterungspunkten und deren Verwendung finden Sie im PDE Guide.

  2. Fügen Sie eine kontextbezogene Hilfe (F1) zum Knoten hinzu. Die Kontexthilfe wird angezeigt, wenn Sie in der Ansicht 'Brokeranwendungsentwicklung' auf einen Knoten klicken und F1 drücken.

    Wenn ein Knoten erstellt wird, wird die Datei HelpContexts.xml erstellt. In dieser Datei wird auf Basis des Knotennamens eine Kontext-ID zugeordnet. Sie können die Datei HelpContexts.xml für Ihren Knoten ändern, indem Sie den Text im Beschreibungsfeld ändern. Der Name der Datei HelpContexts.xml muss im Projekt eindeutig sein, sie kann jedoch mehrere Kontexteinträge enthalten; wenn in einem Projekt beispielsweise mehrere Knoten enthalten sind, kann die Datei für jeden Knoten eine kontextbezogene Hilfe enthalten.

    Die Länge der kontextbezogenen Hilfe ist begrenzt. Es ist sinnvoll, dem Benutzer durch einen Link von der F1-Hilfe zu einer HTML-Datei, die zusätzliche Informationen enthält, weitere Hilfe zur Verfügung zu stellen - z. B. zur Onlinehilfe des Knotens, die oben beschrieben wird. Nachfolgend ein Beispiel für die Codierung des Links:
    <topic href"../Plug-in-Verzeichnis/html file" label="Link title">
  3. Fügen Sie zum Knoten eine Kurzinfo (unter Windows) 'QuickInfo' genannt) hinzu. Wenn Sie einen benutzerdefinierten Knoten erstellen, wird die Datei palette.properties erstellt. Sie können diese Datei so ändern, dass sie eine Kurzinfo für Ihren Knoten enthält, in der der Knotenname angezeigt wird, wenn die Palette nicht breit genug ist, um ihn vollständig anzuzeigen.

Sie können eine weitere optionale Funktion, ein Knotensymbol oder einen Eigenschafteneditor oder -compiler hinzufügen oder Sie können Ihren Knoten testen.

Zugehörige Konzepte
Benutzerdefinierte Empfangsknoten
Benutzerdefinierte Knoten für die Nachrichtenverarbeitung
Benutzerdefinierte Sendeknoten
Zugehörige Tasks
Benutzerdefinierte Erweiterungen entwickeln
Bereitgestellte Beispiele für benutzerdefinierte Erweiterung implementieren
Benutzerdefinierten Knoten testen
Workbench-Projekt eines benutzerdefinierten Knotens verpacken
Zugehörige Verweise
Benutzerdefinierte Erweiterungen
Bemerkungen | Marken | Downloads | Bibliothek | Unterstützung | Feedback

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
Letzte Aktualisierung : 2009-02-17 15:29:54

as04497_