Support

Identifier: org.eclipse.help.support

Description: Support for configuring a 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
   >

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

 <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.contexts and org.eclipse.help.toc extension points.

Supplied Implementation: The org.eclipse.help.ui 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.