Help Support - org.karora.moomba.ui.helpSupport

Added by Pete Butland, last edited by Pete Butland on Oct 03, 2007  (view change)

Overview

Your plug-in can contribute a help system to the workbench. This section documents the details for doing this.

Plugin Configuration file

Identifier: org.karora.moomba.ui.helpSupport

Description

This extension point is for contributing the help system UI. The platform should be configured with no more than one help system UI.

Configuration Markup 

<!ELEMENT extension (config?)>
<!ATTLIST extension
point CDATA #REQUIRED
id    CDATA #IMPLIED
name  CDATA #IMPLIED>
<!ELEMENT config EMPTY>
<!ATTLIST config
class CDATA #REQUIRED>
  • class - the implementation class for displaying online and context-sensitive help. This class must implement the org.eclipse.ui.help.AbstractHelpUI interface.

Examples

The following is a sample usage of the help support extension point: 

<extension point="org.eclipse.ui.helpSupport">
 <config class="com.example.XYZHelpUI"/>
</extension>

API Information

The supplied class must implement a subclass of org.karora.moomba.ui.help.AbstractHelpUI. Implementation of the abstract methods in that class determine what happens when a user asks for online help or context-sensitive help. The implementation should access contributed help information using org.eclipse.help.HelpSystem.

Supplied Implementation

The org.karora.moomba.help.ui plug-in contains an implementation of the help system UI.

Labels

 
(None)