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:
-nl fr_FR
übergeben, kann die Hilfefunktion in französischer Sprache anstelle einer Sprache gestartet werden, die durch die Ländereinstellung der Maschine angegeben ist. String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
Help helpSystem = new Help(options);
helpSystem.start();
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");
So beenden Sie das Hilfesystem, wenn Ihre Anwendung beendet wird:
helpSystem.shutdown();
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 Befehlszeilenparameter lautet:
-command start | shutdown |
(displayHelp [href]) [-eclipsehome
eclipse-installationspfad]
[-host
host_des_hilfeservers] [-port port_des_hilfeservers]
[-servertimeout zeitlimit]
[plattformoptionen] [-vmargs
java-vm-argumente]
Mit der folgenden Syntax können Sie die Hilfe auf einfache Weise aufrufen:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar org.eclipse.help.standalone.Help -command displayHelp
(aus dem Verzeichnis "d:\myApp\eclipse"). Zum Anzeigen einer spezifischen TOC-Datei oder eines Themas verwenden Sie die folgende Syntax:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.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önnten Sie Folgendes aufrufen:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar org.eclipse.help.standalone.Help -command start
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.apache.xerces
org.eclipse.core.boot
org.eclipse.core.resources
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.update.core
Neben diesen Plug-ins müssen Sie - abhängig vom Betriebssystem oder der Maschinenarchitektur - möglicherweise auch die entsprechenden Fragmente für diese Plug-ins (sofern vorhanden) installieren.
Unter Windows müssen Sie beispielsweise die folgenden Fragmente hinzufügen
(sie befinden sich ebenfalls im Verzeichnis "eclipse\plugins"):
org.eclipse.core.resources.win32
org.eclipse.update.core.win32
Unter Windows haben Sie die Möglichkeit, einen anderen Browser für die Hilfe (einen in SWT eingebetteten Internet Explorer) bereitzustellen, indem Sie die folgenden Plug-ins und Fragmente zusätzlich zur Minimalkonfiguration hinzufügen:
org.eclipse.help.ui.win32
org.eclipse.help.ui
org.eclipse.jface.text
org.eclipse.jface
org.eclipse.search
org.eclipse.swt.win32
org.eclipse.swt
org.eclipse.text
org.eclipse.ui.editors
org.eclipse.ui.views
org.eclipse.ui.win32_2.1.0
org.eclipse.ui.workbench.texteditor
org.eclipse.ui.workbench
org.eclipse.ui