Befehlslink verfassen

Um Links zu Befehlen in Ihre Dokumentation aufzunehmen, müssen Sie zunächst die Verwendung des unterstützenden JavaScript-Codes deklarieren. Das JavaScript für die aktive Hilfe befindet sich im Plug-in org.eclipse.help. Zum Verweis auf dieses Plug-in verwenden Sie die Hilfefunktionsmethode für Plug-in-Querverweise. Diesen Scriptverweis sollten Sie in den Abschnitt HEAD der HTML-Datei stellen:

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

Im Hauptteil der Dokumentation können Sie dann die Funktion executeCommand aufrufen. Beispiel:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Open the About dialog</a>

Der Parameter für die Funktion executeCommand ist ein serialisierter Befehl des Typs ParameterizedCommand. Vollständige Details zu diesem Format finden Sie in den Angaben über die Methode ParameterizedCommand.serialize().

Das obige Beispiel zeigt die absoluten Mindestangaben, die für die Einbettung eines Befehls in einem HTML-Link erforderlich sind. Die Eclipse-Dokumentation ergänzt dies durch zwei weitere Einzelinformationen. Zunächst wird ein Attribut class angegeben, mit dem das Aussehen des Links über CSS angepasst werden kann. Zweitens wird vor dem Linktext ein Image-Tag eingefügt. Das Image dient dazu, Befehlslinks von normalen Links in anderen HTML-Seiten zu unterscheiden. Nach der Ergänzung des Ausgangsbeispiels durch diese beiden zusätzlichen Funktionen ergibt sich Folgendes:

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

In den vorstehenden Beispielen erfordert der Befehl für den Dialog "About" keine Parameter. Die Serialisierung besteht daher im Grunde in seiner Befehls-ID: org.eclipse.ui.help.aboutAction. Das folgende Beispiel zeigt einen Befehl mit einem Parameter. Sie können feststellen, dass nach der Befehls-ID die Parameter-ID und der Parameterwert in runden Klammern angegeben sind:

<a href='javascript:executeCommand(
	"org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'>
	Show a preference page</a>

Ein weiteres Beispiel macht deutlich, dass mehrere Parameter möglich sind. Sie werden durch Kommata voneinander getrennt. Die Reihenfolge der Parameter ist nicht von Bedeutung.

<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)")'>
	Open a message dialog</a>