Создание ссылки на команду

Перед добавлением ссылок на команды в документации следует объявить применение поддерживающего сценария JavaScript: Текст JavaScript активной справки содержится в модуле org.eclipse.help.   Для обращения к нему применяется методика перекрестных ссылок на модули, предусмотренная в справочной системе. Эту ссылку на сценарий следует разместить в разделе HEAD файла HTML:

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

Функция executeCommand вызывается из тела документации. например:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Открыть окно О программе</a>

Параметр функции executeCommand является сериализованной ParameterizedCommand. Подробные сведения о данном формате приведены в документации по методу ParameterizedCommand.serialize().

В приведенном выше примере показаны минимальные требования для вставки команды в ссылку HTML. В документации Eclipse предоставляется два дополнения к этой информации. Во-первых, задан атрибут class для предоставления возможности настройки внешнего вида ссылки с помощью CSS. Во-вторых, перед текстом ссылки включается тег изображения. Это изображение служит для того, чтобы можно было отличить ссылки на команды от обычных ссылок на другие HTML-страницы. Пример, дополненный этими двумя функциональными возможностями, будет выглядеть следующим образом:

<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.png">
Открыть окно О программе</a>

В приведенных выше примерах для команды About dialog не требуется никаких параметров, поэтому сериализуется только ИД команды: org.eclipse.ui.help.aboutAction. Ниже приведен пример команды с параметром. Обратите внимание, что за ИД команды следует ИД и значение параметра в круглых скобках:

<a href='javascript:executeCommand(
	"org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'>
	Показать страницу параметра</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)")'>
	Открыть окно сообщения</a>