Eclipse Platform
Release 3.6

Package org.eclipse.help

Provides core help system for the platform.

See:
          Description

Interface Summary
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 Extends IContext to provide support for styled text and topic categorization.
IContext3 Extends IContext2 to provide support for related command links.
IContextProvider Dynamic context provider.
ICriteria A directive indicating the criteria information of a Toc or Topic described in xml
ICriteriaDefinition ICriteriaDefinition represents the criteria definition of one plug-in.
ICriteriaDefinitionContribution Represents criteria definition contribution
ICriterionDefinition ICriterionDefinition represents a single criterion definition of the help content.
ICriterionValueDefinition ICriterionValueDefinition represents one criterion value definition of one criterion.
IHelp Deprecated. This interface became obsolete in 3.0, along with the extension point that it was associated with.
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 children
IIndexSee 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 An IToc 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 IToc2 extends IToc by adding methods to support functionality for criteria, topic sorting and custom icons
ITocContribution Represents either a complete or partial table of contents, as well as its metadata.
ITopic An ITopic is one topic in the table of contents, which may contain subtopics.
ITopic2 ITopic2 extends ITopic by adding methods to support functionality for criteria, topic sorting and custom icons
IUAElement 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
AbstractContentExtensionProvider An AbstractContentExtensionProvider is a mechanism to provide arbitrary content extensions (e.g. contributions to anchors or element replacements).
AbstractContextProvider An AbstractContextProvider is a mechanism to provide arbitrary context-sensitive help for any part of the UI.
AbstractCriteriaDefinitionProvider An AbstractCriteriaDefinitionProvider is a mechanism to provide display name for criteria attached to toc or topic.
AbstractCriteriaProvider AbstractCriteriaProvider is a mechanism for assigning criteria to ITopic and IToc elements independent of a table of contents file.
AbstractIndexProvider An AbstractIndexProvider is a mechanism to provide arbitrary content to the keyword index.
AbstractTocProvider An AbstractTocProvider is 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.
 

Package org.eclipse.help Description

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 as HelpSystem class which static methods can be used to obtain objects managed by the help system.


Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.