Een opdrachtlink opstellen

Om opdrachtlinks in uw documentatie op te nemen moet u eerst het gebruik van de ondersteunende JavaScript-code declareren. Het live help-Java-script bevindt zich in de plugin org.eclipse.help. U verwijst hiernaar met behulp van de Help-systeemtechniek voor plugin(kruis)verwijzingen. De verwijzing naar het script moet worden geplaatst in de sectie HEAD van uw HTML:

<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js> </script>

Nu kunt u in het corpus van de documentatie de functie executeCommand aanroepen. Hier volgt een voorbeeld:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Dialoogvenster Info openen</a>

De parameter van de functie executeCommand is een geserialiseerde geparametriseerde opdracht. Zie de methode ParameterizedCommand.serialize() voor meer informatie over deze indeling.

In het bovenstaande voorbeeld ziet u hetgeen minimaal nodig is om een opdracht in een HTML-link op te nemen. De Eclipse-documentatie vult dit aan met twee extra stukken informatie. Ten eerste wordt het kenmerk class opgegeven zodat het uiterlijk van de link via CSS kan worden gewijzigd. Ten tweede wordt er een afbeeldingstag ingevoegd voor de tekst van de link. De afbeelding dient om opdrachtlinks te kunnen onderscheiden van standaardlinks naar andere HTML-pagina's. Als het oorspronkelijke voorbeeld is uitgebreid met deze twee extra features, ziet het er als volgt uit:

<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.png">
Dialoogvenster Info openen</a>

In de bovenstaande voorbeelden behoeft het dialoogvenster Info geen parameters. De serialisering is dus alleen het opdracht-ID: org.eclipse.ui.help.aboutAction. Hieronder vindt u een voorbeeld van een opdracht met een parameter.Het opdracht-ID wordt gevolgd door het ID en de waarde van de parameter tussen haakjes:

<a href='javascript:executeCommand(
	"org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'>
	Een voorkeurenpagina afbeelden</a>

Ten slotte krijgt u nog een voorbeeld met meerdere parameters. Ze zijn door middel van een komma van elkaar gescheiden. De volgorde van de parameters is niet belangrijk.

<a href='javascript:executeCommand(
	"org.eclipse.ui.dialogs.openMessageDialog(imageType=3,buttonLabel2=Misschien,title=Vraag,message=Werkt u graag met opdrachtlinks?,buttonLabel0=Ja,defaultIndex=0,buttonLabel1=Nee)")'>
	Een berichtvenster afbeelden</a>