Sie können Ihren Benutzern den Zugriff auf die Hilfefunktion über das Internet oder ein Intranet ermöglichen, indem Sie Plug-ins für ein Infocenter und die Dokumentation auf einem Server installieren. Clients rufen die Hilfe auf, indem sie zu einer URL navigieren. Die Hilfefunktion wird dann in deren Webbrowser angezeigt. Die Hilfefunktion des Infocenters kann sowohl für Clientanwendungen als auch für Webanwendungen verwendet werden, wobei auf beide Hilfefunktionen fern zugegriffen werden kann. Mit Ausnahme der Kontexthilfe, der aktiven Hilfe, der Befehlsunterstützung und der Sicht "Hilfe" werden alle Features der Hilfefunktion unterstützt.
An die Hilfefunktion des Infocenters können eine Reihe von Optionen übergeben werden, mit denen unterschiedliche Aspekte des Infocenters angepasst werden können. Die folgenden Optionen werden unterstützt:
osgi.instance.area
oder
osgi.instance.area.default
überschrieben wird.
-nl en -locales de en es fr it ja ko pt_BR zh_CN zh_TW
dazu, dass das Infocenter mit 10 Ländereinstellungen ausgeführt wird.Alle anderen Ländereinstellungen erhalten den Inhalt aus der Ländereinstellung en
.-vmargs -Xmx256M
wird beispielsweise der für das Infocenter verfügbare Speicher heraufgesetzt und die Verwendung einer größeren Büchersammlung ermöglicht.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.
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).
Die Klasse org.eclipse.help.standalone.Infocenter
enthält eine
Methode main
, mit der Sie das Infocenter über eine Befehlszeile
starten können. Die Syntax der Argumente der Befehlszeile lautet wie folgt:
-command start | shutdown | [-eclipsehome eclipse-installationspfad] [-data exemplarbereich] [-host hilfe-server-host] [-locales liste_der_ländereinstellungen] [-port hilfe-server-port] [-dir rtl] [-noexec] [plattformoptionen] [-vmargs java-vm-argumente]
Um ein Infocenter an Port 8081 zu starten, setzen Sie einen Befehl start
ab, indem Sie Folgendes ausführen:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081
Zum Beenden des Infocenters setzen Sie einen Befehl shutdown
ab, indem Sie Folgendes ausführen:
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse
Starten Sie das Infocenter anhand der obigen Anweisungen. Rufen Sie in einem Web-Browser die Webanwendung
"/help" auf, die an dem Port ausgeführt wird, den Sie beim Starten des Infocenters angegeben haben (z. B. 8081). Ausgehend von der Maschine, auf der das Infocenter installiert ist, wäre dies beispielsweise http://localhost:8081/help/
.
Wenn das Infocenter als Bestandteil in einer Anwendung enthalten ist, kann es komfortabler sein, es nicht mit Systembefehlen, sondern unter Verwendung von Java-API-Aufrufen zu starten und zu stoppen. So gehen Sie in diesem Fall vor:
d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar
im Klassenpfad Ihrer Anwendung enthalten ist. Die Klasse, mit der Sie das Infocenter starten und beenden, heißt org.eclipse.help.standalone.Infocenter
.
String
, in dem die Optionen enthalten sind, die Sie an das Infocenter übergeben wollen. Normalerweise werden die Optionen eclipsehome
und
port
benötigt.String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
Help
, indem Sie die Optionen übergeben.Infocenter infocenter = new Help(options);
helpSystem.start();
helpSystem.shutdown();
Eclipse enthält ein komplettes Infocenter und benötigt zur
Ausführung keine weitere Serversoftware. In einer ungesicherten Umgebung wie dem Internet ist es jedoch nicht zu empfehlen, einen direkten Zugriff durch die Clients zuzulassen, sondern das Infocenter stattdessen über einen HTTP-Server oder einen Anwendungsserver zur Verfügung zu stellen. Die meisten Server werden mit Modulen oder Servlets für die
Delegierung bestimmter Anforderungen an andere Webressourcen
ausgeliefert.
Beispielsweise könnte ein Proxymodul von Apache HTTP Server
konfiguriert werden, das Anforderungen, die an
http://mycompany.com/myproduct/infocenter
gesendet werden, an
http://internalserver:8081/help
weiterleitet, wo das
Infocenter ausgeführt wird. Durch das Hinzufügen der Zeilen
LoadModule proxy_module modules/ApacheModuleProxy.dll ProxyPass /myproduct/infocenter http://internalserver:8081/help ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help
zur Datei conf/httpd.conf
des Apache-Servers, auf dem die
Website "mycompany" ausgeführt wird, kann dies erreicht werden.
Einige Versionen von Apache-HTTP-Server enthalten möglicherweise die aktivierte Anweisung "AddDefaultCharset" in der Konfigurationsdatei. Entfernen Sie die Anweisung oder ersetzen Sie sie durch
AddDefaultCharset Off,
damit die Browser Dokumente mit dem korrekten Zeichensatz anzeigen.
Es können mehrere Exemplare eines Infocenters auf einem System von einer Installation ausgeführt werden. Jedes gestartete Exemplar muss seinen eigenen Port verwenden und über einen Arbeitsbereich verfügen, daher müssen die Optionen -port
und -data
angegeben werden. Die Exemplare können Dokumentation aus verschiedenen Plug-in-Gruppen bereitstellen, indem mit der Option -configuration
eine gültige Plattformkonfiguration bereitgestellt wird.
Falls die Option -configuration
nicht verwendet wird und das Konfigurationsverzeichnis gemeinsam von mehreren Infocenterexemplaren mit einer überlappenden Gruppe von Ländereinstellungen genutzt wird, muss sichergestellt werden, dass alle Suchindizes von einem Infocenterexemplar erstellt werden, bevor ein anderes Exemplar gestartet wird. Indizes werden im Konfigurationsverzeichnis gespeichert, und der Schreibzugriff ist nicht für Infocenterexemplare synchronisiert.
Die Unterstützung von Filtern ist im Modus für das Infocenter inaktiviert, weshalb der gesamte Inhalt einschließlich des gefilterten Inhalts sichtbar ist. Falls Sie Ihre Dokumentation sowohl im Modus für die Workbench als auch im Modus für das Infocenter bereitstellen wollen, sollten Sie Filter verwenden, die auch dann sinnvoll sind, wenn die Filterung inaktiviert ist.
Das Infocenter benötigt nicht das gesamte Paket der Eclipse-Plattform. Es kann mit den folgenden Plug-ins ausgeführt werden (diese befinden sich im Verzeichnis
eclipse\plugins
):
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
Einige Plug-ins für Dokumentationsgruppen können Abhängigkeiten zu anderen Plug-ins haben, normalerweise durch Angabe der erforderlichen Plug-in in ihrem Produktpaketmanifest. Die abhängigen Plug-ins müssen ebenfalls im Infocenter installiert sein.
Infocenter-Plug-ins können aktualisiert werden, ohne das Infocenter neu zu starten. Dies geschieht unter Verwendung der im Thema Aktives Infocenter über die Befehlszeile aktualisieren erläuterten Befehle. Um diese Funktionalität zu nutzen, muss die Minimalgruppe der Plug-ins auch das Plug-in org.eclipse.update.core
enthalten.
Weitere Informationen zur Anpassung der Hilfefunktion finden Sie im Thema Produkt anpassen.