Participantes da Pesquisa Lucene
Identificador:
org.eclipse.help.base.luceneSearchParticipants
A partir de:
3.2
Descrição:
Este ponto de extensão
deve ser usado para adicionar conteúdos de documentos ao índice de pesquisa Lucene.
Existem dois casos em que deve adicionar um participante de pesquisa:
-
Para indexar documentos registados com um TOC do sistema de ajuda que não seja
do formato HTML (como por exemplo, XML).
Neste caso, o participante tem de declarar as extensões de ficheiros que consegue processar.
O participante será chamado para indexar cada documento correspondente. Neste
caso, o participante contém o âmbito do plug-in.
-
Para indexar documentos fora do TOC do sistema de ajuda. Neste caso, o
participante terá a oportunidade de indexar todos os documentos que conhece de uma só vez.
Além disso, será delegada a tarefa de abrir o resultado da pesquisa ao
participante, uma vez que o sistema de ajuda não saberá como abrir os documentos fora do TOC.
Neste caso, o participante tem um âmbito global.
Os participantes de pesquisa estão associados ao plug-in em que a extensão aparece.
Para reutilizar o participante noutros plug-ins, deverá ser utilizado a
binding
para os referenciar. Esta estratégia impede que um plug-in
imponha o seu participante em todo o produto para as extensões do ficheiro com
o qual foi registado.
Ao adicionar uma referência explícita, o plug-in declara que permite que o
participante de pesquisa referido processe a indexação dos documentos que
tenham essas extensões.
Os documentos que não fazem parte do TOC não correm esse perigo.
Por esse motivo, são esses documentos são globais e a binding
não
deve ser utilizada.
Marcação da Configuração:
<!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 - um identificador único deste participante de pesquisa
- name - um nome opcional traduzível que será utilizado para
representar o participante como sendo uma categoria de documentos que podem ser
incluídos na pesquisa.
O nome não é requerido quando o participante é utilizado para documento no TOC
(ou seja, quando o atributo
extensions
é definido).
- icon - um ícone opcional para ser utilizado para representar os acertos
de pesquisa dos documentos indexados por este participante.
O ícone será utilizado para os documentos fora do TOC de ajuda, para indicar
que a abertura dos acertos de pesquisa poderá resultar numa acção que não seja
a de mostrar o documento de ajuda normal.
Por conseguinte, o ícone não é requerido quando o participante é utilizado para
documento no TOC (ou seja, quando o atributo
extensions
é
definido).
- participant - (novo no 3.2) a classe de
implementação do participante de pesquisa de ajuda.
Esta classe tem de implementar a interface
org.eclipse.help.search.ILuceneSearchParticipant. Este atributo
pode ser omitido e, no seu lugar, pode ser facultado o elemento imbricado
participant.
- extensions - um campo opcional que contém a lista de tipos de
ficheiros processados pelo participante de pesquisa.
É uma cadeia que contém extensões de ficheiros separadas por vírgulas (como por
exemplo, "abc, xyz"). Este atributo deverá ser utilizado quando os ficheiros
são dados a conhecer explicitamente ao sistema de ajuda no ponto de extensão
org.eclipse.help.toc
. A ausência deste atributo é uma indicação de
que o participante irá indexar todos os documentos pelos quais é responsável.
Repare também que os participantes registados em documentos conhecidos têm o
âmbito do plug-in.
Se pretende que um participante seja aplicado aos documentos que se encontrem
noutro plug-in, tem de utilizar o elemento binding
para expandir o âmbito. Por outro lado, os participantes que não especificam este atributo têm um âmbito global.
- headless - especifica se este participante de pesquisa deverá ou não
ser utilizado ao executar o sistema de ajuda fora de uma área de trabalho do
eclipse, ou seja, está a ser executado em modo autónomo ou de centro de informações.
O valor predefinido é
false
.
<!ELEMENT participant
(parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - a classe de implementação para o participante de pesquisa de ajuda.
Esta classe tem de implementar a interface
org.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - o nome de um parâmetro transmitido à classe de implementação
- value - o valor de um parâmetro transmitido à classe de implementação
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - uma referência ao participante de pesquisa declarado
noutro sítio através da utilização de um elemento
searchParticipant
.
A associação pode ser utilizada para reutilizar os participantes de pesquisa
nos plug-ins, sem violar a política de cima para baixo.
A associação é apenas necessária para indexar documentos que fazem parte do TOC.
Caso contrário, o participante tem um âmbito global.
Exemplos:
De seguida é apresentado
um exemplo de utilização do ponto de extensão:
<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>
Informações de API:
A classe de
participante de pesquisa fornecida tem de expandir a classe abstracta
org.eclipse.help.search.LuceneSearchParticipant.
Implementação Facultada:
O sistema de
ajuda faculta o participante de pesquisa para ficheiros XHTML (extensão xhtml).
Os plug-ins que contêm documentos XHTML dinâmicos como parte do TOC têm de se
associar a este participante através da utilização do elemento
binding
e de org.eclipse.help.base.xhtml
como id do participante de destino.
Copyright (c) 2005, 2006 IBM Corporation e outros.
Todos os direitos reservados. Este programa e os materiais que o acompanham estão disponíveis sob os termos da Eclipse Public License v1.0, que acompanha esta distribuição, e estão disponíveis em http://www.eclipse.org/legal/epl-v10.html