Lucene keresési segédek
Azonosító:
org.eclipse.help.base.luceneSearchParticipants
Minimális verziószám:
3.2
Leírás:
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:
-
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.
-
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.
Konfigurációs kód:
<!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 - a keresési minta egyedi azonosítója
- name - egy elhagyható lefordítható név, amely a segédet a keresésben megadható dokumentumkategóriaként
ábrázolja. A név nem szükséges, ha a segédet a TOC-ben lévő dokumentumokhoz használja (például ha az
extensions
attribútum be van állítva).
- icon - egy választható ikon, amely a segéd által indexelt dokumentumok keresési találatainak
feldolgozására használható. Az ikon a súgó TOC-jén kívüli dokumentumok esetén kerül felhasználásra annak
jelzéséhez, hogy a keresési találat megnyitása a szabályos súgódokumentum megjelenítésétől különböző tevékenységet
eredményezhet. Következésképp az ikon nem szükséges, ha a segédet a TOC-ben lévő dokumentumokhoz használja
(például ha az
extensions
attribútum be van állítva).
- participant - (újdonság a 3.2 változatban) a súgó keresési segéd megvalósítási
osztálya.
Az osztálynak meg kell valósítania az
org.eclipse.help.search.ILuceneSearchParticipant
felületet. Ez az attribútum kihagyható, helyette a beágyazott participant elem biztosítható.
- extensions - a keresési segéd által kezelt fájltípusok listáját tartalmazó elhagyható mező. Ez egy
vesszővel elválasztott fájlkiterjesztéseket tartalmazó karaktersorozat (például "abc, xyz"). Az attribútumot akkor
kell használni, ha a fájlok explicit módon ismertekké válnak a súgórendszer számára az
org.eclipse.help.toc
kiterjesztési pontban. Az attribútum hiánya azt jelzi, hogy a segéd minden
dokumentumot indexel, amelyért ő a felelős.
Ne feledje el, hogy az ismert dokumentumokhoz bejegyzett segédek bedolgozó-hatókörrel rendelkeznek. Ha azt
kívánja, hogy egy segéd egy másik bedolgozóban lévő dokumentumokra is alkalmazásra kerüljön, akkor a
binding
elemet kell használni a hatókör kiterjesztéséhez. Ezzel ellentétben a segédek, amelyek nem
adják meg ezt az attribútumot, globális hatókörrel rendelkeznek.
- headless - megadja, hogy a keresési segédet használni kell-e a súgórendszer eclipse munkaterületen
kívüli futtatása esetén, például önálló vagy információs központ módban fut. Az alapértelmezett érték a
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - a súgó keresési segéd megvalósító osztálya. Az osztálynak meg kell valósítania az
org.eclipse.help.search.ILuceneSearchParticipant felületet.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - a megvalósító osztálynak átadott paraméter neve.
- value - a megvalósító osztálynak átadott paraméter értéke.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - a keresési segédre mutató hivatkozás, amely bárhol deklarálható a
searchParticipant
elemmel. A kötés segítségével újrafelhasználhatók a keresési segédek a
bedolgozókban a 'top-down' irányelv megsértése nélkül. A kötés csak a TOC részét képező dokumentumok
indexeléséhez szükséges. Ellenkező esetben a segéd globális hatókörrel rendelkezik.
Példák:
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>
API-információk:
A biztosított keresési segédosztálynak ki kell
terjesztenie az org.eclipse.help.search.LuceneSearchParticipant absztrakt osztályt.
Szállított megvalósítás:
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.
Copyright (c) 2005, 2006 IBM Corporation és mások.
Minden jog fenntartva. Jelen program és annak kísérőanyagai a csomaghoz
tartozó, illetve a
http://www.eclipse.org/legal/epl-v10.html
címen is elérhető Eclipse Public License 1.0 verziójának hatálya alatt lettek
közzétéve.