Udarbejd et kommandolink

Hvis du vil inkludere kommandolink i dokumentationen, skal du først erklære brugen af den understøttende JavaScriptkode. Live hjælpe-JavaScript'et er placeret i plugin'en org.eclipse.help. Du refererer til det vha. hjælpens teknik til brug for plugin-krydsreference. Denne scriptreference skal placeres i afsnittet HEAD i HTML-filen:

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

I dokumentationsindholdet kan du nu starte funktionen executeCommand. Eksempel:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Åbn dialogboksen Om</a>

Parameteren til executeCommand-funktionen er en serialiseret kommando med parametre. Der er flere oplysninger om formatet under metoden ParameterizedCommand.serialize().

Eksemplet ovenfor viser det absolutte minimum, der kræves for at indbygge en kommando i et HTML-link. Eclipse-dokumentationen supplerer dette med to ekstre oplysninger. Først angives en klasseattribut for at tillade tuning af udseendet af linket via CSS. Derefter inkluderes en billedkode før linkteksten. Billedet skal adskille kommandolink fra almindelige link til andre HTML-sider. Når det oprindelige eksempel suppleres med disse to ekstra funktioner, ser det således ud:

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

I eksemplerne ovenfor kræver dialogbokskommandoen Om ikke nogen parametre, så serialiseringen er blot dens kommando-id: org.eclipse.ui.help.aboutAction. Herunder vises et eksempel med en parameter. Bemærk, at kommando-id'en efterfølges af parameter-id'en og værdien i parentes:

<a href='javascript:executeCommand(
	"org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'>
	Vis en indstillingsside</a>

Et andet eksempel viser, at flere parametre er mulige. De adskilles med komma, og deres rækkefølge er uden betydning.

<a href='javascript:executeCommand(
	"org.eclipse.ui.dialogs.openMessageDialog(imageType=3,buttonLabel2=Måske,title=Opinionsundersøgelse,message=Kan du lide kommandolink?,buttonLabel0=Ja,defaultIndex=0,buttonLabel1=Nej)")'>
	Åbn en meddelelsesdialogboks</a>