Das Stand-alone Hilfesystem installieren
Wenn Sie eine Applikation erstellen, die nicht auf den Eclipse-Rahmenbedingungen basiert, können Sie dennoch das Eclipse-Hilfesystem verwenden. Ihre Applikation kann das Stand-alone-Hilfesystem paketierungen und installieren, eine sehr kleine Version von Eclipse, das um alle Komponenten ausgenommen des Hilfesystems bereinigt wurde. Dann kann Ihre Applikation von seinem Hilfemenü oder von UI-Objekten aus API-Aufrufe starten, um den Hilfe-Browser aufzurufen. Das Stand-alone-Hilfesystem verfügt über alle Funktionen des integrierte Hilfesystems mit Ausnahme von Infopos und aktiver Hilfe.
Installation/Paketierung
Diese Schritte sind für den Hilfesystemintegrator gedacht und sollen nicht alle möglichen Szenarien abdecken. Es wird davon ausgegangen, dass die Startapplikation in Java ist und Ihre gesamte Dokumentation als Eclipse Plug-in geliefert wird und Sie allgemein mit dem Ecklipse-Hilfesystem vertraut sind.
- Laden Sie den Eclipse 2.0 Release-Level Platform Runtime Binary-Treiber von
www.eclipse.org herunter.
- Installieren (dekomprimieren) Sie den Treiber unter Ihrem Applikationsverzeichnis, z.B. d:\myApp. Dadurch entsteht ein Eclipse-Unterverzeichnis d:\myApp\eclipse, das den für die Eclipse-Plattform erforderlichen Code enthält (der das Hilfesystem beinhaltet).
Aufrufen der Hilfeklassen
- Stellen Sie sicher, dass d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar sich in Ihrem Applkationsklassenpfad befindet. Die zum Starten, Aufrufen und Herunterfahren des Hilfesystems verwendete Klasse ist org.eclipse.help.standalone.Help.
- Erstellen Sie in Ihrer Applikation eine Instanz der Hilfeklasse, indem Sie das Plug-ins-Verzeichnis überspringen. Dieses Objekt sollte bis zum Ende Ihrer Applikationen beibehalten werden.
Help helpSystem = new Help("d:\\myApp\\eclipse\\plugins");
- Zum Starten des Hilfesystems
helpSystem.start();
Am Ende Ihrer Applikation zum Herunterfahren des Hilfesystems:
helpSystem.shutdown();
- Zum Aufrufen der Hilfe bei Bedarf:
helpSystem.displayHelp();
Sie können auch Hilfe zu bestimmten primären TOC-Dateien oder Themen aufrufen:
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml");
helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
- Zum Starten der kontextsensitiven Hilfe rufen Sie helpSystem.displayContext(contextId, x, y) auf, wobei contextId eine vollständig qualifizierte Kontext-ID ist. Die Bildschirmkoordinaten x und y werden derzeit nicht verwendet.
Testen der Stand-alone-Hilfe
Die org.eclipse.help.standalone.Help-Klasse hat ein einfaches Hauptprogramm, das Sie starten können, um zu sehen, wie die Stand-alone-Hilfe sofort einsatzfähig ist. Von einer Befehlszeile führen Sie folgenden Befehl aus:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar
org.eclipse.help.standalone.Help d:\myApp\eclipse\plugins