| <!doctype html public "-//w3c//dtd html 4.0 transitional//en"> |
| <html> |
| |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <meta name="Author" content="IBM"> |
| <meta name="ProgId" content="FrontPage.Editor.Document"> |
| <title>Package-level Javadoc</title> |
| </head> |
| |
| <body> |
| |
| Provides the ability to add participants to help search and is responsible |
| for creating search indices. |
| <h2>Package Specification</h2> |
| <p>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 <tt>SearchParticipant</tt> abstract class and point to it |
| using the <tt>org.eclipse.help.search.searchParticipant</tt> extension point.</p> |
| <p>The package also provides an abstract class that extends <tt>LuceneSearchParticipant</tt> |
| called <tt>SearchParticipantXML</tt> which adds functionality for parsing XML |
| documents.</p> |
| |
| </body> |
| |
| </html> |
