Standalonehilfesystem installieren

Wenn Sie eine Anwendung erstellen, die nicht auf den Eclipse-Rahmenbedingungen basiert, können Sie dennoch das Eclipse-Hilfesystem verwenden. Ihre Anwendung kann das Standalonehilfesystem packen und installieren, eine sehr kleine Version von Eclipse, aus der alle Komponenten bis auf das Hilfesystem entfernt wurden. Dann kann Ihre Anwendung 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. Wenn eine Anwendung nicht auf Java basiert oder die Hilfetexte benötigt werden, während die Anwendung nicht aktiv ist, können Sie die Standalonehilfe aus einer Systemshell, einem Shell-Script oder einer Desktopverknüpfung verwenden und Befehlszeilenoptionen bereitstellen, statt Java-APIs aufzurufen.

Das Standalonehilfesystem ermöglicht die Übergabe einer Reihe von Optionen, mit denen unterschiedliche Aspekte des Hilfesystems angepasst werden können. Die folgenden Optionen werden unterstützt:

Installation/Paketerstellung

Diese Schritte sind für den Hilfesystemintegrator gedacht und sollen nicht alle möglichen Szenarien abdecken. Es wird davon ausgegangen, dass Ihre gesamte Dokumentation als Eclipse-Plug-in geliefert wird und Sie allgemein mit dem Eclipse-Hilfesystem vertraut sind.
  1. Laden Sie den Binärtreiber für die Eclipse-Plattformlaufzeit unter www.eclipse.org herunter.
  2. Installieren (dekomprimieren) Sie den Treiber unter Ihrem Anwendungsverzeichnis, 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).

Hilfeklassen aus Java aufrufen

  1. Stellen Sie sicher, dass d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar auf Ihrem Anwendungsklassenpfad ist. Die zum Starten, Aufrufen und Herunterfahren des Hilfesystems verwendete Klasse ist org.eclipse.help.standalone.Help.
  2. Erstellen Sie einen Zeichenfolgenbereich, der Optionen enthält, die Sie an die Unterstützung des Hilfesystems übergeben wollen. Die Option "eclipsehome" ist in der Regel erforderlich.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" }; 
  3. Erstellen Sie in Ihrer Anwendung ein Exemplar der Klasse für die Hilfe, indem Sie die Optionen übergeben. Dieses Objekt sollte bis zum Ende Ihrer Anwendung beibehalten werden.
    Help helpSystem = new Help(options); 
  4. So starten Sie das Hilfesystem:
    helpSystem.start(); 
  5. So rufen Sie bei Bedarf die Hilfe auf:
    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");
  6. 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.
  7. Am Ende der Anwendung zum Schließen des Hilfesystems:

    helpSystem.shutdown(); 

Aufrufen der Hilfe aus der Befehlszeile

Die Klasse "org.eclipse.help.standalone.Help" enthält eine Methode "main", mit der Sie das Standalonehilfesystem über eine Befehlszeile aufrufen können. Die Syntax der Argumente der Befehlszeile lautet wie folgt:

-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]

Eine einfache Möglichkeit, die Hilfe anzuzeigen, besteht im Aufrufen von

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp

(aus dem Verzeichnis "d:\myApp\eclipse"). Zum Anzeigen einer bestimmten TOC-Datei oder zum Verwenden eines Abschnitts

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm

Die oben angegebenen Aufrufe zum Anzeigen der Hilfe bewirken den Start des Hilfesystems, das Anzeigen der Hilfe sowie ihre fortlaufende Aktivierung, damit der Benutzer auch nach Ausführung des Befehls weiter in der Hilfe suchen kann. Den Lebenszyklus des Hilfesystems steuern Sie mit Start- und Beendigungsbefehlen, die Sie zusätzlich zum Befehl "displayHelp" verwenden. Beispielsweise können Sie

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Help -command start

[Optional] Minimalgruppe von Plug-ins installieren

Die Standalonehilfefunktion benötigt nicht das gesamte Paket der Eclipse-Plattform. Sie kann mit den folgenden Plug-ins ausgeführt werden (diese befinden sich im Verzeichnis  "eclipse\plugins directory"):

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

Auf Windows und Linux sind die folgenden Plug-ins und Fragmente zusätzlich zu der Minimalkonfiguration erforderlich, um eine solide Browserunterstützung sicherzustellen (ein SWT-eingebetteter Internet Explorer auf Windows und Mozilla auf Linux oder ein selbstständiger Systembrowser auf Windows).

org.eclipse.core.expressions
org.eclipse.help.ui
org.eclipse.jface
org.eclipse.swt
org.eclipse.swt.win32 or org.eclipse.swt.gtk
org.eclipse.ui
org.eclipse.ui.workbench

Einige Plug-ins für Dokumentationsgruppen können Abhängigkeiten zu anderen Plug-ins haben, normalerweise durch Angabe der erforderlichen Plug-in in ihrer plugin.xml. Die abhängigen Plug-ins müssen auch in dem Infocenter installiert sein. Weiterhin erfordern Plug-ins, die für frühere Versionen von Eclipse als 3.0 entwickelt wurden, ausdrücklich, dass ein org.eclipse.core.runtime.compatibility Plug-in vorhanden ist, damit sie funktionieren.

Weitere Informationen über die Anpassung des Hilfesystems finden Sie unter Benutzervorgaben für das Hilfesystem.

org.eclipse.help.base Benutzervorgaben