Installation du système d'aide autonome

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.

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 l'application de lancement est en Java, 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 plateforme Eclipse 2.0 depuis le site www.eclipse.org.
  2. Installez (dézippez) le pilote dans le répertoire de l'application (par exemple, d:\monApp). Le sous-répertoire eclipse d:\monApp\eclipse est créé ; il contient le code requis pour la plateforme Eclipse (qui inclut le système d'aide).

Appel des classes d'aide

  1. Vérifiez que d:\monApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar se trouve dans le chemin d'accès aux classes de votre application. La classe utilisée pour démarrer, lancer et arrêter le système d'aide est org.eclipse.help.standalone.Help.
  2. Dans votre application, créez une instance de la classe d'aide en transmettant le répertoire des plug-in. Cet objet doit être conservé jusqu'à la fin de votre application.
    Help helpSystem = new Help("d:\\monApp\\eclipse\\plugins"); 
  3. Pour démarrer le système d'aide :
    helpSystem.start(); 

    A la fin de votre application, pour arrêter le système d'aide :

    helpSystem.shutdown(); 
  4. Pour appeler l'aide lorsque cela est nécessaire :
    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");
  5. Pour lancer l'aide contextuelle, appelez helpSystem.displayContext(IDcontexte, x, y), ID contexte correspond à un ID contexte complet. Les coordonnées d'écran, x et y, ne sont pas utilisées.

Test de l'aide autonome

La classe org.eclipse.help.standalone.Help possède un programme principal que vous pouvez lancer pour voir comment l'aide autonome fonctionne. A partir de la ligne de commande, exécutez la commande suivante :

java -classpath d:\monApp\eclipse\plugins\org.eclipse.help_2.0.0\help.jar
org.eclipse.help.standalone.Help d:\monApp\eclipse\plugins
Copyright IBM Corp. and others 2000, 2002.