| <!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: Contexts</title> | |
| </head> | |
| <body link="#0000FF" vlink="#800080"> | |
| <center> | |
| <h1> | |
| Contexts</h1></center> | |
| <b><i>Identifier: </i></b>org.eclipse.help.contexts | |
| <p><b><i>Description:</i></b> For defining context-sensitive help for an | |
| individual plug-in. | |
| <p><b><i>Configuration Markup:</i></b> | |
| <p><tt> <!ELEMENT contexts EMPTY></tt> | |
| <br><tt> <!ATTLIST contexts name CDATA #REQUIRED></tt> | |
| <ul> | |
| <li> | |
| <b>name</b> - the name of the manifest file which contains the context-sensitive | |
| help documentation for this plug-in.</li> | |
| </ul> | |
| <i><b>Configuration Markup for Contexts </b>(this is what goes into the | |
| contexts manifest file)<b>:</b></i> | |
| <p><tt> <!ELEMENT contexts (context)* ) ></tt> | |
| <p><tt> <!ELEMENT context (description?,topic*) ></tt> | |
| <br><tt> <!ATTLIST context id ID #REQUIRED ></tt> | |
| <p><tt> <!ELEMENT description (#PCDATA)></tt> | |
| <p><tt> <!ELEMENT topic (topic)* ></tt> | |
| <br><tt> <!ATTLIST topic id ID #IMPLIED ></tt> | |
| <br><tt> <!ATTLIST topic label CDATA #REQUIRED ></tt> | |
| <br><tt> <!ATTLIST topic href CDATA #IMPLIED | |
| ></tt> | |
| <p>The contexts manifest files provide all the information needed when | |
| context-sensitive help is requested by the user. The id is passed by the | |
| platform to identify the currently active context. The context definition | |
| with a matching id is then retrieved. This context element contains the | |
| brief description that is to be displayed to the user, as well as related | |
| topics that the user might find useful for understanding the current context. | |
| <br> | |
| <p><b><i>Examples:</i></b> | |
| <p>The following is an example of using the <tt>contexts</tt> extension | |
| point. | |
| <p>(in file <tt>plugin.xml</tt>) | |
| <p><tt> <extension point="org.eclipse.help.contexts"></tt> | |
| <br><tt> <contexts name="xyzContexts.xml"/></tt> | |
| <br><tt> </extension></tt> | |
| <br> | |
| <p>(in file <tt>xyzContexts.xml</tt>) | |
| <p><tt> <contexts></tt> | |
| <br><tt> <context id="generalContextId"></tt> | |
| <br><tt> <description> This | |
| is a sample F1 help string.</description></tt> | |
| <br><tt> <topic href="contexts/RelatedContext1.html" | |
| label="Help Related Topic 1"/></tt> | |
| <br><tt> <topic href="contexts/RelatedContext2.html" | |
| label="Help Related Topic 2"/></tt> | |
| <br><tt> </context></tt> | |
| <br><tt> </contexts></tt> | |
| <br> | |
| <p><b><i>API Information</i>: </b>No code is required to use this extension | |
| point. All that is needed is to supply the appropriate manifest file(s) | |
| mentioned in the <tt>plugin.xml</tt> file. | |
| <p><b><i>Supplied Implementation: </i></b>The optional default implementation | |
| of the help system UI supplied with the Eclipse platform fully supports | |
| the <tt>contexts</tt> extension point. | |
| <br> | |
| <br> | |
| <br> | |
| <p><a href="hglegal.htm"><img SRC="ngibmcpy.gif" ALT="Copyright IBM Corporation 2000" BORDER=0 height=12 width=195></a> | |
| </body> | |
| </html> |