Προ-ευρετηριοποίηση τεκμηρίωσης

Όταν ο χρήστης αναζητά περιεχόμενα βοήθειας για ένα προϊόν, η αναζήτηση εκτελείται σε ένα ευρετήριο τεκμηρίωσης.  Από προεπιλογή, αυτό το ευρετήριο  δημιουργείται κατά την πρώτη κλήση της αναζήτησης της βοήθειας, ωστόσο μπορεί να είναι προ-δομημένο και να παρέχεται στο χρήστη με κάθε πρόσθετη λειτουργία, από την έκδοση 3.1, ή ως πλήρες ευρετήριο για ένα προϊόν.  Κατ' αυτό τον τρόπο η ευρετηριοποίηση δεν γίνεται στον υπολογιστή του χρήστη και ο χρήστης λαμβάνει τα πρώτα αποτελέσματα γρηγορότερα.

Δόμηση ευρετηρίου τεκμηρίωσης για μια πρόσθετη λειτουργία.

Για να δομήσετε ένα ευρετήριο, ακολουθήστε τα παρακάτω βήματα:

Δόμηση ευρετηρίου για ένα προϊόν

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

Για να δομήσετε ένα ευρετήριο, ακολουθήστε τα παρακάτω βήματα:

Για παράδειγμα, η εκτέλεση της εντολής

eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=d:/build/com.my.plugin -DindexLocale=en

θα έχει ως αποτέλεσμα την αποθήκευση του αρχείου doc_index.zip στον κατάλογο nl/en που θα δημιουργηθεί στη θέση d:/build/com.my.plugin.  Το αρχείο zip θα περιέχει το ευρετήριο των περιεχομένων των εγγράφων που είναι διαθέσιμα στους χρήστες όταν εκτελούν το προϊόν στην τοπική ρύθμιση en.

Συσκευασία και εγκατάσταση του προ-δομημένου ευρετηρίου του προϊόντος

Τα προ-δομημένα ευρετήρια, τα αρχεία doc_index.zip, πρέπει να συσκευαστούν ως πρόσθετη λειτουργία.   Μπορείτε να επιλέξετε να χρησιμοποιήσετε μια πρόσθετη λειτουργία που έχει συσχετιστεί με μια κύρια λειτουργία ή να επιλέξετε να συσκευάσετε το ευρετήριο για κάθε γλώσσα σε ξεχωριστά τμήματα κώδικα.

Αν για παράδειγμα, η τεκμηρίωση ενός προϊόντος είναι διαθέσιμη σε τρεις γλώσσες, π.χ. στα Αγγλικά, τα Γερμανικά και τα απλοποιημένα Κινεζικά, μια πρόσθετη λειτουργία com.my.plugin μπορεί να έχει την ακόλουθη δομή:
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
άλλα αρχεία αυτής της πρόσθετης λειτουργίας

Η ταυτότητα της πρόσθετης λειτουργίας πρέπει να καθοριστεί ως προτίμηση productIndex για την πρόσθετη λειτουργία org.eclipse.help.base. Για την πρόσθετη λειτουργία στο παραπάνω παράδειγμα, το αρχείο plugin_customization.ini πρέπει να περιέχει την εγγραφή:
org.eclipse.help.base/productIndex=com.my.plugin