Hilfe-Plug-in erstellen

Das vorliegende Beispiel geht davon aus, dass ein Dokumentationsautor eine unformatierte Dokumentation in Form von HTML-Dateien geliefert hat. Die Unterteilung und Struktur dieser Dateien wird ausschließlich vom Dokumentationsteam erstellt. Sobald die Dokumentation zur Verfügung steht, können das Plug-in und die Themen unabhängig voneinander definiert werden.

Zunächst wird davon ausgegangen, dass die Dokumentation bereits in der folgenden Baumstruktur bereitgestellt wurde.

   html/
      concepts/
         concept1.html
         concept1_1.html
         concept1_2.html
      tasks/
         task1.html
         task2.html
         task3_1.html
         task3_2.html
      ref/
         ref1.html
         ref2.html

Der Name des Plug-ins soll com.example.helpexample lauten.

Zuerst muss jetzt das Plug-in-Verzeichnis com.example.helpexample unter dem Plattformverzeichnis plugins erstellt werden. Die oben dargestellte Unterbaumstruktur doc\ sollte in dieses Verzeichnis kopiert werden.

Genauso wie Code-Plug-ins benötigen auch Dokumentations-Plug-ins ein Manifest. Die folgenden Befehle definieren das Dokumentations-Plug-in:

   <?xml version="1.0" ?>
   <plugin name="Beispiel für Onlinehilfe"
      id="com.example.helpexample"
      version="1.0"
      provider-name="Meinbeispiel" />

Copyright IBM Corporation und Andere 2000, 2003.