コマンド・リンクのオーサリング

コマンド・リンクをドキュメンテーションに組み込むには、まず JavaScript コードのサポートの使用を宣言する必要があります。ライブ・ヘルプ JavaScript は org.eclipse.help プラグインに配置されています。  ヘルプ・システムの プラグイン間参照技法を使用してこれを参照します。このスクリプト参照は、ユーザーの HTML の HEAD セクションに配置する必要があります。

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

ドキュメンテーションの本文で、executeCommand 関数を呼び出します。以下に例を示します。

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

executeCommand 関数のパラメーターは、シリアライズされた ParameterizedCommand です。このフォーマットの完全な詳細は、 ParameterizedCommand.serialize() メソッドを参照してください。

上記の例は、HTML リンクにコマンドを埋め込むために最低限必要なものを示しています。 Eclipse 文書は、2 つの追加情報でこれを補足します。まず、class 属性が指定され、CSS 経由でリンクの外観を調整できるようにします。次に、image タグをリンク・テキストの前に組み込みます。 image は、コマンド・リンクを他の HTML ページへの通常のリンクと区別する役割を果たします。これら 2 つの追加機能を最初の例に補足すると、次のようになります。

<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>

上の例で、「製品情報」ダイアログ・コマンドはパラメーターを必要としません。従って、シリアライゼーションは、単にそのコマンドの ID org.eclipse.ui.help.aboutAction になります。以下の別の例は、パラメーターを持つコマンドを表示しています。コマンド ID のあとにはパラメーター ID が続き、値が括弧に入っていることに注意してください。

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

以下に、複数のパラメーターがある別の例を示します。パラメーターはコンマで区切られていて、その順序は重要ではありません。

<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>