This package contains the API for adding content to the help search functionality
and is responsible for indexing all contents of the help system. To add content, a
plug-in must extend the
SearchParticipant abstract class and point to it
org.eclipse.help.search.searchParticipant extension point.
The package also provides an abstract class that extends
SearchParticipantXML which adds functionality for parsing XML
Interface Summary Interface Description IHelpSearchIndexRepresents a Lucene index for one locale. ISearchDocumentRepresents a document in the search index. ISearchEngineA search engine that is a participant in the help search. ISearchEngine2An extension of the search engine interface that provides for opening of the results. ISearchEngineResultA search result created by the help search engine. ISearchEngineResult2An extension of the search result interface that allows engines to define engine result icon for each search result. ISearchEngineResultCollectorA collector for the search hits (asynchronously) returned by the help search participants. ISearchResultThis class holds information for a single Search Result ISearchScopeThe generic search scope object. SearchParticipantXML.IParsedXMLContentClass that implements this interface is used to store data obtained during the parsing phase.
Class Summary Class Description AbstractSearchProcessorThis class is responsible for handling any pre or post search processing events, including query manipulation and output to the search frame. HelpIndexBuilderBuilds a help search index for a plug-in by looking for the
org.eclipse.help.tocextensions in the provided manifest file.
SearchParticipantParticipant in the help search. SearchParticipantXMLAn abstract search participants for adding XML documents to the search index. SearchProcessorInfoThis class is a storage container for search processing