Lucene keresési segédek

org.eclipse.help.base.luceneSearchParticipants

3.2

Ez a kiterjesztési pontot dokumentumtartalom Lucene keresési indexhez adására használható. Két esetben lehet szükség segéd hozzáadására:
  1. A súgórendszer TOC-jával bejegyzett, nem HTML formátumú (például XML) dokumentumok indexeléséhez. Ebben az esetben a segédnek deklarálnia kell az általa kezelhető fájlkiterjesztéseket. Meghívásra kerül minden megfelelő dokumentum indexelése érdekében. Ebben az esetben a segéd bedolgozó-hatókörrel rendelkezik.
  2. A súgórendszer TOC-jén kívüli dokumentumok indexeléséhez. Ebben az esetben a segéd az összes általa ismert dokumentumot azonnal indexelheti. Ezen felül a segédre delegálják a keresési találat megnyitásának feladatát, mivel a súgórendszer nem tudja, hogyan nyissa meg a TOC-n kívüli dokumentumokat. Ebben az esetben a segéd globális hatókörrel rendelkezik.

A keresési segédek ahhoz a bedolgozóhoz tartoznak, amelyben a kiterjesztés megjelenik. Ahhoz, hogy a segédet újból fel lehessen használni más bedolgozókban, binding (kötés) elemet kell használni a rájuk való hivatkozáshoz. Ez a stratégia megakadályozza, hogy a bedolgozó a segédjét ráerőltesse a teljes termékre azon fájlkiterjesztésekre vonatkozóan, amelyekhez bejegyzésre került. Egy explicit hivatkozás hozzáadásával a bedolgozó deklarálja, hogy engedélyezi a hivatkozott keresési segéd számára a dokumentumok indexelését ezekkel a kiterjesztésekkel. Nem a TOC részét képező dokumentumok esetén nincs ilyen veszély. Emiatt ezek globálisak és nem kell kötést használni.

<!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">


<!ELEMENT participant (parameter*)>

<!ATTLIST participant

class CDATA #IMPLIED>


<!ELEMENT parameter EMPTY>

<!ATTLIST parameter

name  CDATA #REQUIRED

value CDATA #REQUIRED>


<!ELEMENT binding EMPTY>

<!ATTLIST binding

participantId CDATA #IMPLIED>


Az alábbiakban a kiterjesztési pont használatára látható példa:

  

<extension point=

"org.eclipse.help.base.luceneSearchParticipant"

>

<searchParticipant id=

"org.eclipse.myGlobalParticipant"

name=

"Globális segéd"

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>

A biztosított keresési segédosztálynak ki kell terjesztenie az org.eclipse.help.search.LuceneSearchParticipant absztrakt osztályt.

A súgórendszer keresési segédet biztosít az XHTML fájlokhoz (xhtml kiterjesztés). A TOC részét képező dinamikus XHTML dokumentumokkal rendelkező bedolgozókat ehhez a segédhez kell kötni a binding elem és az org.eclipse.help.base.xhtml célsegéd-azonosító alkalmazásával.