Partecipanti di ricerca Lucene
Identificativo:
org.eclipse.help.base.luceneSearchParticipants
Da:
3.2
Descrizione:
Questo punto di estensione deve essere utilizzato per aggiungere contenuto di documento all'indice di ricerca Lucene. Due sono i casi in cui è possibile aggiungere un partecipante di ricerca:
-
Per indicizzare i documenti registrati con il sommario della guida non in formato HTML (ad esempio, XML). In questo caso, il partecipante deve dichiarare le estensioni file che può gestire. Verrà richiamato per indicizzare tutti i documenti corrispondenti. In questo caso, il partecipante dispone dell'ambito del plugin.
-
Per indicizzare i documenti esterni al sommario della guida. In questo caso, il partecipante potrà indicizzare tutti i documenti noti in una sola volta. Inoltre il partecipante dovrà aprire i risultati della ricerca perché la guida non è in grado di aprire documenti esterni al sommario. In questo caso, il partecipante dispone dell'ambito globale.
I partencipanti alla ricerca sono associati al plugin in cui appare l'estensione. Per riutilizzare il partecipante in altri plugin, utilizzare binding
per creare riferimenti. Questa strategia impedisce al plugin di imporre i propri partecipanti all'intero prodotto per le estensioni file con cui è stato registrato. Aggiungendo un riferimento esplicito, il plugin dichiara che consente ai partecipanti alla ricerca di riferimento di gestire l'indicizzazione dei documenti con tali estensioni. Per i documenti che non fanno parte del sommario, non esiste questo rischio. Per questo motivo, sono globali e non deve essere utilizzato binding
.
Markup di configurazione:
<!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 - un identificativo univoco per questo partecipante alla ricerca
- name - un nome facoltativo traducibile che verrà utilizzato per rappresentare il partecipante come una categoria di documenti che possono essere inclusi nella ricerca. Il nome non è richiesto quando il partecipante viene utilizzato per i documenti nel sommario (ad esempio, quando è impostato l'attributo
extensions
).
- icon - un'icona facoltativa da utilizzare per rendere i suggerimenti di ricerca dai documenti indicizzati da questo partecipante. L'icona verrà utilizzata per i documenti esterni al sommario della guida per indicare che aprendo i risultati della ricerca potrebbe non essere visualizzato un documento regolare della guida. Di conseguenza, il nome non è richiesto quando il partecipante viene utilizzato per i documenti nel sommario (ad esempio, quando è impostato l'attributo
extensions
).
- participant - (nuovo in 3.2) la classe di implementazione per il partecipante alla ricerca. Questa classe deve implementare l'interfaccia org.eclipse.help.search.ILuceneSearchParticipant. Questo attributo può essere
omesso, in tal caso verrà fornito l'elemento nidificato participant.
- extensions - un campo facoltativo che contiene l'elenco dei tipi di file gestiti dal partecipante alla ricerca. Si tratta di una stringa contenente estensioni file separate da virgole (ad esempio, "abc, xyz"). Questo attributo deve essere utilizzato quando i file vengono resi noti esplicitamente alla guida nel punto di estensione
org.eclipse.help.toc
. L'assenza di questo attributo indica che il partecipante che indicizzerà tutti i documenti è auto-responsabile.
Tenere presente che i partecipanti registrati per documenti noti hanno ambito di plugin. Se si desidera che un partecipante venga applicato ai documenti in un altro plugin, è necessario utilizzare l'elemento binding
per ampliare l'ambito. Al contrario, i partecipanti che non specificano questo attributo hanno ambito globale.
- headless - specifica se utilizzare o meno di utilizzare questo partecipante alla ricerca quando si esegue la guida esternamente al workbench eclipse, ad esempio, se viene eseguita in modalità autonoma o in modalità centro di informazioni. Il valore predefinito è
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - classe di implementazione per il partecipante alla ricerca della guida. Questa classe deve implementare l'interfaccia org.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - nome di un parametro trasferito alla classe di implementazione
- value - valore di un parametro trasferito alla classe di implementazione
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - un riferimento al partecipande alla ricerca dichiarato altrove utilizzando l'elemento
searchParticipant
. È possibile utilizzare il binding per riutilizzare i partecipanti alla ricerca nei plugin senza vialare il criterio top-down. Il binding è necessario solo per indicizzare i documenti che fanno parte del sommario. In caso contrario il partecipante disporrà dell'ambito globale.
Esempi:
Di seguito è riportato un utilizzo esemplificativo del punto di estensione:
<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>
Informazioni API:
Il partecipante alla ricerca fornito deve estendere la classe astratta org.eclipse.help.search.LuceneSearchParticipant.
Implementazione fornita:
Il sistema della guida fornisce il partecipante alla ricerca per i file XHTML (estensione xhtml). I plugin con documenti XHTML dinamici come parte del sommario devono essere associati al partecipante mediante l'elemento binding
e org.eclipse.help.base.xhtml
come id del partecipante di destinazione.
Copyright (c) 2005, 2006 IBM Corporation and others.
Tutti i diritti riservati. Questo programma e il materiale di accompagnamento sono disponibili secondo i termini della Eclipse Public
License v1.0 che sono distribuiti con il prodotto, e disponibili all'indirizzo
http://www.eclipse.org/legal/epl-v10.html