Vous pouvez utiliser le système d'aide Eclipse, même si vous créez une application ne reposant pas sur la structure Eclipse. Votre application peut mettre en forme et installer le système d'aide autonome, une version très limitée d'Eclipse dans laquelle tout a été supprimé excepté le système d'aide. Votre application peut alors effectuer des appels API depuis son menu Aide ou depuis des objets de l'interface graphique pour lancer le navigateur d'aide. Le système d'aide autonome possède toutes les fonctions du système d'aide intégré, excepté l'aide contextuelle intégrée au plan de travail, la vue de l'aide et l'aide active. Lorsqu'une application n'est pas basée Java, ou si l'aide doit être accessible lorsque l'application n'est pas en cours d'exécution, il est possible d'utiliser l'aide autonome à partir d'un shell du système, d'un script de shell ou d'un raccourci bureau et de fournir des options de ligne de commande au lieu d'appeler les API Java.
Le système d'aide autonome permet de transmettre un certain nombre d'options qui peuvent servir à personnaliser différents aspects du système d'aide. Les options suivantes sont prises en charge :
-nl fr_FR
lance le système d'aide en langue française au lieu de la langue spécifiée par l'environnement local de la machine.d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar
se trouve dans le chemin d'accès aux classes, où [version]
correspond à la version du plug-in utilisé (par exemple, org.eclipse.help.base_3.2.0.jar
). La classe utilisée pour démarrer, lancer et arrêter le système d'aide est org.eclipse.help.standalone.Help
.
String
contenant les options que vous souhaitez transmettre au support du système d'aide. En règle générale, l'option eclipsehome
est nécessaire.
String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
aide
en transmettant les options.
Cet objet doit être conservé jusqu'à la fin de votre application.Help helpSystem = new Help(options);
helpSystem.start();
helpSystem.displayHelp();
Vous pouvez également appeler l'aide sur certains des principaux fichiers ou rubriques du sommaire :
helpSystem.displayHelp("/com.mycompany.mytool.doc/toc.xml"); helpSystem.displayHelp("/com.mycompany.mytool.doc/tasks/task1.htm");
A la fin de votre application, pour arrêter le système d'aide :
helpSystem.shutdown();
La classe org.eclipse.help.standalone.Help
possède une méthode main que vous pouvez utiliser pour lancer l'aide autonome à partir d'une ligne de commande. La syntaxe des arguments de ligne de commande est la suivante :
-command start | shutdown | (displayHelp [href]) [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-port helpServerPort] [-dir rtl] [platform options] [-vmargs JavaVMarguments]
Un moyen simple d'afficher l'aide consiste à appeler
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp
depuis le répertoire d:\myApp\eclipse, où version
correspond à la version du plug-in. Pour afficher un fichier TDM ou une rubrique spécifique, utilisez
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command displayHelp /com.mycompany.mytool.doc/tasks/task1.htm
Les appels ci-dessus pour afficher l'aide entraînent le démarrage et l'affichage de l'aide et permettent son exécution continue de façon à ce qu'un utilisateur puisse continuer à parcourir l'aide une fois que la commande est exécutée. Pour contrôler le cycle de vie du système d'aide, utilisez les commandes start et shutdown en plus de la commande displayHelp. Par exemple, vous pouvez appeler
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_[version].jar org.eclipse.help.standalone.Help -command start
L'aide autonome ne nécessite pas l'intégralité du package de la plateforme Eclipse.
Il est possible d'exécuter l'aide autonome avec le fichier binaire de l'environnement d'exécution RCP (avec les plug-ins suivants ajoutés au répertoire eclipse/plugins
) :
org.apache.lucene
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.ui
org.eclipse.help.webapp
org.eclipse.tomcat
org.eclipse.ui.forms
Remarque : vous devez vous assurer que la ligne suivante figure dans le fichier eclipse/configuration/config.ini
:
osgi.bundles=org.eclipse.equinox.common@2:start, org.eclipse.update.configurator@3:start, org.eclipse.core.runtime@start
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. Les plug-ins dépendants doivent également être installés. De plus, les plug-ins conçus pour les versions antérieures à la version 3.0 nécessitent implicitement un plug-in
org.eclipse.core.runtime.compatibility
pour fonctionner.
Pour plus d'informations sur la personnalisation du système d'aide, consultez la rubrique Personnalisation du produit.