Installation du système d'aide comme centre de documentation

Vous pouvez autoriser vos utilisateurs à accéder au système d'aide via Internet ou via un intranet en installant le centre de documentation et les plug-in de documentation sur un serveur. Les clients visualisent l'aide en naviguant jusqu'à une URL et le système d'aide s'affiche dans leur navigateur Web. Le système d'aide du centre de documentation peut être utilisé en local ou à distance pour les applications client et les applications Web. Tous les dispositifs du système d'aide, à l'exception des info-incrustations et de l'aide active, sont pris en charge.

Le système d'aide du centre de documentation permet de transmettre un certain nombre d'options qui peuvent servir à personnaliser différents aspects du centre de documentation. Les options suivantes sont prises en charge :

Installation/Mise en forme

Cette procédure est destinée à l'intégrateur du système d'aide et ne prétend pas aborder tous les scénarios possibles. On suppose que la documentation est intégralement livrée sous forme de plug-in Eclipse et qu'en général vous connaissez le système d'aide Eclipse.

  1. Téléchargez le pilote binaire de l'environnement d'exécution de la plateforme Eclipse depuis le site www.eclipse.org.
  2. Installez (dézippez) le pilote dans le répertoire, d:\monApp.Le sous-répertoire eclipse d:\monApp\eclipse est créé ; il contient le code requis pour la plateforme Eclipse (qui inclut le système d'aide).

Démarrage ou arrêt du centre de documentation à partir de la ligne de commande

La classe org.eclipse.help.standalone.Infocenter possède une méthode main que vous pouvez utiliser pour lancer le centre de documentation à partir d'une ligne de commande. La syntaxe des arguments de ligne de commande est la suivante :

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-host helpServerHost] [-port helpServerPort] [-servertimeout timeout] [-noexec] [platform options] [-vmargs JavaVMarguments]

Pour lancer un centre de documentation sur le port 8081, lancez une commande de démarrage en exécutant

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

Pour arrêter le centre de documentation, lancez une commande d'arrêt en exécutant

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

Utilisation du centre de documentation

Démarrez le serveur Web. Pointez un navigateur Web vers le chemin de l'application Web "help" qui s'exécute sur un port spécifié lors du démarrage du centre de documentation.   Sur la machine où le centre de documentation est installé, ce chemin serait http://localhost:8081/help/.

Démarrage ou arrêt du centre de documentation à partir de Java

Lors de l'inclusion du centre de documentation dans une autre application, il peut être plus pratique de le lancer à l'aide des API Java qu'à l'aide de commandes système. Si c'est le cas, procédez comme suit :

  1. Vérifiez que d:\monApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar se trouve dans le chemin d'accès aux classes de votre application. La classe utilisée pour lancer et arrêter le centre de documentation est org.eclipse.help.standalone.Infocenter.
  2. Créez un tableau de chaînes contenant des options que vous souhaitez transmettre au centre de documentation. Généralement, les options eclipsehome et port sont nécessaires.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" }; 
  3. Dans votre application, créez une instance de la classe d'aide en transmettant les options.
    Infocenter infocenter = new Help(options); 
  4. Pour démarrer le système d'aide :
    helpSystem.start();
  5. Pour arrêter le centre de documentation :

    helpSystem.shutdown(); 

Rendre le centre de documentation disponible sur le Web

Eclipse contient un centre de documentation complet et ne nécessite pas l'exécution d'autres programmes serveur. Toutefois, dans un environnement non sécurisé tel qu'Internet, il est recommandé de ne pas permettre aux clients d'accéder directement au centre de documentation, mais par le biais d'un serveur HTTP ou d'un serveur d'applications. La plupart des serveurs contiennent des modules ou des servlets permettant de déléguer certaines requêtes à d'autres ressources Web. Par exemple, il est possible de configurer un module proxy d'un serveur HTTP Apache de façon à rediriger les requêtes adressées à http://mycompany.com/myproduct/infocenter vers http://internalserver:8081/help qui exécute un centre de documentation. Pour ce faire, ajoutez les lignes

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct http://internalserver:8081/help
ProxyPassReverse /myproduct http://internalserver:8081/help
au fichier conf/httpd.conf du serveur Apache qui exécute le site Web mycompany.

[Facultatif] Installation d'un ensemble minimal de plug-in

Le centre de documentation ne nécessite pas l'intégralité du package de la plateforme Eclipse. Il est possible d'exécuter le centre de documentation avec les plug-in suivants (situés dans le répertoire  eclipse\plugins) :

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

En plus de ces plug-in, en fonction de l'architecture du système d'exploitation ou de la machine, vous pouvez avoir besoin d'installer les fragments correspondants aux plug-in ci-dessus (lorsqu'ils existent). Par exemple, sous Windows, vous devez ajouter les fragments suivants (également situés dans le répertoire eclipse\plugins) :

org.eclipse.core.resources.win32
org.eclipse.update.core.win32

Copyright IBM Corporation and others 2000, 2003.