HelpSupport

Identifier:

org.eclipse.ui.helpSupport

Since:

3.0 (originally named org.eclipse.help.support)

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.eclipse.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.eclipse.help.ui plug-in contains an implementation of the help system UI.

Copyright (c) 2000, 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html