Package org.eclipse.help
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.-
ClassDescriptionAn
AbstractContentExtensionProvider
is a mechanism to provide arbitrary content extensions (e.g. contributions to anchors or element replacements).AnAbstractContextProvider
is a mechanism to provide arbitrary context-sensitive help for any part of the UI.AnAbstractCriteriaDefinitionProvider
is a mechanism to provide display name for criteria attached to toc or topic.AbstractCriteriaProvider
is a mechanism for assigning criteria toITopic
andIToc
elements independent of a table of contents file.AnAbstractIndexProvider
is a mechanism to provide arbitrary content to the keyword index.AnAbstractTocProvider
is a mechanism to provide arbitrary content to the table of contents (TOC).This class provides general access to help content contributed to the"org.eclipse.help.toc"
and"org.eclipse.help.contexts"
extension points.Specifies a location in a document where other plug-ins may contribute additional content.Represents a link with text that invokes a specific command with parameters.An extension of a document's content.A context registered for context-sensitive help.ExtendsIContext
to provide support for styled text and topic categorization.ExtendsIContext2
to provide support for related command links.Dynamic context provider.A directive indicating the criteria information of a Toc or Topic described in xmlICriteriaDefinition represents the criteria definition of one plug-in.Represents criteria definition contributionICriterionDefinition represents a single criterion definition of the help content.ICriterionValueDefinition represents one criterion value definition of one criterion.Deprecated, for removal: This API element is subject to removal in a future version.marked for deletion, see Bug 442959.Producer capable of generating or otherwise obtaining contents for help resources.A help resource, usually a help topic.A directive indicating the content at the given path should be included in this document, and replace this node.IIndex represents metaphor of the book index.Represents either a complete or partial keyword index, as well as its metadata.IIndexEntry represents a single entry of the help index.IIndexEntry2 is an index entry which may have see elements as childrenAn entry that represents a see also node in the index.A directive indicating the content at the given path should be included in this document, and replace this node.A directive indicating a link to another toc to be inserted at (and replace) this link.Live Help Extension.AnIToc
represents 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
extendsIToc
by adding methods to support functionality for criteria, topic sorting and custom iconsRepresents either a complete or partial table of contents, as well as its metadata.AnITopic
is one topic in the table of contents, which may contain subtopics.ITopic2
extendsITopic
by adding methods to support functionality for criteria, topic sorting and custom iconsAn element in a UA document, which may have conditional enablement (may be filtered based on certain conditions) and may have sub-elements, or children.This class provides the ability to filter out user assistance model elements that support filtering (e.g.