In Eclipse 3.6 the announcement was made that this API is deprecated and will be removed in a future release. Use org.eclipse.help.base.searchParticipant as a replacement.
This extension point should be used to add document content to the Lucene search index. There are two cases were you would want to add a search participant:
Search participants are associated with the plug-in the extension appears in. In order to reuse the participant in other plug-ins, binding
should be used to reference them. This strategy prevents a plug-in from imposing its participant on the entire product for the file extensions it was registered with. By adding an explicit reference, the plug-in declares that it allows the referenced search participant to handle indexing of documents with those extensions. For documents that are not part of the TOC, there is no such danger. For this reason, they are global and binding
should not be used.
<!ELEMENT extension (searchParticipant | binding)+>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED
>This extension point is deprecated because it depends on API classes which expose Lucene classes, which are not binary compatible between major release. The extension point org.eclipse.help.base.searchParticipant should be used instead.
<!ELEMENT searchParticipant (participant?)>
<!ATTLIST searchParticipant
id CDATA #REQUIRED
name CDATA #IMPLIED
icon CDATA #IMPLIED
participant CDATA #IMPLIED
extensions CDATA #IMPLIED
headless (true | false) "false"
>extensions
attribute is set).extensions
attribute is set).org.eclipse.help.toc
extension point. The absence of this attribute is an indication that the participant will index all the documents it is responsible for by itself.
Note also that participants that are registered for known documents have plug-in scope. If you want a participant to apply to documents in another plug-in, you must use the binding
element to extend the scope. In contrast, participants that do not specify this attribute have global scope.
false
.<!ELEMENT participant (parameter*)>
<!ATTLIST participant
class CDATA #IMPLIED
><!ELEMENT parameter EMPTY>
<!ATTLIST parameter
name CDATA #REQUIRED
value CDATA #REQUIRED
><!ELEMENT binding EMPTY>
<!ATTLIST binding
participantId IDREF #IMPLIED
>searchParticipant
element. Binding can be used to reuse search participants in plug-ins without violating the top-down policy. Binding is only needed for indexing documents that are part of the TOC. Otherwise, participant has global scope.
<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>
binding
element and org.eclipse.help.base.xhtml
as the target participant id.
Copyright (c) 2005, 2010 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made
available under the terms of the Eclipse Public License v1.0 which accompanies
this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html