Τα σύνθετα φύλλα υποδείξεων παρέχουν καθοδήγηση σε δύσκολα προβλήματα αναλύοντάς τα σε ένα σύνολο μικρότερων εργασιών. Τα σύνθετα φύλλα υποδείξεων καταχωρούνται χρησιμοποιώντας το σημείο επέκτασης org.eclipse.ui.cheatsheets.cheatSheetContent.
Το περιεχόμενο του σύνθετου φύλλου υποδείξεων ορίζεται ως ξεχωριστό αρχείο που συμμορφώνεται με τις προδιαγραφές αρχείου περιεχομένου του σύνθετου φύλλου υποδείξεων. Το αρχείο περιεχομένου είναι ένα αρχείο XML και αποτελείται από ένα σύνολο εργασιών, οι οποίες έχουν οργανωθεί σε ομάδες σε δομή διακλάδωσης.
Το <compositeCheatsheet> είναι το κεντρικό στοιχείο ενός σύνθετου φύλλου υποδείξεων. Διαθέτει μια μόνο εργασία αφετηρίας που μπορεί να είναι <task> ή <taskGroup>. Τα στοιχεία <taskGroup> μπορεί να διαθέτουν ένα ή περισσότερα θυγατρικά στοιχεία, το καθένα από τα οποία μπορεί να είναι <task> ή <taskGroup>. Ένα <task> δεν έχει θυγατρικές εργασίες.
Οι εργασίες και οι ομάδες εργασιών μπορεί να περιέχουν στοιχεία <intro>, τα οποία περιέχουν το κείμενο που θα εμφανιστεί πριν από την εκκίνηση της εργασίας και στοιχεία <onCompletion>, τα οποία περιέχουν το κείμενο που θα εμφανιστεί μετά την ολοκλήρωση της εργασίας. Τα στοιχεία <intro> και <onCompletion> μπορεί να περιέχουν μορφοποίηση κειμένου, στο παρακάτω παράδειγμα τα προσδιοριστικά <b> και </b> χρησιμοποιούνται για την έντονη γραφή του κειμένου.
Οι εργασίες μπορεί επίσης να περιέχουν στοιχεία <param>. Μια εργασία φύλλου υποδείξεων μπορεί να διαθέτει μια από τις ακόλουθες παραμέτρους: "id" είναι η ταυτότητα ενός καταχωρημένου φύλλου υποδείξεων, "path" είναι η σχετική διαδρομή ή η διεύθυνση URL του αρχείου περιεχομένου του φύλλου υποδείξεων και "skipIntro" είναι μια λογική παράμετρος που, αν είναι πραγματική, έχει ως αποτέλεσμα την εκκίνηση του φύλλου υποδείξεων στο πρώτο βήμα και όχι στην εισαγωγή. Πρέπει να καθοριστεί είτε "id" είτε "path" αλλά όχι και τα δύο.
Ένας κόμβος <εξάρτηση> από την εργασία "B" στην εργασία "A" αναπαριστά μια απαίτηση να ολοκληρωθεί η εργασία A πριν από την εκκίνηση της εργασίας B.
Εάν μια εργασία διαθέτει "cheatsheet" θα ανοίξει ένα φύλλο υποδείξεων κατά την εκκίνηση αυτής της εργασίας. Υπάρχουν τρεις πιθανές παράμετροι σε μια εργασία φύλλου υποδείξεων.
Όνομα παραμέτρου | Περιγραφή |
id | Η ταυτότητα ενός φύλλου υποδείξεων που έχει καταχωρηθεί χρησιμοποιώντας το σημείο επέκτασης org.eclipse.ui.cheatsheets.cheatSheetContent. Προσδιορίζει το φύλλο υποδείξεων που θα συσχετιστεί με αυτή την εργασία. Πρέπει να καθοριστεί είτε η παράμετρος ταυτότητα είτε η παράμετρος διαδρομή (αλλά όχι και οι δύο). |
path | Η διεύθυνση URL ενός αρχείου περιεχομένου του φύλλου υποδείξεων. Πρόκειται για απόλυτη διεύθυνση URL, ή σχετική με το αρχείο περιεχομένου για το σύνθετο φύλλο υποδείξεων. Εάν καθορίζονται και οι δύο παράμετροι (ταυτότητας και διαδρομής), τότε η διαδρομή θα χρησιμοποιηθεί για τον εντοπισμό του αρχείου περιεχομένου και η παράμετρος ταυτότητας θα αγνοηθεί. |
showIntro | Μια λογική παράμετρος με προεπιλεγμένη την τιμή true. Εάν η τιμή είναι "false", όταν το φύλλο υποδείξεων ξεκινήσει θα εμφανίσει αρχικά το πρώτο βήμα και όχι την εισαγωγή. |
Το παρακάτω αρχείο αποτελεί παράδειγμα του τρόπου δημιουργίας ενός σύνθετου φύλλου υποδείξεων από υπάρχοντα φύλλα υποδείξεων. Παρουσιάζει τον τρόπο δημιουργίας ομάδων εργασιών και δυνατότητας παράλειψής τους.
<?xml version="1.0" encoding="UTF-8"?> <compositeCheatsheet name="Composite cheat sheet example"> <taskGroup name= "Composite cheat sheet example"> <intro> This is an example of a <b>composite cheat sheet</b> built from existing cheat sheets. <br/><br/>You can select a task to work on either by following the hyperlinks or by selecting a task in the tree. </intro> <onCompletion>Congratulations you have completed all the tasks.</onCompletion> <task kind="cheatsheet" name= "Branching and merging using CVS" skip="true"> <param name = "id" value = "org.eclipse.platform.cvs_1" /> <intro>This cheat sheet is intended for CVS users. If you are not using CVS or do not intend to branch and merge you may skip this task. </intro> <onCompletion>Congratulations you now know how to branch and merge.</onCompletion> </task> <taskGroup name= "Create Java Projects" kind = "sequence"> <intro> First you will learn how to create a simple java project, then you will create an java project which uses SWT. <br/><br/>This task group is a sequence which means that if you click on the subtask "Standalone SWT Application" it will not let that task be started until "Create a java project" has been completed. </intro> <onCompletion>Congratulations you have built both Java applications.</onCompletion> <task kind="cheatsheet" name= "Create a java project" id = "createJavaProject"> <param name="id" value = "org.eclipse.jdt.helloworld"/> <param name="showIntro" value = "false"/> <intro>This cheat sheet walks through the process of creating a simple hello world application. The cheat sheet can launch wizards to create a new project and a new class. </intro> <onCompletion>Congratulations you have succeeded in creating a hello world application</onCompletion> </task> <task kind="cheatsheet" name= "Standalone SWT Application"> <intro>Eclipse plugins which contribute to the user interface use The Standard Widget Toolkit (SWT). This task guide can be used to learn more about SWT. </intro> <param name = "id" value = "org.eclipse.jdt.helloworld.swt" /> <onCompletion>Congratulations you have succeeded in creating an SWT application.</onCompletion> </task> </taskGroup> </taskGroup> </compositeCheatsheet>
Τα σύνθετα φύλλα υποδείξεων έχουν δυνατότητα επέκτασης, ωστόσο στο Eclipse 3.2 αυτή η επεκτασιμότητα είναι προσωρινή και οι κλάσεις μπορούν να αλλάξουν προτού γίνουν API. Η υποστήριξη των σύνθετων φύλλων υποδείξεων μπορεί να επεκταθεί χρησιμοποιώντας το σημείο επέκτασης org.eclipse.ui.cheatsheets.cheatSheetContent, το οποίο διαθέτει τα δύο νέα στοιχεία taskEditor και taskExplorer που επιτρέπουν τη συνεισφορά της λειτουργίας επεξεργασίας εργασιών και της εξερεύνησης εργασιών.
Η συνεισφορά μιας λειτουργίας επεξεργασίας εργασιών ορίζει ένα νέο είδος εργασίας που εμφανίζεται στην ενότητα λεπτομερειών των εργασιών. Για τη συνεισφορά μιας λειτουργίας επεξεργασίας εργασιών υλοποιήστε μια κανονική υποκλάση TaskEditor, και στη συνέχεια προσθέστε ένα στοιχείο taskEditor στο plugin.xml.
Η απεικόνιση της εξερεύνησης εργασιών διαθέτει επίσης δυνατότητα ρύθμισης με ένα σημείο επέκτασης, η εξερεύνηση διακλάδωσης περιλαμβάνεται στην πλατφόρμα Eclipse. Από προεπιλογή, όταν ανοίξει πρώτη φορά η εξερεύνηση για ένα σύνθετο φύλλο υποδείξεων είναι μια διακλάδωση, ένα γνώρισμα στο στοιχείο <compositeCheatSheet> θα επιτρέψει την αντικατάσταση της προεπιλογής. Εάν καταχωρηθούν περισσότερες από μια εξερευνήσεις, το μενού προβολής θα περιέχει ένα στοιχείο μενού για την εναλλαγή από τη μια εξερεύνηση στην άλλη. Για τη συνεισφορά μιας λειτουργίας επεξεργασίας εργασιών, υλοποιήστε πρώτα μια κανονική υποκλάση TaskExplorer, και στη συνέχεια προσθέστε ένα στοιχείο taskExplorer στο plugin.xml.
Εργασία
με φύλλα υποδείξεων
Εργασία
με σύνθετα φύλλα υποδείξεων
Δημιουργία φύλλων υποδείξεων
Σύνταξη οδηγιών
Προδιαγραφή αρχείου
περιεχομένου του σύνθετου φύλλου υποδείξεων
Σημείο επέκτασης org.eclipse.ui.cheatsheets.cheatSheetContent