<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> | |
<html> | |
<head> | |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> | |
<meta name="GENERATOR" content="Mozilla/4.5 [en] (Win98; I) [Netscape]"> | |
<title>Help System extension points: Support</title> | |
</head> | |
<body link="#0000FF" vlink="#800080"> | |
<center> | |
<h1> | |
Support</h1></center> | |
<b><i>Identifier: </i></b>org.eclipse.help.support | |
<p><b><i>Description:</i></b> For configuring a help system UI. The platform | |
should be configured with no more than one help system UI. | |
<p><b><i>Configuration Markup:</i></b> | |
<p><tt> <!ELEMENT config EMPTY></tt> | |
<br><tt> <!ATTLIST config class CDATA #REQUIRED</tt> <tt>></tt> | |
<ul> | |
<li> | |
<b>class</b> - the implementation class for displaying online and context-sensitive | |
help. This class must implement the <tt>org.eclipse.help.IHelp</tt> | |
interface.</li> | |
</ul> | |
<b><i>Examples:</i></b> | |
<p>The following is a sample usage of the <tt>support</tt> extension point: | |
<p>(in file <tt>plugin.xml</tt>) | |
<p><tt> <extension point="org.eclipse.help.support"></tt> | |
<br><tt> <config class="com.example.XYZHelpUI"/></tt> | |
<br><tt> </extension></tt> | |
<p><b><i>API Information</i>: </b>The supplied class must implement the | |
<tt>org.eclipse.help.IHelp</tt> | |
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 <tt>org.eclipse.help.contributions</tt> | |
and <tt>org.eclipse.help.contexts</tt> extension points. | |
<p><i><b>Supplied Implementation:</b> </i>The <tt>org.eclipse.help.workbench</tt> | |
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. | |
<p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corporation 2000" BORDER=0 height=12 width=195></a> | |
</body> | |
</html> |