Eigenständige Hilfe

Wenn Sie eine Anwendung erstellen, die nicht auf den Eclipse-Rahmenbedingungen basiert, können Sie dennoch die Eclipse-Hilfefunktion verwenden. Ihre Anwendung kann die eigenständige Hilfefunktion packen und installieren, eine sehr kleine Version von Eclipse, aus der alle Komponenten bis auf die Hilfefunktion entfernt wurden. Dann kann Ihre Anwendung von seinem Hilfemenü oder von UI-Objekten aus API-Aufrufe starten, um den Hilfe-Browser aufzurufen. Die eigenständige Hilfefunktion verfügt über alle Funktionen derintegrierten Hilfefunktion mit Ausnahme der in die Workbench integrierte Kontexthilfe und der aktiven 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 eigenständige Hilfe us einer Systemshell, einem Shell-Script oder einer Desktopverknüpfung verwenden und Befehlszeilenoptionen bereitstellen, statt Java-APIs aufzurufen.

Die eigenständige Hilfefunktion ermöglicht die Übergabe einer Reihe von Optionen, mit denen unterschiedliche Aspekte der Hilfefunktion angepasst werden können. Die folgenden Optionen werden unterstützt:

Installation/Packen

Diese Schritte sind für den Hilfefunktionsintegrator 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 der Eclipse-Hilfefunktion vertraut sind.
  1. Laden Sie den Binärtreiber für die Eclipse-Plattformlaufzeit unter 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 die Hilfefunktion beinhaltet).

Hilfeklassen aus Java aufrufen

  1. Stellen Sie sicher, dass d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar im Klassenpfad enthalten ist. Hierbei steht [version] für die Version des verwendeten Plug-ins (z. B. org.eclipse.help.base_3.2.0.jar). Die zum Starten und Beenden der Hilfefunktion verwendete Klasse heißt org.eclipse.help.standalone.Help.
  2. Erstellen Sie einen Bereich von Objekten des Typs String, in dem die Optionen enthalten sind, die Sie an die Unterstützung der Hilfefunktion übergeben wollen. Normalerweise wird die Option eclipsehome benötigt.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
  3. Erstellen Sie in Ihrer Anwendung ein Exemplar der Klasse Help, indem Sie die Optionen übergeben. Dieses Objekt sollte bis zum Ende Ihrer Anwendung beibehalten werden.
    Help helpSystem = new Help(options);
  4. So starten Sie die Hilfefunktion:
    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 kontextbezogenen 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. So beenden Sie am Ende der Anwendung die Hilfefunktion:

    helpSystem.shutdown(); 

Hilfe über die Befehlszeile aufrufen

Die Klasse org.eclipse.help.standalone.Help enthält eine Methode "main", mit der Sie die eigenständige Hilfefunktion ü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_[version].jar org.eclipse.help.standalone.Help -command displayHelp

aus dem Verzeichnis "d:\myApp\eclipse". Hierbei steht version für die Version des Plug-ins. Zum Anzeigen einer bestimmten Inhaltsverzeichnisdatei oder zum Verwenden eines Abschnitts

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].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 der Hilfefunktion, 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 der Hilfefunktion 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_[version].jar org.eclipse.help.standalone.Help -command start

[Optional] Minimalform einer eigenständigen Hilfefunktion installieren

Die eigenständige Hilfe benötigt nicht das gesamte Paket der Eclipse-Plattform. Ihre Ausführung ist mit der Binärdatei für die RCP-Laufzeit und den folgenden Plug-ins, die zum Verzeichnis eclipse/plugins hinzugefügt werden müssen, möglich:

org.apache.lucene
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.ui
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.ui.forms

Hinweis: Sie müssen sicherstellen, dass die folgende Zeile in der Datei eclipse/configuration/config.ini enthalten ist:

osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start

Einige Plug-ins für Dokumentationsgruppen können Abhängigkeiten zu anderen Plug-ins haben, normalerweise durch Angabe von erforderlichen Plug-in in ihrem Manifest. Die abhängigen Plug-ins müssen ebenfalls installiert sein. Weiterhin ist es für Plug-ins, die für frühere Eclipse-Versionen als 3.0 entwickelt worden, erforderlich, dass das Plug-in org.eclipse.core.runtime.compatibility vorhanden ist.

Weitere Informationen zur Anpassung der Hilfefunktion finden Sie unter Produkt anpassen.