要在文档中包括命令链接,首先必须声明支持使用 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 文档对此示例补充了另外两方面的信息。首先,指定了 class 属性以允许通过 CSS 对链接的外观进行调整。其次,在链接文本前面包括了 image 标记。image 用来区分命令链接与其他 HTML 页面的普通链接。我们的初始示例在补充了这两个附加的功能部件后将如下所示:
<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>
在上述示例中,“关于”对话框命令不需要任何参数,因此仅仅将其命令标识序列化:org.eclipse.ui.help.aboutAction。以下示例显示了带有参数的命令。注意,在命令标识后面的括号中,指定了参数标识和值:
<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>