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és les bulles d'aide et l'aide contextuelle. 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.
String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" };
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] [-host helpServerHost] [-port helpServerPort] [-servertimeout timeout] [platform options] [-vmargs JavaVMarguments]
Un moyen simple d'afficher l'aide consiste à appeler
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.jar org.eclipse.help.standalone.Help -command displayHelp
depuis le répertoire d:\myApp\eclipse. Pour afficher un fichier TDM ou une rubrique spécifique, utilisez
java -classpath d:\myApp\eclipse\plugins\org.eclipse.help_2.1.0\help.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_2.1.0\help.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 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
Sous Windows, il est possible de fournir un navigateur d'aide différent (un navigateur Web Internet Explorer incorporé à SWT) en ajoutant les plug-in et les fragments suivants à la configuration minimale :
org.eclipse.help.ui.win32
org.eclipse.help.ui
org.eclipse.jface.text
org.eclipse.jface
org.eclipse.search
org.eclipse.swt.win32
org.eclipse.swt
org.eclipse.text
org.eclipse.ui.editors
org.eclipse.ui.views
org.eclipse.ui.win32_2.1.0
org.eclipse.ui.workbench.texteditor
org.eclipse.ui.workbench
org.eclipse.ui