Ποιος ο λόγος χρήσης του XHTML;
Το σύστημα βοήθειας παρέχει τη δυνατότητα παραγωγής δυναμικού περιεχομένου βοήθειας προσθέτοντας σημειώσεις στη μορφοποίηση XHTML με ειδικά προσδιοριστικά στο φίλτρο, στα στοιχεία include, και καθορίζει επίσης σημεία αγκύρωσης για επεκτάσεις. Αυτές οι λειτουργίες δε διατίθενται κατά τη χρήση του HTML.
Πώς γίνεται η συνεισφορά του XHTML;
Τα έγγραφα βοήθειας XHTML συνεισφέρονται με τον ίδιο τρόπο όπως το HTML, παρατηρούνται όμως ορισμένες σημαντικές διαφορές, οι οποίες πρέπει να υπάρχουν για να υποστηρίζουν το δυναμικό περιεχόμενο και την αναζήτηση. Αυτές οι απαιτούμενες τροποποιήσεις είναι οι εξής:
Πρέπει να συνδεθεί το στοιχείο συμμετοχής αναζήτησης XHTML στην πρόσθετη λειτουργία του εγγράφου σας.
Η υλοποίηση βοήθειας του eclipse χρησιμοποιεί το Lucene για την ευρετηριοποίηση των εγγράφων ώστε να επιταχυνθεί η αναζήτηση. Για να ευρετηριοποιήσει ένα έγγραφο, το Lucene πρέπει να μπορεί να αναγνώσει τη μορφή. Το Eclipse παρέχει ήδη ένα στοιχείο συμμετοχής αναζήτησης για την ευρετηριοποίηση των εγγράφων XHTML, επομένως το μόνο που χρειάζεται είναι να υποδείξετε στο σύστημα βοήθειας να το χρησιμοποιήσει για τα έγγραφά σας. Προσθέστε στη δήλωση της πρόσθετης λειτουργίας την ακόλουθη επέκταση:
<extension point="org.eclipse.help.base.luceneSearchParticipants"> <binding participantId="org.eclipse.help.base.xhtml"/> </extension>
Εάν χρησιμοποιείτε δυναμικό περιεχόμενο, πρέπει να συνδέσετε τη λειτουργία παραγωγής δυναμικού περιεχομένου XHTML στην πρόσθετη λειτουργία του εγγράφου σας.
Εάν θέλετε να παράγετε δυναμικό περιεχόμενο χρησιμοποιώντας τις σημειώσεις XML, θα πρέπει να υποδείξετε στο σύστημα βοήθειας να επεξεργαστεί τα έγγραφά σας. Αυτό μπορεί να γίνει συνδέοντας τη λειτουργία παραγωγής δυναμικού περιεχομένου XHTML στην πρόσθετη λειτουργία που χρησιμοποιείτε.
<extension point="org.eclipse.help.contentProducer"> <binding producerId="org.eclipse.help.dynamic"/> </extension>
Μορφή του στοιχείου include σε XHTML
Εάν θέλετε να χρησιμοποιήσετε
στοιχεία include στο XHTML, η μορφή του
γνωρίσματος path
είναι η εξής: (επεξηγείται παρακάτω)
<plugin_id>/<path_to_xhtml_file>/<filename_xhtml>/<element_id>
Όπου τα πεδία είναι:
org.eclipse.help
)
/my_folder/my_sub_folder/
)
my_file.xhtml
)
id
σε αυτό το στοιχείο (π.χ. my.element.id
)
Για παράδειγμα, εάν θέλετε να συμπεριλάβετε την παράγραφο
(στοιχείο <p>
) με την ταυτότητα my_copyright
από το αρχείο /copyrights/copyright.xhtml
στην πρόσθετη λειτουργία my.product.plugin
, πρέπει να
ορίσετε τα εξής:
my.product.plugin/copyrights/copyright.xhtml/my_copyright