Autor de uma ligação de comando

Para incluir ligações de comando na documentação, primeiro é necessário declarar a utilização do código JavaScript de suporte. O JavaScript de ajuda activa encontra-se no plug-in org.eclipse.help.  Poderá remeter para o mesmo através da técnica referências cruzadas a plug-ins do sistema de ajuda.Esta referência de script deverá ser colocada na secção HEAD do HTML:

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

No corpo da documentação, pode invocar a função executeCommand. Eis um exemplo:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Abrir a caixa de diálogo Acerca de</a>

O parâmetro da função executeCommand é um ParameterizedCommand serializado. Para mais detalhes sobre este formato, consulte o método ParameterizedCommand.serialize().

O exemplo apresentado acima apresenta o mínimo essencial requerido para incorporar um comando numa ligação HTML. A documentação do Eclipse suplementa esta apresentação com duas partes adicionais de informação. Em primeiro lugar, é especificado o atributo class para permitir a optimização do aspecto da ligação através de CSS. Em segundo lugar, é incluído um identificador de imagem antes do texto de ligação. A imagem permite distinguir as ligações de comandos das ligações comuns para outras páginas HTML. Se suplementar o exemplo inicial com estas duas funções adicionais, este terá o seguinte aspecto:

<a class="command-link"
href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.png">
Abrir a caixa de diálogo Acerca de</a>

Nos exemplos acima, o comando da caixa de diálogo Acerca de não requer quaisquer parâmetros e, por conseguinte, a serialização é apenas o id de comando: org.eclipse.ui.help.aboutAction. Abaixo encontra-se outro exemplo que mostra um comando com um parâmetro. Repare que o id de comando é seguido pelo id e pelo valor de parâmetro entre parêntesis:

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

Um outro exemplo demonstra que é possível haver parâmetros múltiplos. Estes parâmetros estão separados por vírgulas e a sua ordem não é importante.

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