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 les plug-in de la documentation et du système d'aide autonome sur un serveur Web. L'application accède à la documentation en appelant une URL et le système d'aide est affiché 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. Toutes les fonctions exceptées les bulles d'aide et l'aide contextuelle sont prises en charge.

Installation/Mise en forme

Cette procédure est destinée à l'intégrateur du système d'aide et à l'administrateur Web 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. IE5.x ou 6.x ou Mozilla doit être installé sur les machines des utilisateurs finaux.
  1. Vérifiez qu'un serveur d'applications est installé sur la machine. Tomcat 3 et Tomcat 4 ont été testés.
  2. Téléchargez le pilote binaire de l'environnement d'exécution de la plateforme Eclipse 2.0 depuis le site www.eclipse.org.
  3. Installez (dézippez) le pilote dans le répertoire d:\eclipse.
  4. Enregistrez l'application de l'aide Eclipse qui se trouve dans d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0 auprès du serveur Web. Ne copiez pas ce répertoire ailleurs ; il doit rester dans l'arborescence d'installation d'Eclipse.

    Dans Tomcat, l'enregistrement s'effectue en ajoutant les lignes suivantes au fichier tomcat\conf\server.xml :

    <Context path="/help"  docBase="d:\eclipse\plugins\org.eclipse.help.webapp_2.0.0">
    </Context>

    Dans Tomcat 3, ajoutez ces lignes vers la fin du fichier, comme dernier élément de la section ContextManager. Dans Tomcat 4, ajoutez ces lignes comme dernier élément de la section Host.

  5. Installez l'un des correctifs ci-après, suivant le serveur utilisé.

Utilisation du centre de documentation

Démarrez le serveur Web. Pointez un navigateur Web vers le chemin de l'application Web. Sur la machine sur laquelle Tomcat est installé, il s'agit du chemin suivant : http://localhost:8080/help/.

Installation de la documentation personnalisée

La plateforme Eclipse est livrée avec sa propre documentation, contenue dans le plug-in org.eclipse.platform.doc.user. Par défaut, elle est disponible dans le centre de documentation. Pour que votre documentation soit affichée, créez-la sous forme de plug-in de documentation Eclipse.  Installez ces plug-in dans le répertoire d:\eclipse\plugins\. 

Copyright IBM Corp. and others 2000, 2002.