Pour inclure des liens vers des commandes dans votre documentation, vous devez au préalable déclarer l'utilisation du code JavaScript. Le JavaScript d'aide se trouve dans le plug-in org.eclipse.help. Vous pouvez y faire référence à l'aide de la technique du système d'aide consistant en une référence croisée de plug-in. Cette référence de script doit être placée dans la section HEAD de votre document HTML :
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js> </script>
A présent, dans le corps de votre documentation, vous appelez la fonction executeCommand. Exemple :
<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'> Ouvre la boîte de dialogue A propos de</a>
Le paramètre de la fonction executeCommand est un élément ParameterizedCommand sérialisé. Voir la méthode ParameterizedCommand.serialize() pour de plus amples informations sur ce format.
L'exemple précédent illustre le minimum requis pour incorporer une commande dans un lien HTML. La documentation Eclipse ajoute ceci avec deux autres parties d'informations. Tout d'abord, un attribut class est spécifié pour permettre le réglage de l'apparence du lien via CSS. Ensuite, une balise image est incluse avant le texte du lien. L'image sert à distinguer les liens de commande des liens ordinaires vers d'autres pages HTML. l'ajout de notre exemple assorti de ces deux fonctions supplémentaires donne le résultat suivant :
<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'> <img src="PLUGINS_ROOT/org.eclipse.help/command_link.png"> Ouvre la boîte de dialogue A propos de</a>
Dans l'exemple ci-dessus, la commande A propos de ne requiert aucun paramètre. Par conséquent, la sérialisation consiste simplement en son ID de commande : org.eclipse.ui.help.aboutAction. Ci-dessous figure un autre exemple illustrant une commande avec un paramètre. Notez que l'ID de commande est suivi d'un ID de paramètre et de la valeur entre parenthèses :
<a href='javascript:executeCommand( "org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'> Afficher une page de préférences</a>
Un autre exemple démontre que plusieurs paramètres sont possibles. Ils sont séparés par des virgules et l'ordre des paramètres n'a pas d'importance.
<a href='javascript:executeCommand( "org.eclipse.ui.dialogs.openMessageDialog(imageType=3,buttonLabel2=Maybe,title=Opinion Poll,message=Do you like command links?,buttonLabel0=Yes,defaultIndex=0,buttonLabel1=No)")'> Ouvrir une boîte de dialogue</a>