Lucene-haun osapuolet
Tunnus:
org.eclipse.help.base.luceneSearchParticipants
Alkaen versiosta:
3.2
Kuvaus:
Tämän laajennuspisteen avulla voit lisätä asiakirjasisältöä Lucene-haun indeksiin. Voit lisätä haun osapuolen kahdessa tapauksessa:
-
Jos haluat indeksoida asiakirjoja, jotka on rekisteröity ohjejärjestelmän sisällysluetteloon, mutta jotka eivät ole HTML-muodossa (esimerkiksi XML). Tässä tapauksessa osapuolen on esiteltävä tiedoston tunnisteet,
jotka se voi käsitellä.Sitä kutsutaan indeksoimaan kukin vastaava asiakirja. Tässä tapauksessa osapuolen vaikutusalue on lisäosa.
-
Jos haluat indeksoida ohjejärjestelmän sisällysluettelon ulkopuolisia asiakirjoja. Tässä tapauksessa osapuolelle annetaan mahdollisuus indeksoida kerralla kaikki asiakirjat, jotka se tuntee. Lisäksi osapuolelle kuuluu hakutulosten avaaminen, koska ohjejärjestelmä ei tiedä, kuinka avata sisällysluettelon ulkopuolisia asiakirjoja. Tässä tapauksessa osapuolen vaikutusalue on yleinen.
Haun osapuolet liittyvät lisäosaan, jossa laajennus on. Jos haluat käyttää osapuolia uudelleen muissa lisäosissa, niihin on oltava binding
-viittaus. Tämä estää lisäosaa ottamasta osapuolta käyttöön koko tuotteessa niiden tiedoston tunnisteiden osalta, joihin se on rekisteröity. Lisäämällä nimenomaisen viittauksen lisäosa määrittää, että se sallii viitatun haun osapuolen käsittelevän sellaisten asiakirjojen indeksoinnin, joissa on kyseiset tunnisteet. Niiden asiakirjojen osalta, jotka eivät ole osa sisällysluetteloa, tällaista vaaraa ei ole. Tämän vuoksi ne ovat yleisiä eikä binding
ole tarpeen.
Merkintärakenne:
<!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 - haun osapuolen yksilöllinen tunnus.
- name - valinnainen käännettävä nimi, joka kuvaa osapuolta asiakirjaluokkana,
jonka voi sisällyttää hakuun. Nimi ei ole pakollinen, kun osapuolta käytetään sisällysluettelon asiakirjoissa (eli silloin kun määritettä
extensions
ei ole asetettu).
- icon - valinnainen kuvake, jonka avulla esitetään tämän osapuolen indeksoimien asiakirjojen hakuosumien määrä. Kuvaketta käytetään asiakirjoissa, jotka eivät kuulu ohjeen sisällysluetteloon, sen osoittamiseksi, että haun osuman avaaminen ei ehkä tuo näkyviin tavallista ohjeasiakirjaa. Näin ollen
kuvake ei ole pakollinen, kun osapuolta käytetään sisällysluettelon asiakirjoissa (eli silloin kun määritettä
extensions
ei ole asetettu).
- participant - (uutta versiossa 3.2) ohjeen haun osapuolen toteutusluokka. Tämän luokan on toteutettava org.eclipse.help.search.ILuceneSearchParticipant-liittymä. Tämän määritteen voi jättää pois, ja sen sijasta voi käyttää sisäkkäistä participant-elementtiä.
- extensions - valinnainen kenttä, jossa on luettelo haun osapuolen käsittelemistä tiedostolajeista. Tässä merkkijonossa on pilkuin eroteltuja tiedoston tunnisteita (esimerkiksi "abc, xyz"). Käytä tätä määritettä, kun tiedostot määritetään nimenomaisesti ohjejärjestelmään laajennuspisteessä
org.eclipse.help.toc
. Tämän määritteen puuttuminen osoittaa, että osapuoli indeksoi itse kaikki asiakirjat, joista se vastaa.
Huomaa myös, että tunnetuille asiakirjoille rekisteröityjen osapuolten alueen on oltava lisäosa. Jos haluat osapuolen pätevän myös toisen lisäosan asiakirjoihin, aluetta on laajennettava binding
-elementin avulla. Sitä vastoin osapuolilla, joille ei ole määritetty tätä määritettä, on yleinen alue.
- headless - määrittää, käytetäänkö tätä haun osapuolta, kun ohjejärjestelmä ajetaan
Eclipse-työympäristön ulkopuolella eli itsenäisesti tai infocenter-tilassa. Oletusarvo on
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - ohjeen haun osapuolen tuottajan toteutusluokka. Tämän luokan on toteutettava org.eclipse.help.search.ILuceneSearchParticipant-liittymä.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - toteutusluokalle välitettävän parametrin nimi.
- value - toteutusluokalle välitettävän parametrin arvo.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - viittaus haun osapuoleen, joka on esitelty muualla
searchParticipant
-elementin avulla. Sidonnan avulla voit käyttää haun osapuolia uudelleen lisäosissa loukkaamatta ylhäältä alas -käytäntöä. Sidonta on tarpeen vain sellaisten asiakirjojen indeksoinnissa, jotka eivät ole osa sisällysluetteloa. Muutoin osapuolen alue on yleinen.
Esimerkkejä:
Seuraavassa on laajennuspisteen käyttöesimerkki:
<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-tiedot:
Toimitetun haun osapuolen on laajennettava abstraktia luokkaa org.eclipse.help.search.LuceneSearchParticipant.
Toimitettu toteutus:
Ohjejärjestelmässä on haun osapuoli XHTML-tiedostoille (xhtml-laajennus). Lisäosat, joilla on dynaamisia XHTML-asiakirjoja osana sisällysluetteloa, on sidottava tähän osapuoleen käyttäen binding
-elementtiä ja org.eclipse.help.base.xhtml
-objektia kohdeosapuolen tunnuksena.
Copyright (c) 2005, 2006 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html