Redakční práce s odkazem příkazu

Chcete-li do vaší dokumentace zahrnout odkazy příkazů, musíte nejdříve deklarovat použití podpůrného kódu JavaScript. Aktuální skript JavaScript je umístěn v modulu plug-in org.eclipse.help.  Můžete na něj odkazovat pomocí techniky křížového odkazování modulů plug-in systému nápovědy. Tento odkaz na skript by měl být umístěn v sekci HEAD vašeho HTML:

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

V těle vaší dokumentace nyní můžete vyvolat funkci executeCommand. Zde je příklad:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Otevřít dialogové okno O produktu</a>

Parametr pro funkci executeCommand je serializovaný ParameterizedCommand. Další podrobnosti o tomto formátu viz metoda ParameterizedCommand.serialize().

Výše uvedený příklad zobrazuje pouhé minimum nezbytné k vložení příkazu do odkazu HTML. Dokumentace Eclipse ho doplňuje o dvě další informace. Zaprvé, je zadán atribut class, který umožňuje vyladění vzhledu odkazu prostřednictvím CSS. Zadruhé, před textem odkazu je zahrnuta značka obrazu. Obraz slouží k rozlišení odkazů příkazu od běžných odkazů na jiné stránky HTML. Po doplnění těchto dvou funkcí bude náš počáteční příklad vypadat takto:

<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.png">
Otevřít dialogové okno O produktu</a>

Ve výše uvedených příkladech nevyžaduje příkaz dialogového okna O produktu žádné parametry, takže serializace je pouhým ID příkazu: org.eclipse.ui.help.aboutAction. Dále je uveden jiný příklad s ukázkou příkazu s parametrem. Povšimněte si, že ID příkazu je následováno ID parametru a hodnotou v závorkách:

<a href='javascript:executeCommand(
	"org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'>
	Zobrazit stránku předvoleb</a>

Další příklad ukazuje, že je možných rovněž více parametrů. Jsou odděleny čárkami a jejich pořadí není důležité.

<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)")'>
	Otevřít dialogové okno se zprávou</a>