Η συμφραστική βοήθεια περιγράφεται με τη συσχέτιση της ταυτότητας περιβάλλοντος που δηλώνεται στον κώδικα περιβάλλοντος χρήστη με μια περιγραφή και μια λίστα σχετικών θεμάτων στην ηλεκτρονική βοήθεια. Αυτές οι συσχετίσεις γίνονται εντός του αρχείου XML. Μπορείτε να δημιουργήστε οποιονδήποτε αριθμό αρχείων XML με συσχετίσεις συμφραστικής βοήθειας για κάθε πρόσθετη λειτουργία. Η περιγραφή και οι σύνδεσμοι για κάθε ταυτότητα περιβάλλοντος γίνονται μέσα σε στοιχεία <context> στο αρχείο XML. Κάθε στοιχείο περιβάλλοντος μπορεί να έχει ένα προαιρετικό στοιχείο <description>, το οποίο χρησιμοποιείται για την περιγραφή του αντικειμένου περιβάλλοντος χρήστη και οποιουδήποτε αριθμού στοιχείων <topic> που διασυνδέονται με την ηλεκτρονική τεκμηρίωση.
Από την έκδοση 3.1 και μετά, τα στοιχεία περιβάλλοντος μπορούν προαιρετικά να αντικαταστήσουν τον προεπιλεγμένο τίτλο που χρησιμοποιείται για την παρουσίαση των πληροφοριών συμφραστικής βοήθειας στην προβολή "Βοήθεια".
<contexts> <context id="panic_button" title="Panic Button Title"> <description>This is the panic button.</description> <topic href="tasks/pushing_the_panic_button.htm" label="Pushing the panic button"/> <topic href="reference/panic_button.htm" label="Panic Button Reference"/> </context> ... </contexts>
Αφού περιγραφούν τα περιβάλλοντα στα αρχεία XML, είστε έτοιμος να ανατρέξετε στα αρχεία περιβάλλοντος στη δήλωση της πρόσθετης λειτουργίας. Σημειώστε ότι η ταυτότητα περιβάλλοντος δεν έχει πλήρως προσδιοριστεί παραπάνω. Αυτό επιτρέπεται όσο συνεισφέρεται το αρχείο περιβάλλοντος στη δήλωση της πρόσθετης λειτουργίας που καθόρισε την ταυτότητα περιβάλλοντος. Με άλλα λόγια, η ταυτότητα περιβάλλοντος αναλύεται στην ταυτότητα της πρόσθετης λειτουργίας που συνεισέφερε το αρχείο XML.
Μια πρόσθετη λειτουργία συνεισφέρει αρχεία περιβάλλοντος χρησιμοποιώντας το σημείο επέκτασης org.eclipse.help.contexts.
<extension point="org.eclipse.help.contexts"> <contexts name="myContextHelp.xml" /> </extension>
Μπορείτε να κάνετε παραπομπές σε αρχεία περιβάλλοντος από άλλες πρόσθετες λειτουργίες συμπεριλαμβάνοντας το γνώρισμα plugin. Αυτό σας επιτρέπει να ομαδοποιήσετε όλη την τεκμηρίωση, συμπεριλαμβανομένης της συμφραστικής βοήθειας, σε μια πρόσθετη λειτουργία, και να ανατρέξετε σε αυτή από την πρόσθετη λειτουργία του περιβάλλοντος χρήστη ή κάποια άλλη σχετική πρόσθετη λειτουργία.
<extension point="org.eclipse.help.contexts"> <contexts name="myContextHelp.xml" plugin="com.example.helpExample" /> </extension>
Όπως μπορείτε να δείτε, διαθέτετε μεγάλη ευελιξία στην οργάνωση των περιβαλλόντων σας σε ένα ή περισσότερα αρχεία που περιέχονται σε μία ή περισσότερες πρόσθετες λειτουργίες. Η κύρια μέριμνα είναι η σωστή ανάλυση των ταυτοτήτων περιβαλλόντων στα αρχεία. Εάν δεν προσδιορίσετε πλήρως μια ταυτότητα περιβάλλοντος, τότε πρέπει να συνεισφέρετε το αρχεία περιβάλλοντος XML στην πρόσθετη λειτουργία που δήλωσε τις ταυτότητες περιβαλλόντων. Εάν χρησιμοποιείτε πλήρως προσδιορισμένες ταυτότητες περιβαλλόντων στο αρχείο περιβάλλοντος XML , τότε έχετε απόλυτη ευελιξία στον εντοπισμό των αρχείων XML και σε ποια πρόσθετη λειτουργία συνεισφέρει τα περιβάλλοντα.
Ένα άλλο επίπεδο ευελιξίας είναι η ικανότητα συνεισφοράς συμφραστικής βοήθειας για την ίδια ταυτότητα περιβάλλοντος από διαφορετικές πρόσθετες λειτουργίες. Αυτό είναι χρήσιμο, για παράδειγμα, εάν υπάρχουν διαφορετικά σύνολα πρόσθετων λειτουργιών τεκμηρίωσης που μπορούν να εγκατασταθούν στη ρύθμιση ενός χρήστη ή όχι. Αυτό επιτρέπει σε κάθε πρόσθετη λειτουργία τεκμηρίωσης να δηλώσει ανεξάρτητα τα περιβάλλοντά της. Ο τελικός χρήστης θα δει το συγχωνευμένο περιεχόμενο συμφραστικής βοήθειας για όλες τις πρόσθετες λειτουργίες που συνεισφέρουν περιβάλλοντα για την ταυτότητα του οργάνου.
Σημειώστε ότι πρέπει να χρησιμοποιηθεί η πλήρως προσδιορισμένη ταυτότητα περιβάλλοντος για το όργανο, αφού καμιά από τις πρόσθετες λειτουργίες τεκμηρίωσης δεν δήλωσε την ταυτότητα περιβάλλοντος. Όταν πολλαπλές πρόσθετες λειτουργίες συνεισφέρουν συμφραστική βοήθεια για την ίδια ταυτότητα περιβάλλοντος, εμφανίζεται πρώτο το περιεχόμενο που ορίζεται στην πρόσθετη λειτουργία, η οποία δήλωσε το περιβάλλον (η πρόσθετη λειτουργία περιβάλλοντος χρήστη). Πρόσθετες περιγραφές και διασυνδέσεις προσαρτώνται στο τέλος σε μη σταθερή σειρά.
Δυναμικό περιεχόμενο
Το δυναμικό περιεχόμενο διατίθεται για τη συμφραστική βοήθεια με τη μορφή φίλτρων στις διασυνδέσεις θέματος συμφραστικής βοήθειας. Για παράδειγμα, μπορεί να θέλετε να εμφανίζεται μια διασύνδεση θέματος στη συμφραστική βοήθεια μόνο όταν εκτελείται σε συγκεκριμένο λειτουργικό σύστημα.