Skapa en kommandolänk

Om du vill lägga till kommandolänkar i dokumentationen måste du först deklarera användning av den nödvändiga JavaScript-koden. JavaScriptet för den aktiva hjälpen finns i insticksprogrammet org.eclipse.help.  Du anropar det med hjälpsystemets teknik för korsreferenser i insticksprogram. Den här skriptreferensen ska placeras i avsnittet HEAD i HTML-koden:

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

Du kan nu anropa funktionen executeCommand i dokumentationens innehåll. Exempel:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Öppna dialogrutan Om</a>

Parametern för funktionen executeCommand är ett serialiserat ParameterizedCommand. Metoden ParameterizedCommand.serialize() innehåller fullständig information om det här formatet.

I exemplet ovan visas vad som minst krävs för att bädda in ett kommando i en HTML-länk. I Eclipse-dokumentationen kompletteras det här med information om två extra funktioner. Först anges ett class-attribut som gör det möjligt att anpassa utseendet för länken via CSS. Sedan anges ett bildmärkord före länktexten. Bilden används till att särskilja kommandolänkar från vanliga länkar till andra HTML-sidor. När det första exemplet kompletteras med de här två extra funktionerna ser det ut på följande sett:

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

I exemplen ovan krävs inga parametrar för Om-dialogrutekommandot så serialiseringen består bara av kommando-ID:t: org.eclipse.ui.help.aboutAction. Nedan följer ett till exempel på ett kommando med en parameter. Lägg märke till att kommando-ID:t följs av parameter-ID:t och -värdet inom parentes:

<a href='javascript:executeCommand(
	"org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'>
	Visa en inställningssida</a>

I ännu ett exempel visas att det går att använda flera parametrar. De avgränsas med komma och ordningsföljden för parametrarna har ingen betydelse.

<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)")'>
	Öppna en meddelandedialogruta</a>