Participantes de Procura Lucene
Identificador:
org.eclipse.help.base.luceneSearchParticipants
Desde:
3.2
Descrição:
Este ponto de extensão deve ser utilizado para incluir conteúdo de documento no
índice de procura Lucene. Há dois casos em que você gostaria de incluir um
participante de procura:
-
Para indexar documentos registrados no TOC do sistema de ajuda que não são do formato
HTML (por exemplo, XML). Nesse caso, o participante deve declarar as extensões de arquivo
que ele pode manipular. Ele será chamado para indexar cada documento de correspondência. Nesse
caso, o participante tem o escopo de plug-in.
-
Para indexar documentos fora do TOC do sistema de ajuda. Nesse caso, será fornecida ao
participante uma oportunidade para indexar ao mesmo tempo todos os documentos que ele
conhece. Além disso, será delegada ao participante a tarefa de abrir o resultado da
procura porque o sistema de ajuda não saberá como abrir os documentos fora do TOC. Nesse
caso, o participante tem escopo global.
Os participantes da procura estão associados ao plug-in no qual a extensão aparece. Para
reutilizar o participante em outros plug-ins, a ligação
deve ser
utilizada para fazer referência a eles. Essa estratégia impede um plug-in de impor seu
participante no produto inteiro relativamente às extensões de arquivo nas quais ele foi
registrado. Incluindo uma referência explícita, o plug-in declara que ele permite que o
participante da procura referencial manipule a indexação de documentos com essas
extensões. Para documentos que não fazem parte do TOC, esse tipo de perigo não existe. Por
essa razão, eles são globais e a ligação
não deverá 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 exclusivo desse participante da procura
- name - um nome opcional traduzível que será utilizado para representar o
participante como uma categoria de documentos que pode ser incluída na procura. O nome
não é necessário quando o participante é utilizado para documentos no TOC (por exemplo,
quando o atributo
extensions
está definido).
- icon - um ícone opcional a ser utilizado para renderizar dicas de procura dos
documentos indexados por esse participante. O ícone será utilizado para os documentos
fora do TOC da ajuda para indicar que a abertura da dica de procura pode resultar em uma
ação diferente de mostrar o documento de ajuda comum. Conseqüentemente, o ícone não é
necessário quando o participante é utilizado para documentos no TOC (por exemplo, quando
o atributo
extensions
está definido).
- participant - (novo na 3.2) a classe de implementação para o
participante da procura da ajuda. Essa classe deve implementar a interface
org.eclipse.help.search.ILuceneSearchParticipant. Esse atributo pode ser
omitido e o elemento participant aninhado pode ser fornecido em seu lugar.
- extensions - um campo opcional contendo a lista de tipos de arquivos
manipulados pelo participante da procura. Essa é uma cadeia contendo extensões de
arquivos separados por vírgula (por exemplo, "abc, xyz"). Esse atributo deve ser
utilizado quando os arquivos se tornam explicitamente conhecidos do sistema de ajuda no
ponto de extensão
org.eclipse.help.toc
. A ausência desse atributo é uma
indicação de que o participante indexará sozinho todos os documentos pelos quais ele é
responsável.
Observe também que os participantes registrados em documentos conhecidos têm escopo
de plug-in. Se você quiser um participante para aplicar aos documentos em outro plug-in,
utilize o elemento ligação
para estender o escopo. Em comparação, os
participantes que não especificam esse atributo têm escopo global.
- headless - especifica se esse participante da procura deve ou não ser
utilizado ao executar o sistema de ajuda fora de um workbench eclipse, isto é, em
execução no modo independente ou infocenter. O valor padrão é
false
.
<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED>
- class - a classe de implementação para o participante da procura da ajuda.
Essa classe deve implementar a interface
org.eclipse.help.search.ILuceneSearchParticipant.
<!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED>
- name - nome de um parâmetro transmitido à classe de implementação
- value - valor de um parâmetro transmitido para a classe de implementação
<!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId CDATA #IMPLIED>
- participantId - uma referência ao participante da procura declarado em outro
local utilizando o elemento
searchParticipant
. A ligação pode ser usada
para reutilizar os participantes da procura nos plug-ins sem violar a política descendente. A
ligação só será necessária para indexar os documentos que fazem parte do TOC. Caso
contrário, o participante tem escopo global.
Exemplos:
Segue uma amostra de uso do ponto
de extensão:
<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>
Informações da API:
A classe fornecida do
participante da procura deve estender a classe abstrata
org.eclipse.help.search.LuceneSearchParticipant.
Implementações Fornecidas:
O sistema de ajuda
fornece o participante da procura para arquivos XHTML (extensão xhtml). Plug-ins que
têm documentos XHTML dinâmicos como parte do TOC devem ser ligados a esse participante
utilizando o elemento ligação
e org.eclipse.help.base.xhtml
como o id do participante de destino.
Copyright (c) 2005, 2006 IBM Corporation e terceiros.
Todos os direitos reservados. Este programa e os materiais fornecidos com ele são
disponibilizados sob os termos da Licença Pública do Eclipse v1.0 que acompanha
esta distribuição e está disponível em
http://www.eclipse.org/legal/epl-v10.html