Forfatte en kommandolink

Hvis du vil inkludere kommandolinker i dokumentasjonen, må du først deklarere bruken av støttende JavaScript-kode. Du finner JavaScript for live hjelp i plugin-modulen org.eclipse.help. Du refererer til den ved hjelp av hjelpesystemets teknikker for referanser på tvers av plugin-moduler.Denne skriptreferansen bør plasseres i HEAD-seksjonen av HTML-kodingen:

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

Aktiver funksjonen executeCommand i dokumentasjonens hoveddel. Her er et eksempel:

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

Parameteren for funksjonen executeCommand er en serialisert ParameterizedCommand. Du finner nærmere opplysninger om dette formatet i forbindelse med metoden ParameterizedCommand.serialize().

Eksempelet ovenfor viser det som minst kreves for å innebygge en kommando i en HTML-link. Eclipse-dokumentasjonen har to ekstra informasjonsdeler til dette. Først oppgis et class-attributt for å tillate justering av linkens utseende via CSS. Deretter blir det inkludert en bildekode før linkteksten. Bildet skiller kommandolinker fra vanlige linker til andre HTML-sider. Hvis det første eksempelet får disse to ekstrafunksjonene i tillegg, ser det slik ut:

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

I eksemplene ovenfor krever ikke kommandoen for dialogboksen Om noen parametere, så serialiseringen er bare kommandoens ID: org.eclipse.ui.help.aboutAction. Nedenfor er et annet eksempel som viser en kommando med en parameter. Merk at kommando-IDen etterfølges av parameter-IDen og verdien i parenteser:

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

Et annet eksempel viser at det er mulig med flere parametere. De skilles med komma, og rekkefølgen på parameterne er ikke viktig.

<a href='javascript:executeCommand(
	"org.eclipse.ui.dialogs.openMessageDialog(imageType=3,buttonLabel2=Maybe,title=Opinion Poll,message=Liker du kommandolinkene?,buttonLabel0=Yes,defaultIndex=0,buttonLabel1=No)")'>
Åpne en meldingsdialog</a>