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-ins 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 plate-forme 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 plate-forme 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] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-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.base_3.1.0.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.base_3.1.0.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 est 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:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar est sur le chemin de classe 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/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

au fichier conf/httpd.conf du serveur Apache qui exécute le site Web mycompany.

Certaines versions du serveur Apache HTTP peuvent contenir une instruction AddDefaultCharset activée dans le fichier de configuration. Supprimez l'instruction ou remplacez-la par

AddDefaultCharset Off

pour que les navigateurs affichent les documents à l'aide de l'ensemble de caractères approprié.

Exécution de plusieurs instances du centre de documentation

Vous pouvez exécuter plusieurs instances du centre de documentation sur une machine à partir d'une installation. Chaque instance démarrée doit utiliser son propre port et être associée à un espace de travail : vous devez donc spécifier les options -port et -data. Les instances peuvent afficher la documentation à partir d'ensembles de plug-ins différents, en indiquant une configuration de plate-forme valide avec l'option -configuration.

Si vous n'utilisez pas l'option -configuration, que le répertoire de configuration est partagé par plusieurs instances du centre de documentation et que plusieurs ensembles d'environnements locaux se chevauchent, assurez-vous que tous les index de recherche sont créés par une instance du centre de documentation avant de démarrer une autre instance. Les index sont sauvegardés dans le répertoire de configuration et les droits d'accès en écriture ne sont pas synchronisés entre les processus du centre de documentation.

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

Le centre de documentation ne nécessite pas l'intégralité du package de la plate-forme Eclipse. Il est possible d'exécuter le centre de documentation avec les plug-ins suivants (situés dans le répertoire  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

Certains plug-ins de documentation peuvent avoir des dépendances dans d'autres plug-ins, généralement en spécifiant les plug-ins demandés dans leur plugin.xml. Les plug-ins dépendants doivent également être installés dans l'infocentre. De plus, les plug-ins conçus pour les versions d'Eclipse antérieures à la version 3.0 nécessitent implicitement un plug-in org.eclipse.core.runtime.compatibility.

Les plug-ins de l'infocentre peuvent être mis à jour sans redémarrer l'infocentre, en utilisant les commandes expliquées dans le sujet Mise à jour d'un infocentre en fonctionnement depuis la ligne de commande. Pour utiliser cette fonctionnalité, l'ensemble minimum de plug-ins doit comprendre le plug-in org.eclipse.update.core.

Consultez la rubrique Préférences du système d'aide pour plus d'informations sur la personnalisation du système d'aide.