Note: The help system is still under development and can be expected to change somewhat before reaching stability. It is being made available at this stage to solicit feedback from early adopters, on the understanding that the details of the contribution mechanisms might change in breaking ways.

Support

Identifier: org.eclipse.help.support

Description: For configuring a help system UI. The platform should be configured with no more than one help system UI.

Configuration Markup:

   <!ELEMENT config EMPTY>
   <!ATTLIST config class CDATA #REQUIRED >

Examples:

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

(in file plugin.xml)

   <extension point="org.eclipse.help.support">
      <config class="com.example.XYZHelpUI"/>
   </extension>

API Information: The supplied class must implement the org.eclipse.help.IHelp interface. Methods in that interface determine what happens when a user asks for online help or context-sensitive help. The implementation should access the help information contributed via the org.eclipse.help.contributions and org.eclipse.help.contexts extension points.

Supplied Implementation: The org.eclipse.help.workbench plug-in contains an implementation of the help system UI. Although this plug-in is supplied with the Eclipse platform, it is entirely optional and can be safely omitted from the platform configuration.

Copyright IBM Corp. 2000, 2001.  All Rights Reserved.