Περιεχόμενο φύλλου υποδείξεων

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

Αυτό το σημείο επέκτασης χρησιμοποιείται για την καταχώρηση συνεισφορών περιεχομένου φύλλου υποδείξεων. Φύλλα υποδείξεων εμφανίζονται ως επιλογές από το μενού "Βοήθεια" ή μέσα από την προβολή φύλλου υποδείξεων και χρησιμοποιούνται συνήθως για να βοηθήσουν το χρήστη στη σειρά των πολύπλοκων εργασιών για την επίτευξη ενός γενικού στόχου.

Τα φύλλα υποδείξεων είναι οργανωμένα σε κατηγορίες που συνήθως αντικατοπτρίζουν ένα συγκεκριμένο πρόβλημα τομέα. Για παράδειγμα, μια πρόσθετη λειτουργία προσανατολισμένη σε Java μπορεί να ορίσει μια κατηγορία με όνομα "Java", κατάλληλη για φύλλα υποδείξεων που θα βοηθήσουν το χρήστη με κάθε εργαλείο Java. Οι κατηγορίες που ορίζονται από μια πρόσθετη λειτουργία μπορούν να λειτουργήσουν ως παραπομπές από άλλες πρόσθετες λειτουργίες χρησιμοποιώντας το γνώρισμα κατηγορίας ενός στοιχείου φύλλου υποδείξεων. Μη κατηγοριοποιημένα φύλλα υποδείξεων, καθώς και φύλλα υποδείξεων με μη έγκυρες διαδρομές κατηγοριών, θα καταλήξουν σε μια κατηγορία "Άλλο".

Τα φύλλα υποδείξεων μπορούν προαιρετικά να καθορίζουν ένα υποστοιχείο περιγραφής, του οποίου το σώμα πρέπει να περιέχει ένα σύντομο κείμενο για το φύλλο υποδείξεων.

<!ELEMENT extension (category | cheatsheet | taskEditor | taskExplorer)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT category EMPTY>

<!ATTLIST category

id             CDATA #REQUIRED

name           CDATA #REQUIRED

parentCategory CDATA #IMPLIED>

Ένα στοιχείο κατηγορίας στο σημείο επέκτασης cheatsheetContent δημιουργεί μια νέα κατηγορία στο μενού φύλλου υποδείξεων. Το μενού φύλλου υποδείξεων είναι διαθέσιμο από το μενού βοήθειας στον πάγκο εργασίας. Εάν καθοριστεί μια νέα κατηγορία, τα φύλλα υποδείξεων μπορούν να προοριστούν προς αυτή την κατηγορία και θα εμφανιστούν στο πλαίσιο διαλόγου για επιλογή φύλλου υποδείξεων.



<!ELEMENT cheatsheet (description?)>>

<!ATTLIST cheatsheet 

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED

composite   (true | false) "false">

Ένα στοιχείο φύλλου υποδείξεων τοποθετείται στο σημείο επέκτασης cheatsheetContent εάν υπάρχει φύλλο υποδείξεων για συνεισφορά στον πάγκο εργασίας. Ένα στοιχείο φύλλου υποδείξεων πρέπει να καθορίσει μια ταυτότητα, ένα μεταφράσιμο όνομα για εμφάνιση στις επιλογές, μια ταυτότητα κατηγορίας για προσδιορισμό της κατηγορίας στην οποία θα προστεθεί αυτό το φύλλο υποδείξεων, και ένα αρχείο περιεχομένου. Το αρχείο περιεχομένου φύλλου υποδείξεων είναι ένα αρχείο XML που περιγράφει τα βήματα και τις ενέργειες που περιλαμβάνει το φύλλο υποδείξεων.



<!ELEMENT description (#PCDATA)>

μια σύντομη περιγραφή του φύλλου υποδείξεων



<!ELEMENT taskEditor EMPTY>

<!ATTLIST taskEditor

id    CDATA #REQUIRED

class CDATA #REQUIRED

icon  CDATA #REQUIRED>

Αυτό το σημείο επέκτασης είναι προσωρινό και βασίζεται στην προσωρινή κλάση TaskEditor του API. Το σημείο επέκτασης taskEditor επιτρέπει την εμφάνιση του προσαρμοσμένου περιβάλλοντος χρήστη στο τμήμα παραθύρου της λειτουργίας επεξεργασίας ενός σύνθετου φύλλου υποδείξεων. Κάθε εργασία σε σύνθετο φύλλο υποδείξεων, του οποίου το είδος συμφωνεί με την ταυτότητα αυτής της επέκτασης, θα χρησιμοποιήσει την κλάση που ορίζεται σε αυτό το σημείο επέκτασης για τη δημιουργία της περιοχής της λειτουργίας επεξεργασίας.



<!ELEMENT taskExplorer EMPTY>

<!ATTLIST taskExplorer

id    CDATA #REQUIRED

class CDATA #IMPLIED

icon  CDATA #IMPLIED

name  CDATA #REQUIRED>

Αυτό το σημείο επέκτασης είναι προσωρινό και βασίζεται στην προσωρινή κλάση TaskExplorer του API. Αυτό το σημείο επέκτασης επιτρέπει τη συνεισφορά μιας εξερεύνησης εργασιών η οποία θα χρησιμοποιηθεί κατά το άνοιγμα ενός σύνθετου φύλλου υποδείξεων.



Παρακάτω δίνεται μια απλή χρήση του σημείου επέκτασης cheatSheetContent.

<extension point=

"org.eclipse.ui.cheatsheets.cheatSheetContent"

>

<category name=

"Example category"

id=

"com.example.category"

>

</category>

<cheatsheet name=

"Example cheat sheet"

category=

"com.example.category"

id=

"com.example.cheatSheet"

contentFile=

"ExampleCheatSheet.xml"

>

<description>

This is a descriptive bit of text for my cheat sheet description.

</description>

</cheatsheet>

</extension>

Για περισσότερες λεπτομέρειες, δείτε τις προδιαγραφές για το πακέτο ΑΡΙ org.eclipse.ui.cheatsheets.

Δεν υπάρχουν ενσωματωμένα φύλλα υποδείξεων.