Hilfesystem als Infocenter installieren

Sie können Ihren Benutzer den Zugriff auf das Hilfesystem über das Internet oder ein Intranet ermöglichen, indem Sie die Plug-ins für das Infocenter und die Dokumentation auf einem Server installieren. Clients rufen die Hilfe auf, indem sie zu einer URL navigieren. Das Hilfesystem wird dann in deren Webbrowser angezeigt. Das Infocenter-Hilfesystem kann sowohl für Clientanwendungen als auch für Webanwendungen verwendet werden, wobei auf beide Hilfesysteme fern zugegriffen werden kann. Mit Ausnahme von QuickInfos und aktiver Hilfe werden alle Komponenten des Hilfesystems unterstützt.

An das Infocenter-Hilfesystem können eine Reihe von Optionen übergeben werden, mit denen unterschiedliche Aspekte des Infocenters angepasst werden können. Die folgenden Optionen werden unterstützt:

Installation/Packen

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 in einem Verzeichnis, z.B. d:\myApp. Hierdurch wird ein Unterverzeichnis "eclipse" (d:\myApp\eclipse) erstellt, das den für die Eclipse-Plattform erforderlichen Code (der das Hilfesystem enthält) enthält.

Infocenter über Befehlszeile starten oder stoppen

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 eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

Um einen Infocenter an Port 8081 zu starten, geben Sie einen Startbefehl aus, indem Sie

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 Beendigungsbefehl 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

Infocenter verwenden

Starten Sie den Webserver. Geben Sie einen Webbrowser für den Pfad "help" an, sodass eine Webanwendung an dem angegebenen Port ausgeführt wird, wenn Infocenter gestartet wird.  Wenn auf dem System Infocenter installiert ist, wäre dies http://localhost:8081/help/.

Infocenter über Java starten und stoppen

Wenn das Infocenter als Bestandteil in einer Anwendung enthalten ist, kann es komfortabler sein, es nicht mit Systembefehlen, sondern unter Verwendung von Java-APIs zu starten und zu stoppen. Wenn dies der Fall ist, folgen Sie den folgenden Schritten:

  1. Stellen Sie sicher, dass d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar auf Ihrem Anwendungsklassenpfad ist. Die Klasse, mit der Sie das Infocenter starten und beenden, ist "org.eclipse.help.standalone.Infocenter".
  2. Erstellen Sie einen Zeichenfolgenbereich, der Optionen enthält, die Sie an das Infocenter übergeben wollen. Die Optionen "eclipsehome" und "port" sind in der Regel erforderlich.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. Erstellen Sie in Ihrer Anwendung ein Exemplar der Hilfeklasse, indem Sie die Optionen weitergeben.
    Infocenter infocenter = new Help(options); 
  4. So starten Sie das Hilfesystem:
    helpSystem.start();
  5. Zum Schließen von Infocenter:

    helpSystem.shutdown(); 

Infocenter im Web verfügbar machen

Eclipse enthält ein komplettes Infocenter und benötigt zur Ausführung keine weitere Serversoftware. In ungesicherten Umgebungen wie beispielsweise dem Internet empfiehlt es sich jedoch, dass die Clients nicht direkt auf das Infocenter zugreifen, sondern das Infocenter über einen HTTP-Server oder einen Anwendungsserver zur Verfügung gestellt bekommen. 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.

Mehrere Exemplare von Infocenter ausführen

Es können mehrere Exemplare von Infocenter 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 -Port- und -Daten-Optionen angegeben werden. Die Exemplare können Dokumentation aus verschiedenen Plug-in-Gruppen bedienen, indem mit der Option -configuration eine gültige Plattformkonfiguration bereitgestellt wird.

Falls -configuration nicht verwendet wird und das Konfigurationsverzeichnis gemeinsam von mehreren Infocenter-Exemplaren mit einer überlappenden Gruppe von Ländereinstellungen genutzt wird, muss sichergestellt werden, dass alle Suchindizes von einem Infocenter-Exemplar erstellt werden, bevor ein anderes Exemplar gestartet wird. Indizes werden im Konfigurationsverzeichnis gespeichert und der Schreibzugriff ist nicht für Infocenter-Verarbeitungen synchronisiert.

[Optional] Minimalgruppe von Plug-ins installieren

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 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

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.

Infocenter-Plug-ins können aktualisiert werden, ohne das Infocenter neu zu starten. Dies geschieht unter Verwendung der im Thema Aktualisierung eines laufenden Infocenters über die Befehlszeile erläuterten Befehle. Um diese Funktionalität zu nutzen, muss die Minimalgruppe der Plug-ins das Plug-in org.eclipse.update.core enthalten.

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