<!ELEMENT extension (contexts | contextProvider)+>
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contexts EMPTY>
file CDATA #REQUIRED
plugin CDATA #IMPLIED>
a context-sensitive help contribution made by supplying an XML file
Configuration Markup for what goes into the contexts manifest file:
<!ELEMENT contexts (context)* ) >
<!ELEMENT context (description?,topic*) >
id CDATA #REQUIRED
title CDATA #IMPLIED >
<!ELEMENT description (#PCDATA)>
<!ELEMENT topic EMPTY >
label CDATA #REQUIRED
href CDATA #REQUIRED >
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 the help system to identify the currently active context.The context definitions with matching IDs are then retrieved. If a title is defined it will be used when context help is displayed in the Help view, both as the title in the related topics section and also as the search term in the "More results" section. The IDs in the manifest file, must not contain the period character, since the IDs are uniquely identified by pluginID.contextID string when in memory. The IContext object is then created by help system that contains descriptions and topics from all context definitions for a given ID in a plug-in. The description is to be displayed to the user, and related topics might be useful to the user for understanding the current context. The related topic are html files packaged in doc.zip, together with topics that are part of on line help.
If a plugin defines some context id's, one can extend the description or related links of a context by declaring another context with the same id.
<!ELEMENT contextProvider EMPTY>
class CDATA #REQUIRED>
(since 3.3) a context-sensitive help contribution made by supplying a java class to generate the content at run-time
<extension point="org.eclipse.help.contexts"> <contexts file="xyzContexts.xml"/> </extension>
(in file xyzContexts.xml)
<description> This is a sample F1 help string.</description>
<topic href="contexts/RelatedContext1.html" label="Help Related Topic 1"/>
<topic href="contexts/RelatedContext2.html" label="Help Related Topic 2"/>
The related topics contained in doc.zip can be localized by creating
a doc.zip file with translated version of documents, and placing doc.zip
nl/<language>/<country> or nl/<language> directory. The help system will look for the files under this directories before defaulting to plugin directory.
Copyright (c) 2000, 2006 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html