Σύνταξη διασύνδεσης εντολής

Για να συμπεριλάβετε διασυνδέσεις εντολών στην τεκμηρίωσή σας, πρέπει πρώτα να δηλώσετε τη χρήση του κώδικα 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")'>
Open the About dialog</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">
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>