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/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 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 Befehlszeilenparameter lautet:

-command start | shutdown |
[-eclipsehome eclipse-installationspfad] [-host
host_des_hilfeservers] [-port
port_des_hilfeservers] [-servertimeout zeitlimit] [-noexec]
[plattformoptionen]
[-vmargs java-vm-argumente]

Zum Starten eines Infocenters auf Port 8081 setzen Sie einen Startbefehl ab, indem Sie Folgendes ausführen:

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.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_2.1.0\help.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

Infocenter verwenden

Starten Sie den Webserver. Rufen Sie in einem Webbrowser den Pfad "help" für die Webanwendung auf, die an dem beim Starten des Infocenters angegebenen Port ausgeführt wird.  Auf der Maschine, auf der das 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. So gehen Sie zu diesem Zweck vor:

  1. Vergewissern Sie sich, dass der Klassenpfad Ihrer Anwendung die Angabe d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar enthält. 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 Klasse für die Hilfe, indem Sie die Optionen übergeben.
    Infocenter infocenter = new Help(options); 
  4. So starten Sie das Hilfesystem:
    helpSystem.start();
  5. So beenden Sie das 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 http://internalserver:8081/help
ProxyPassReverse /myproduct http://internalserver:8081/help
zur Datei "conf/httpd.conf" des Apache-Servers, auf dem die Website "mycompany" ausgeführt wird, kann dies erreicht werden.

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

Copyright IBM Corporation und Andere 2000, 2003.