Komentolinkin luonti

Voit sisällyttää komentolinkkejä dokumentaatioon esittelemällä ensin tukevan JavaScript-koodin käytön. Käytönaikaisen ohjeen JavaScript on org.eclipse.help-lisäosassa.  Siihen viitataan käyttämällä ohjejärjestelmän lisäosien ristiviittaus -tekniikkaa. Komentosarjaviittaus tulee sijoittaa HTML-tiedoston HEAD-osioon:

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

Dokumentaation sisällössä voit kutsua executeCommand-funktion. Esimerkki:

<a href='javascript:executeCommand("org.eclipse.ui.help.aboutAction")'>
Avaa Tietoja-valintaikkuna</a>

ExecuteCommand-funktion parametri on sarjamuodossa oleva ParameterizedCommand. Lisätietoja tästä muodosta on metodissa ParameterizedCommand.serialize().

Edellinen esimerkki kuvaa pelkistetysti vähimmäisedellytyksiä, jotka tulee täyttää komennon upottamiseksi HTML-linkkiin. Eclipse-dokumentaatiossa on aihetta koskevia lisätietoja. Ensin määritetään class-määrite, minkä ansiosta linkin ulkoasua voi muuttaa CSS-tyylimääritysten avulla. Seuraavaksi sisällytetään kuvatunniste ennen linkkitekstiä. Kuvan tarkoitus on erottaa komentolinkit tavallisista linkeistä muille HTML-sivuille. Kun alkuperäiseen esimerkkiin lisätään nämä kaksi tuoteominaisuutta, esimerkki näyttää seuraavanlaiselta:

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

Edellisten esimerkkien About-valintaikkunakomento ei edellytä parametreja, joten sen peräkkäistys on pelkästään sen komentotunnus: org.eclipse.ui.help.aboutAction. Seuraavan esimerkin komennossa on parametri. Huomaa, että komentotunnuksen perässä on parametrin tunnus ja arvo sulkeissa:

<a href='javascript:executeCommand(
	"org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.ui.preferencePages.Views)")'>
	Näytä oletusasetussivu</a>

Seuraava esimerkki osoittaa, että useiden parametrien käyttö on mahdollista. Ne on erotettu pilkuin, eikä niiden järjestys ole merkitsevä.

<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)")'>
	Avaa sanomavalintaikkuna</a>