Participants à la recherche Lucene
Identificateur :
org.eclipse.help.base.luceneSearchParticipants
Depuis la version :
3.2
Description :
Ce point d'extension doit être utilisé pour ajouter le contenu d'un document à l'index de recherche Lucene. Il est nécessaire d'ajouter un participant à la recherche dans deux cas :
-
Pour indexer des documents enregistrés avec la table des matières du système d'aide qui ne sont pas au format HTML (par exemple, XML). Dans ce cas, le participant doit déclarer les extensions de fichier qu'il peut traiter. Il sera appelé pour indexer le document correspondant. Le participant bénéficie alors de la portée du plug-in.
-
Pour indexer des documents en dehors de la table des matières du système d'aide. Dans ce cas, le participant aura la possibilité d'indexer tous les documents qu'il connaît en une fois. En outre, le participant se verra déléguer la tâche d'ouverture du résultat de la recherche car le système d'aide ne sera pas comment ouvrir les documents en dehors de la table des matières. Le participant bénéficie alors de la portée globale.
Les participants à la recherche sont associés au plug-in dans lequel l'extension apparaît. Pour réutiliser le participant dans d'autres plug-ins, l'élément binding
doit être utilisé pour les référencer. Cette stratégie empêche un plug-in d'imposer son participant sur l'ensemble du produit pour les extensions de fichier avec lesquelles il a été enregistré. En ajoutant une référence explicite, le plug-in déclare qu'il permet au participant de recherche référencé d'assurer l'indexation des documents avec ces extensions. Pour les documents qui ne font pas partie de la table des matières, ce risque n'existe pas. Pour cette raison, ils sont globaux et l'élément binding
ne doit pas être utilisé.
Marques de configuration :
<!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 : identificateur unique de ce participant à la recherche
- name : nom facultatif traduisible qui sera utilisé pour représenter le participant sous la forme d'une catégorie de documents susceptibles d'être inclus dans la recherche. Le nom n'est pas obligatoire lorsque le participant est utilisé pour des documents présentés dans la table des matières (à savoir, lorsque l'attribut
extensions
est défini).
- icon : icône facultative à utiliser pour afficher les astuces de recherche dans les documents indexés par ce participant. L'icône sera utilisée pour les documents en dehors de la table des matières de l'aide pour indiquer que l'ouverture du résultat de la recherche peut se solder par une action autre que l'affichage du document d'aide normal. Par conséquent, l'icône n'est pas obligatoire lorsque le participant est utilisé pour des documents présentés dans la table des matières (à savoir, lorsque l'attribut
extensions
est défini).
- participant : (nouveau dans la version 3.2) classe d'implémentation du participant à la recherche de l'aide. Cette classe doit implémenter l'interface org.eclipse.help.search.ILuceneSearchParticipant. Cet attribut est facultatif et l'élément participant imbriqué peut être fourni à sa place.
- extensions : zone facultative contenant la liste des types de
fichier gérés par le participant à la recherche. Il s'agit d'une chaîne contenant des
extensions de fichier séparées par des virgules (par exemple, "abc, xyz"). Cet attribut doit être utilisé lorsque les fichiers sont explicitement portés à la connaissance du système d'aide dans le point d'extension
org.eclipse.help.toc
. L'absence de cet attribut indique que le participant indexera lui-même tous les documents à sa charge.
Les participants enregistrés pour les documents connus ont également la portée du plug-in. Si vous voulez qu'un participant s'applique aux documents dans un autre plug-in, vous devez utiliser l'élément binding
pour étendre la portée. Au contraire, les participants qui n'indiquent pas cet attribut bénéficient d'une portée globale.
- headless : indique si ce participant à la recherche doit être utilisé lors de l'exécution du système d'aide en dehors d'un plan de travail Eclipse, c'est-à-dire, exécuté en mode autonome ou en mode centre de documentation. La valeur par défaut est
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class : classe d'implémentation du participant à la recherche de l'aide. Cette classe doit implémenter l'interface org.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT
parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name : nom du paramètre transmis à la classe d'implémentation
- value : valeur d'un paramètre transmis à la classe d'implémentation
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId : référence au participant à la recherche déclaré ailleurs à l'aide de l'élément
searchParticipant
. La liaison peut être utilisée pour réutiliser les participants à la recherche dans des plug-ins sans enfreindre la règle haut-bas. Elle est nécessaire uniquement pour l'indexation des documents faisant partie de la table des matières. Dans le cas contraire, le participant bénéficie de la portée globale.
Exemples :
L'exemple
ci-dessous illustre l'utilisation d'un point d'extension :
<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>
Informations d'API :
La classe du participant à la recherche fournie doit étendre la classe abstraite org.eclipse.help.search.LuceneSearchParticipant.
Implémentation fournie :
Le système d'aide fournit un participant à la recherche pour les fichiers XHTML (extension xhtml). Les plug-ins ayant des documents XHTML dynamiques dans leur table des matières doivent effectuer une liaison à ce participant à l'aide de l'élément binding
et de org.eclipse.help.base.xhtml
comme ID de participant cible.
Copyright (c) 2005, 2006 IBM Corporation and others.
All rights reserved. Ce programme et les produits associés sont
distribués sous licence v1.0 et disponibles à
l'adresse suivante :
http://www.eclipse.org/legal/epl-v10.html