Package org.eclipse.help
Provides core help system for the platform.
Package Specification
There is a general mechanism (defined at the plug-in level) by which individual plug-ins contribute online help and context-sensitive help for their component. This package defines interfaces for data objects managed by help systems, as well asHelpSystem class which static methods can be used to obtain objects
managed by the help system.-
Interface Summary Interface Description IAnchor Specifies a location in a document where other plug-ins may contribute additional content.ICommandLink Represents a link with text that invokes a specific command with parameters.IContentExtension An extension of a document's content.IContext A context registered for context-sensitive help.IContext2 ExtendsIContextto provide support for styled text and topic categorization.IContext3 ExtendsIContext2to provide support for related command links.IContextProvider Dynamic context provider.ICriteria A directive indicating the criteria information of a Toc or Topic described in xmlICriteriaDefinition ICriteriaDefinition represents the criteria definition of one plug-in.ICriteriaDefinitionContribution Represents criteria definition contributionICriterionDefinition ICriterionDefinition represents a single criterion definition of the help content.ICriterionValueDefinition ICriterionValueDefinition represents one criterion value definition of one criterion.IHelp Deprecated. marked for deletion, see Bug 442959.IHelpContentProducer Producer capable of generating or otherwise obtaining contents for help resources.IHelpResource A help resource, usually a help topic.IInclude A directive indicating the content at the given path should be included in this document, and replace this node.IIndex IIndex represents metaphor of the book index.IIndexContribution Represents either a complete or partial keyword index, as well as its metadata.IIndexEntry IIndexEntry represents a single entry of the help index.IIndexEntry2 IIndexEntry2 is an index entry which may have see elements as childrenIIndexSee An entry that represents a see also node in the index.IIndexSubpath A directive indicating the content at the given path should be included in this document, and replace this node.ILink A directive indicating a link to another toc to be inserted at (and replace) this link.ILiveHelpAction Live Help Extension.IToc AnITocrepresents the root node of a toc, for either a complete toc (book) or a part of one to be assembled into a larger one.IToc2 IToc2extendsITocby adding methods to support functionality for criteria, topic sorting and custom iconsITocContribution Represents either a complete or partial table of contents, as well as its metadata.ITopic AnITopicis one topic in the table of contents, which may contain subtopics.ITopic2 ITopic2extendsITopicby adding methods to support functionality for criteria, topic sorting and custom iconsIUAElement An element in a UA document, which may have conditional enablement (may be filtered based on certain conditions) and may have sub-elements, or children. -
Class Summary Class Description AbstractContentExtensionProvider AnAbstractContentExtensionProvideris a mechanism to provide arbitrary content extensions (e.g. contributions to anchors or element replacements).AbstractContextProvider AnAbstractContextProvideris a mechanism to provide arbitrary context-sensitive help for any part of the UI.AbstractCriteriaDefinitionProvider AnAbstractCriteriaDefinitionProvideris a mechanism to provide display name for criteria attached to toc or topic.AbstractCriteriaProvider AbstractCriteriaProvideris a mechanism for assigning criteria toITopicandITocelements independent of a table of contents file.AbstractIndexProvider AnAbstractIndexProvideris a mechanism to provide arbitrary content to the keyword index.AbstractTocProvider AnAbstractTocProvideris a mechanism to provide arbitrary content to the table of contents (TOC).HelpSystem This class provides general access to help content contributed to the"org.eclipse.help.toc"and"org.eclipse.help.contexts"extension points.UAContentFilter This class provides the ability to filter out user assistance model elements that support filtering (e.g.