Lucene-søkedeltakere
Identifikator:
org.eclipse.help.base.luceneSearchParticipants
Siden:
3.2
Beskrivelse:
Dette utvidelsespunktet brukes til å legge til dokumentinnhold i
Lucene-søkeindeksen. Det er to tilfeller der du ønsker å legge til en søkedeltaker:
-
For å indeksere dokumenter som er registrert i hjelpesystemets innholdsfortegnelse, og som ikke er i HTML-format (f.eks. XML). I et slikt tilfelle må deltakeren deklarere filtypene den kan behandle. Den vil bli kalt opp for å indeksere hvert samsvarende dokument. I et slikt tilfelle har deltakeren plugin-omfang.
-
For å indeksere dokumenter utenfor hjelpesystemets innholdsfortegnelse. I dette tilfellet får deltakeren en sjanse til å indeksere alle dokumenter den kjenner, på en gang. I tillegg får deltakeren delegert oppgaven med å åpne søkeresultatet, for hjelpesystemet vet ikke hvordan det skal åpne dokumenter utenfor innholdsfortegnelsen. I et slikt tilfelle har deltakeren globalt omfang.
Søkedeltakerne er knyttet til plugin-modulen som filtypen blir vist i. Hvis du vil bruke deltakeren om igjen i andre plugin-moduler, utfører du binding
for å referere til dem. Dette hindrer en plugin-modul i å påtvinge en deltaker hele produktet for filtypene den er registrert med. Ved å legge til en eksplisitt referanse erklærer plugin-modulen at den tillater at de refererte søkedeltakerne håndterer indekseringen av dokumenter med disse filtypene. For dokumenter som ikke er en del av innholdsfortegnelsen, er det ingen fare med dette. Av den grunn er de globale, og binding
brukes ikke.
Konfigurasjonskodetype:
<!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 - En unik ID for denne søkedeltakeren.
- name - Et valgfritt oversettbart navn som blir brukt til å representere deltakeren som en kategori av dokumenter som kan inkluderes i søket. Navnet er ikke nødvendig når deltakeren brukes for dokumenter i innholdsfortegnelsen (dvs. når attributtet
extensions
er definert).
- icon - Et valgfritt ikon som brukes til å konvertere søketreff fra dokumentene som er indeksert av denne deltakeren. Ikonet blir brukt for dokumenter utenfor hjelpens innholdsfortegnelse for å vise at det å åpne søketreffet kan resultere i en annen handling enn visning av vanlige hjelpedokumenter. Ikonet er derfor ikke nødvendig når deltakeren brukes for dokumenter i innholdsfortegnelsen (dvs. når attributtet
extensions
er definert).
- participant - (Ny i 3.2) Implementeringsklasse for hjelpens søkedeltaker. Denne klassen må implementere grensesnittet org.eclipse.help.search.ILuceneSearchParticipant. Dette attributtet kan utelates, og det nestede participant-elementet kan oppgis i stedet.
- extensions - Et valgfritt felt som inneholder listen over filtyper som søkedeltakeren kan håndtere. Dette er en streng som inneholder filtyper skilt av komma (f.eks. "abc, xyz"). Dette attributtet brukes når filene gjøres eksplisitt kjent for hjelpesystemet i utvidelsespunktet
org.eclipse.help.toc
. At dette attributtet ikke finnes, er et tegn på at deltakeren vil indeksere alle dokumenter som den er ansvarlig for, selv.
Merk at deltakerne som er registrert for kjente dokumenter, har plugin-omfang. Hvis du vil at en deltaker skal gjelde for dokumenter i en annen plugin-modul, må du bruke elementet binding
og utvide omfanget. På den annen side har deltakere som ikke spesifiserer dette attributtet, globalt omfang.
- headless - Angir om denne søkedeltakeren skal brukes ved kjøring av hjelpesystemet utenfor en Eclipse-arbeidsbenk, dvs. at den kjøres frittstående eller i infosenter-modus. Standardverdien er
false
(usann).
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - implementeringsklassen for hjelpesøkedeltakeren. Denne klassen må implementere grensesnittet org.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - navnet på en
parameter som sendes til implementeringsklassen.
- value - verdien av en
parameter som sendes til implementeringsklassen.
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - en referanse til søkedeltakeren som er deklarert et annet sted ved hjelp av
searchParticipant
-elementet. Binding kan brukes til å gjenbruke søkedeltakere i plugin-moduler uten å bryte ovenfra og ned-policyen. Binding er nødvendig bare for indeksering av dokumenter som inngår i innholdsfortegnelsen. Ellers har deltakeren globalt omfang.
Eksempler:
Her er et eksempel på bruk av utvidelsespunkt:
<extension point=
"org.eclipse.help.base.luceneSearchParticipant"
>
<searchParticipant id=
"org.eclipse.myGlobalParticipant"
name=
"Global deltaker"
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-informasjon:
Den oppgitte søkedeltakerklassen må utvide den abstrakte klassen org.eclipse.help.search.LuceneSearchParticipant.
Levert implementering:
Hjelpesystemet har en søkedeltaker for XHTML-filer (filtype xhtml). Plugin-moduler som har dynamiske XHTML-dokumenter som en del av innholdsfortegnelsen, må binde seg til denne deltakeren med elementet binding
og med org.eclipse.help.base.xhtml
som måldeltaker-ID.
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