Lucene-deltagersøgning
Id:
org.eclipse.help.base.luceneSearchParticipants
Fra:
3.2
Beskrivelse:
Dette udvidelsespunkt bruges til at tilføje dokumentindhold til Lucenes søgeindeks. I to tilfælde kan du ønske at tilføje en søgedeltager:
-
For at indeksere dokumenter, der er registreret med hjælpens TOC, der ikke er i HTML-format, f.eks. XML. I dette tilfælde skal deltageren erklære filtyper, den kan håndtere. Den kaldes for at indeksere alle matchende dokumenter. I dette tilfælde har deltageren plugin-omfanget.
-
For at indeksere dokumenter uden for hjælpens TOC. I dette tilfælde får deltageren en mulighed for at indeksere alle dokumenter, den kender til, på en gang. Desuden vil deltageren få delegeret opgaven at åbne søgeresultatet, fordi hjælpesystemet ikke ved, hvordan dette dokument skal åbnes uden for TOC. I dette tilfælde har deltageren globalt omfang.
Søgedeltagere er knyttet til den plugin, udvidelsen vises i. Hvis du vil genbruge deltageren i andre plugins, skal der anvendes binding
for at henvise til dem. Denne strategi forhindrer en plugin i at forstyrre dens deltagere i hele produktet for de filudvidelser, den blev registreret med. Ved at tilføje en eksplicit reference erklærer plugin'en at den tillader den søgedeltager, der henvises til, at håndtere indeksering af dokumenter med disse filtyper. For dokumenter, der ikke er en del af TOC, er der ikke en sådan fare. Af denne grund er de globale, og binding
bør ikke anvendes.
Konfigurationskode:
<!ELEMENT extension (searchParticipant | binding)>
<!ATTLIST-udvidelse
point CDATA #REQUIRED
id CDATA #IMPLIED
navn 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 entydig id på søgedeltageren
- name - et valgfrit konverterbart navn, der anvendes til at præsentere deltagerne som en kategori af dokumenter, der kan inkluderes i søgningen. Navnet kræves ikke, når deltageren anvendes til dokumenter i TOC, dvs. når attributten
extensions
er angivet.
- icon - en valgfri ikon, der anvendes til at præsentere søgeforekomster fra de indekserede dokumenter fra denne deltager. Ikonen bliver anvendt til dokumenter uden for hjælpens TOC for at angive, at åbning af søgeforekomster kan resultere i en funktion, der er en anden end fremvisning af det regulære hjælpedokument. Derfor er ikoner ikke påkrævet, når deltageren anvendes til dokumenter i TOC, dvs. når attributten
extensions
er angivet.
- participant - (ny i 3.2) implementeringsklassen til søgedeltageren i hjælpen. Denne klasse skal implementere grænsefladen org.eclipse.help.search.ILuceneSearchParticipant. Denne attribut kan udelades, og det indlejrede element participant kan leveres i stedet for.
- extensions - et valgfrit felt, der indeholder listen over filtyper, der behandles af søgedeltageren. Dette er en streng, som indeholder kommaseparerede filtyper, f.eks. "abc, xyz". Denne attribut skal anvendes, når filer gøres eksplicit kendt for hjælpen i udvidelsespunktet
org.eclipse.help.toc
. Fraværet af denne attribut er en indikation om, at deltageren vil indeksere alle dokumenter, den selv er ansvarlig for.
Bemærk også, at deltagere, der er registreret for kendte dokumenter, har plugin-omfang. Hvis du vil have en deltager til at anvende dokumenter i andre plugins, skal du bruge elementet binding
til at udvide omfanget.
Modsat deltagere, der ikke angiver denne attribut med globalt omfang.
- headless - angiver, om denne søgedeltager skal anvendes, når hjælpen udføres uden for en Eclipse-arbejdsbænk, dvs. at den udføres i enten i tilstanden enkeltstående eller infocenter. Standardværdien er
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - implementeringsklassen for søgedeltageren i hjælpen. Dette klasseelement må implementere grænsefladenorg.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - navn på en parameter, der sendes til
implementeringsklassen
- value - værdien for en parameter, der sendes til
implementeringsklassen
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - en reference til søgedeltageren, der er er erklæret et andet sted vha. elementet
searchParticipant
. Binding kan anvendes til at genbruge søgedeltagere i plugins uden at krænke Top ned-reglen. Binding er kun nødvendig for indeksering af dokumenter, der er en del af TOC. Ellers har deltagere globalt omfang.
Eksempler:
Det følgende er et eksempel på brug af udvidelsespunktet:
<udvidelsespunkt=
"org.eclipse.help.base.luceneSearchParticipant"
>
<searchParticipant id=
"org.eclipse.myGlobalParticipant"
name=
"Global deltager"
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-oplysninger:
Den leverede søgedeltagerklasse skal udvide den abstrakte klasse org.eclipse.help.search.LuceneSearchParticipant.
Leveret implementering:
Hjælpen stiller søgedeltagere til XHTML-filer (filtypen xhtml) til rådighed. Plugins, der har dynamiske XHTML-dokumenter som en del af TOC, skal bindes til deltageren vha. elementet binding
og org.eclipse.help.base.xhtml
som måldeltager-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