Help Search Participant

Identifier:

Since:

Description:

1. To index documents registered with the help system's TOC that are not of the HTML format (e.g. XML). In this case, the participant must declare file extensions it can handle. It will be called to index each matching document. In this case, the participant has the plug-in scope.
2. To index documents outside of the help system's TOC. In this case, the participant will be given a chance to index all the documents it knows about at once. In addition, the participant will be delegated the task of opening the search result because the help system will not know how to open the documents outside the TOC. In this case, the participant has global scope.

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.

Configuration Markup:

<!ELEMENT extension (searchParticipant | binding)+>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>

<!ELEMENT searchParticipant EMPTY>

<!ATTLIST searchParticipant

id          CDATA #REQUIRED

name        CDATA #IMPLIED

icon        CDATA #IMPLIED

participant CDATA #REQUIRED

extensions  CDATA #IMPLIED

headless    (true | false) "false">

• id - a unique identifier of this search participant
• name - an optional translatable name that will be used to represent the participant as a category of documents that can be included in the search. The name is not required when the participant is used for documents in the TOC (i.e. when extensions attribute is set).
• icon - an optional icon to be used to render search hits from the documents indexed by this participant. The icon will be used for the documents outside of the help's TOC to indicate that opening the search hit may result in an action different from showing the regular help document. Consequently, icon is not required when the participant is used for documents in the TOC (i.e. when extensions attribute is set).
• participant - The implementation class for the help search participant. This class must implement the org.eclipse.help.search.SearchParticipant interface. This attribute may be omitted, and the nested participant element may be provided instead.
• extensions - an optional field containing the list of file types handled by the search participant. This is a string containing comma separate file extensions (e.g. "abc, xyz"). This attribute should be used when files are made explicitly known to the help system in the 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.

• headless - specifies whether or not this search participant should be used when running the help system outside an eclipse workbench, i.e. it is running in either standalone or infocenter mode. The default value is false.

<!ELEMENT binding EMPTY>

<!ATTLIST binding

participantId IDREF #IMPLIED>

• participantId - a reference to the search participant declared elsewhere using 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.

Examples:

  <extension point="org.eclipse.help.base.searchParticipant">
   <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>

API Information:

Copyright (c) 2010, 2012 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0