Όταν ο χρήστης αναζητά περιεχόμενα βοήθειας για ένα προϊόν, η αναζήτηση εκτελείται σε ένα ευρετήριο τεκμηρίωσης. Από προεπιλογή, αυτό το ευρετήριο δημιουργείται κατά την πρώτη κλήση της αναζήτησης της βοήθειας, ωστόσο μπορεί να είναι προ-δομημένο και να παρέχεται στο χρήστη με κάθε πρόσθετη λειτουργία, από την έκδοση 3.1, ή ως πλήρες ευρετήριο για ένα προϊόν. Κατ' αυτό τον τρόπο η ευρετηριοποίηση δεν γίνεται στον υπολογιστή του χρήστη και ο χρήστης λαμβάνει τα πρώτα αποτελέσματα γρηγορότερα.
Για να δομήσετε ένα ευρετήριο, ακολουθήστε τα παρακάτω βήματα:
index
στην επέκταση org.eclipse.help.toc
σε μια πρόσθετη λειτουργία τεκμηρίωσης, ώστε να καθορίσετε τον κατάλογο στον οποίο στον οποίο θα ανήκει το ευρετήριο,help.buildHelpIndex
για κάθε πρόσθετη λειτουργία και τμήμα κώδικα με τεκμηρίωση.Το ευρετήριο ανά προϊόν είναι ένα συγκεντρωτικό ευρετήριο όλης της τεκμηρίωσης στο προϊόν. Πρέπει να χρησιμοποιείται σε σενάρια όπου το σύνολο των πρόσθετων λειτουργιών τεκμηρίωσης δεν αλλάζει. Για παράδειγμα, η εγκατάσταση του κέντρου πληροφοριών θα ωφεληθεί από το ευρετήριο ανά προϊόν.
Για να δομήσετε ένα ευρετήριο, ακολουθήστε τα παρακάτω βήματα:
eclipse -nosplash -application org.eclipse.help.base.indexTool -vmargs -DindexOutput=outputDirectory -DindexLocale=localeαπό τον κατάλογο που περιέχει το προϊόν. Πρέπει να οριστούν τα ακόλουθα ορίσματα:
Για παράδειγμα, η εκτέλεση της εντολής
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.
com.my.plugin/
plugin.xml
nl/
de/
doc_index.zip
en/
doc_index.zip
zh/
CN/
doc_index.zip
άλλα αρχεία αυτής της πρόσθετης λειτουργίας
org.eclipse.help.base/productIndex=com.my.plugin