Στοιχεία συμμετοχής σε αναζήτηση του Lucene
Ταυτότητα:
org.eclipse.help.base.luceneSearchParticipants
Από:
3.2
Περιγραφή:
Αυτό το σημείο
επέκτασης πρέπει να χρησιμοποιείται για την προσθήκη περιεχομένου εγγράφων στο
ευρετήριο αναζήτησης Lucene. Υπάρχουν δύο περιπτώσεις που θα θέλατε να
προσθέσετε ένα στοιχείο συμμετοχής αναζήτησης:
-
Για την ευρετηριοποίηση των εγγράφων που έχουν καταχωρηθεί με το TOC του
συστήματος βοήθειας και δεν έχουν μορφή HTML (π.χ. XML). Στην περίπτωση αυτή,
το στοιχείο συμμετοχής πρέπει να δηλώσει τις επεκτάσεις αρχείου που μπορεί να
χειριστεί. Θα κληθεί για την ευρετηριοποίηση κάθε εγγράφου που συμφωνεί. Στην
περίπτωση αυτή, το στοιχείο συμμετοχής διαθέτει την εμβέλεια της πρόσθετης
λειτουργίας.
-
Για την ευρετηριοποίηση εγγράφων εκτός του TOC του συστήματος βοήθειας. Στην
περίπτωση αυτή, θα δοθεί στο στοιχείο συμμετοχής η ευκαιρία
ταυτόχρονης ευρετηριοποίησης όλων των εγγράφων που γνωρίζει. Επιπλέον, θα
ανατεθεί στο στοιχείο συμμετοχής η εργασία ανοίγματος του αποτελέσματος
αναζήτησης, επειδή το σύστημα βοήθειας δε θα γνωρίζει τον τρόπο ανοίγματος
εγγράφων εκτός του TOC. Στην περίπτωση αυτή, το στοιχείο συμμετοχής διαθέτει
καθολική εμβέλεια.
Τα στοιχεία συμμετοχής αναζήτησης συσχετίζονται με την πρόσθετη
λειτουργία, στην οποία εμφανίζεται η επέκταση. Για να χρησιμοποιηθεί εκ νέου το
στοιχείο συμμετοχής σε άλλες πρόσθετες λειτουργίες, πρέπει
να χρησιμοποιηθεί το binding
, το οποίο θα παραπέμπει σε αυτές. Αυτή
η στρατηγική εμποδίζει μια πρόσθετη λειτουργία να επιβάλει το στοιχείο
συμμετοχής σε ολόκληρο το προϊόν για τις επεκτάσεις αρχείου με τις οποίες
καταχωρήθηκε. Με την προσθήκη μιας απόλυτης παραπομπής, η πρόσθετη λειτουργία
δηλώνει ότι επιτρέπει στο στοιχείο συμμετοχής αναζήτησης, στο οποίο έγινε
η παραπομπή, να χειριστεί την ευρετηριοποίηση εγγράφων με αυτές τις επεκτάσεις. Για
έγγραφα που δεν αποτελούν τμήμα του TOC, δεν υπάρχει τέτοιος κίνδυνος. Για αυτό
το λόγο, είναι καθολικά και δεν πρέπει να χρησιμοποιηθεί το binding
.
Μορφοποίηση ρυθμίσεων:
<!ELEMENT extension (searchParticipant | binding)>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT searchParticipant (participant?)>
<!ATTLIST searchParticipant
id CDATA #REQUIRED
name CDATA #IMPLIED
icon CDATA #IMPLIED
participant CDATA #IMPLIED
extensions CDATA #IMPLIED
headless (true | false) "false">
- id - μια μοναδική ταυτότητα αυτού του στοιχείου συμμετοχής αναζήτησης
- name - ένα προαιρετικό μεταφράσιμο όνομα που θα χρησιμοποιηθεί για
την εκπροσώπηση του στοιχείου συμμετοχής ως μια κατηγορία εγγράφων που μπορεί
να συμπεριληφθεί στην αναζήτηση. Το όνομα δεν απαιτείται όταν το στοιχείο
συμμετοχής χρησιμοποιείται για έγγραφα στο TOC (π.χ. όταν έχει οριστεί το
γνώρισμα
extensions
).
- icon - ένα προαιρετικό εικονίδιο που θα χρησιμοποιηθεί για την
εμφάνιση των αντιστοιχίσεων αναζήτησης από τα έγγραφα που ευρετηριοποιήθηκαν
από αυτό το στοιχείο συμμετοχής. Το εικονίδιο θα χρησιμοποιηθεί για τα έγγραφα
εκτός του TOC της βοήθειας για υποδείξει ότι το άνοιγμα των αντιστοιχίσεων
αναζήτησης μπορεί να έχει ως αποτέλεσμα μια ενέργεια διαφορετική από την
εμφάνιση του κανονικού εγγράφου βοήθειας. Συνεπώς, το εικονίδιο δεν
απαιτείται όταν το στοιχείο συμμετοχής χρησιμοποιείται για έγγραφα στο TOC (π.χ. όταν έχει οριστεί
το γνώρισμα
extensions
).
- participant - (νέο στο 3.2) η κλάση υλοποίησης για
το στοιχείο συμμετοχής αναζήτησης βοήθειας. Αυτή η κλάση πρέπει να υλοποιήσει
τη διεπαφή org.eclipse.help.search.ILuceneSearchParticipant. Το
γνώρισμα αυτό μπορεί να παραλείπεται και στη θέση του να παρέχεται το ένθετο
στοιχείο participant.
- extensions - προαιρετικό πεδίο που περιέχει τη λίστα των ειδών
αρχείων, τα οποία χειρίζεται το στοιχείο συμμετοχής αναζήτησης. Πρόκειται
για μια σειρά χαρακτήρων με επεκτάσεις αρχείων που διαχωρίζονται με κόμμα (π.χ. "abc, xyz").
Αυτό το γνώρισμα πρέπει να χρησιμοποιείται όταν τα αρχεία κοινοποιούνται ρητά
στο σύστημα βοήθειας στο σημείο επέκτασης
org.eclipse.help.toc
. Η
απουσία αυτού του γνωρίσματος είναι μια ένδειξη ότι το στοιχείο συμμετοχής δε
θα ευρετηριοποιήσει μόνο του όλα τα έγγραφα για τα οποία είναι υπεύθυνο.
Σημειώστε επίσης ότι τα στοιχεία συμμετοχής που καταχωρούνται για γνωστά
έγγραφα έχουν εμβέλεια πρόσθετης λειτουργίας. Εάν θέλετε να εφαρμόζεται ένα
στοιχείο συμμετοχής σε έγγραφα σε άλλη πρόσθετη λειτουργία, πρέπει να
χρησιμοποιήσετε το στοιχείο binding
για να επεκταθεί η εμβέλεια.
Αντιθέτως, τα στοιχεία συμμετοχής που δεν καθορίζουν αυτό το γνώρισμα έχουν
καθολική εμβέλεια.
- headless - καθορίζει εάν αυτό το στοιχείο συμμετοχής αναζήτησης
πρέπει να χρησιμοποιείται κατά την εκτέλεση του συστήματος βοήθειας εκτός ενός
πάγκου εργασίας eclipse, π.χ. εκτελείται είτε σε κατάσταση
ανεξάρτητης λειτουργίας είτε σε κατάσταση λειτουργίας κέντρου πληροφοριών. Η
προεπιλεγμένη τιμή είναι
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - η κλάση υλοποίησης για το στοιχείο συμμετοχής αναζήτησης
βοήθειας.
Αυτή η κλάση πρέπει να υλοποιήσει τη διεπαφή
org.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - όνομα μιας παραμέτρου που μεταβιβάζεται στην κλάση υλοποίησης
- value - τιμή μιας παραμέτρου που μεταβιβάζεται στην κλάση υλοποίησης
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - μια παραπομπή στο στοιχείο συμμετοχής αναζήτησης που
δηλώνεται αλλού χρησιμοποιώντας το στοιχείο
searchParticipant
. Ο
δεσμός μπορεί να χρησιμοποιηθεί για την εκ νέου χρήση των στοιχείων συμμετοχής
αναζήτησης σε πρόσθετες λειτουργίες χωρίς να παραβιάζει την πολιτική "από
πάνω προς τα κάτω". Ο δεσμός είναι απαραίτητος μόνο για την
ευρετηριοποίηση εγγράφων που αποτελούν τμήμα του TOC. Διαφορετικά, το
στοιχείο συμμετοχής έχει καθολική εμβέλεια.
Παραδείγματα:
Παρακάτω δίνεται ένα παράδειγμα χρήσης του σημείου επέκτασης:
<extension point=
"org.eclipse.help.base.luceneSearchParticipant"
>
<searchParticipant id=
"org.eclipse.myGlobalParticipant"
name=
"Global Participant"
icon=
"icons/mydoc.gif"
participant=
"org.eclipse.myPlugin.myPackage.MyGlobalParticipant"
headless=
"true"
/>
<searchParticipant id=
"org.eclipse.myXYZParticipant"
extensions=
"xyz"
participant=
"org.eclipse.myPlugin.myPackage.MyXYZParticipant"
/>
</extension>
Πληροφορίες API:
Η παρεχόμενη κλάση
του στοιχείου συμμετοχής αναζήτησης πρέπει να επεκτείνει την αφηρημένη κλάση
org.eclipse.help.search.LuceneSearchParticipant.
Παρεχόμενη υλοποίηση:
Το σύστημα
βοήθειας παρέχει στοιχείο συμμετοχής αναζήτησης για αρχεία XHTML (επέκταση xhtml). Οι
πρόσθετες λειτουργίες που έχουν δυναμικά έγγραφα XHTML ως τμήμα του TOC
πρέπει να συνδέονται με αυτό το στοιχείο συμμετοχής χρησιμοποιώντας το
στοιχείο binding
και το org.eclipse.help.base.xhtml
ως ταυτότητα του στοιχείου συμμετοχής προορισμού.
Copyright (c) 2005, 2006 IBM Corporation και άλλων.
Με την επιφύλαξη παντός δικαιώματος. Αυτό το πρόγραμμα και τα συνοδευτικά του υλικά διατίθενται βάσει των όρων της κοινής άδειας χρήσης Eclipse Public License v1.0 που συνοδεύει αυτή τη διανομή και διατίθεται στην ακόλουθη διεύθυνση: http://www.eclipse.org/legal/epl-v10.html.