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, l'aide de chacune étant accessible à distance. Toutes les fonctions du système d'aide à l'exception de l'aide contextuelle, l'aide active, la prise en charge des commandes et la vue de l'aide sont prises 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 :
osgi.instance.area
ou
osgi.instance.area.default
.-nl en -locales de en es fr it ja
ko pt_BR zh_CN zh_TW
, le centre de documentation s'exécutera dans 10 environnements locaux.
Tous les autres environnements locaux recevront du contenu de l'environnement local en
.
-vmargs -Xmx256M
augmente la quantité de mémoire disponible pour le centre de documentation et permet la prise en charge d'une série de manuels plus importante.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.
d:\myApp
. Ce dernier crée un sous-répertoire eclipse, d:\myApp\eclipse
qui contient le code requis pour la plateforme Eclipse (qui inclut le système d'aide).
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
Lancez le centre de documentation en suivant les instructions ci-dessus. Pointez un navigateur Web vers l'application Web "/help" qui s'exécute sur le port indiqué lors du démarrage du centre de documentation (par exemple, 8081). Sur la machine où le centre de documentation est installé, ce chemin est http://localhost:8081/help/
.
Lors de l'inclusion du centre de documentation dans une autre application, il peut être plus pratique de le lancer et de l'arrêter à l'aide des API Java qu'à l'aide de commandes système. Dans ce cas, procédez comme suit :
d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.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
.
String
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" };
aide
en transmettant les options.
Infocenter infocenter = new Help(options);
helpSystem.start();
helpSystem.shutdown();
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 n'est pas recommandé de 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é.
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 plateforme 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 instances du centre de documentation.
La prise en charge du filtrage est désactivée en mode centre de documentation, rendant ainsi visible tout contenu, y compris le contenu filtré. Si vous envisagez d'héberger votre documentation à la fois en mode plan de travail et centre de documentation, vous devez utiliser les filtres de manière cohérente même si le filtrage est désactivé.
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-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 manifeste de bundle. Les plug-ins dépendants doivent également être installés dans le centre de documentation.
Les plug-ins du centre de documentation peuvent être mis à jour sans redémarrer celui-ci, en utilisant les commandes présentées dans la rubrique Mise à jour d'un centre de documentation exécuté à partir de la ligne de commande. Pour utiliser cette fonctionnalité, l'ensemble minimum de plug-ins doit comprendre le plug-in org.eclipse.update.core
.
Pour plus d'informations sur la personnalisation du système d'aide, consultez la rubrique Personnalisation du produit.