Participantes de búsqueda de Lucene
Identificador:
org.eclipse.help.base.luceneSearchParticipants
Desde:
3.2
Descripción:
Este punto de extensión deberá utilizarse para añadir el
contenido del documento al índice de búsqueda de Lucene. Hay dos casos en los que será deseable añadir un participante
de búsqueda:
-
Para indexar documentos registrados con la TOC del sistema de ayuda que no forman parte del formato HTML (por ejemplo
XML.) En este caso, el participante debe declarar las extensiones de archivo que puede manejar. Se le llamará para
indexar cada documento coincidente. En este caso, el participante tiene el ámbito del plug-in.
-
Para indexar los documentos fuera de la TOC del sistema de ayuda. En este caso, al participante se le dará una opción
para indexar todos los documentos que conoce de una vez. Además, se delegará en el participante la tarea de abrir el
resultado de la búsqueda porque el sistema de ayuda no sabrá cómo abrir los documentos fuera de la TOC. En este caso, el
participante tiene un ámbito global.
Los participantes de búsqueda están asociados al plug-in en el que aparece la extensión. Para poder reutilizar el
participante en otros plug-ins, debe utilizarse binding
para hacer referencia a estos. Esta estrategia
evita que un plug-in imponga su participante en todo el producto para las extensiones de archivo con las que se
registró. Al añadir una referencia explícita, el plug-in declara que permite que el participante de búsqueda referido
maneje la indexación de los documentos con esas extensiones. Para los documentos que no forman parte de la TOC, no existe
ese peligro. Por esta razón, son globales y no debe utilizarse binding
.
Código de configuración:
<!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: identificador exclusivo de este participante de búsqueda
- name: nombre traducible opcional que se utilizará para representar el participante como una categoría de
documentos que puede incluirse en la búsqueda. El nombre no es necesario cuando se utiliza el participante para
documentos en la TOC (es decir, cuando se establece el atributo
extensions
.)
- icon: icono opcional que debe utilizarse para representar resultados de la búsqueda de los documentos
indexados por este participante. Se utilizará el icono para los documentos fuera de la TOC de la ayuda para indicar que
la apertura del resultado de la búsqueda puede llevar a una acción diferente de la de mostrar el documento de ayuda
normal. Po lo tanto, el icono no es necesario cuando se utiliza el participante para documentos en la TOC (es decir,
cuando se establece el atributo
extensions
.)
- participant: (nuevo en 3.2) la clase de implementación para el participante de la búsqueda
de ayuda. Esta clase debe implementar la interfaz org.eclipse.help.search.ILuceneSearchParticipant. Este
atributo puede omitirse, y en su lugar puede suministrarse el elemento anidado participant.
- extensions: campo opcional que contiene la lista de tipos de archivo manejada por el participante de
búsqueda. Es una serie que contiene extensiones de archivo separadas por comas (por ejemplo "abc, xyz"). Este atributo
debe utilizarse cuando se dan a conocer explícitamente al sistema de ayuda los archivos del punto de extensión
org.eclipse.help.toc
. La ausencia de este atributo es una indicación de que el participante indexará todos
los documentos si es responsable por sí mismo.
Tenga en cuenta también que los participantes registrados para los documentos conocidos tienen ámbito de plug-in. Si
desea que un participante se aplique a documentos de otro plug-in, debe utilizar el elemento binding
para
ampliar el ámbito. Por contraste, los participantes que no especifican este atributo tienen un ámbito global.
- headless: especifica si este participante de búsqueda deben utilizarse o no al ejecutar el sistema de ayuda
fuera de un entorno de trabajo de eclipse, es decir se ejecuta en modalidad autónoma o de infocenter. El valor
predeterminado es
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class: clase de implementación para el participante de búsqueda de ayuda. Esta clase debe implementar la
interfaz org.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name: nombre de un parámetro pasado a la clase de implementación
- value: valor de un parámetro pasado a la clase de implementación
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId: una referencia al participante de búsqueda declarado en alguna parte utilizando el elemento
searchParticipant
. El enlace puede utilizarse para reutilizar participantes de búsqueda en plug-ins sin
violar la política de de arriba abajo. El enlace solo es necesario para indexar documentos que forman parte de la TOC.
De lo contrario, el participante tiene un ámbito global.
Ejemplos:
A continuación figura una utilización de ejemplo del punto de extensión:
<extension point=
"org.eclipse.help.base.luceneSearchParticipant"
>
<searchParticipant id=
"org.eclipse.myGlobalParticipant"
name=
"Participante global"
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>
Información sobre la API:
La clase del participante de búsqueda proporcionada
debe ampliar la clase abstracta org.eclipse.help.search.LuceneSearchParticipant.
Implementación suministrada:
El sistema de ayuda proporciona el participante
de búsqueda para los archivos XHTML (extensión xhtml.) Los plug-ins que tienen documentos XHTML dinámicos como parte
del TOC deben enlazar con este participante utilizando el elemento binding
y
org.eclipse.help.base.xhtml
como el id participante destino.
Copyright (c) 2005, 2006 IBM Corporation y otros.
Reservados todos los derechos. Este programa y sus materiales adjuntos están
disponibles bajo los términos de la licencia pública común (Eclipse Public
License) v1.0 que acompaña a esta distribución, y está disponible en
http://www.eclipse.org/legal/epl-v10.html