This extension point is for supporting dynamic and reusable content in Help System pages. It allows for contributing content into an existing Help System page. Any XHTML page in the Help system can "declare" that it can accept content contributions by explicitly specifying these contribution points using an <code>anchor</code> element. XHTML snippets can then be dynamically inserted into these documents at runtime.
Defines content extension to one or more Help system pages. The location of the content extension file is specified by the <code>file</code> attribute.
a plugin-relative path to the location of an extension content file. An extension content file is an XML file that specifies the location of content contributions (as XHTML pages/snippets) and the target page where they should be merged into. The content file is parsed at run time by the Help system framework and each content extension is loaded and inserted into the target location specified by the anchor.
This content file should have the following syntax:<br>
<code>
<pre>
<contentExtension>
<topicExtension content="plugin/relative/path/topicExtensionFile.xhml"
path="plugin_id/path_to_xhtml_file/anchor_id"/>
<topicReplace content="topicReplaceFile.xhml" path="plugin_id/path_to_xhtml_file/element_id" />
</contentExtension>
</pre>
</code>
<br>
<code>topicExtension</code> is the markup used to insert content at the target anchor location. <code>topicReplace</code> is the markup used to replace the content of the target element by the specified content. In other words, content can be contributed that either adds to the target location or replaces the content of the target location.
The following is an example of using the <samp>contentExtension</samp> extension point.
<p>(in file <tt>plugin.xml</tt>)
<pre>
<extension point= "org.eclipse.help.contentExtension">
<contentExtension file="contentExtensionFile.xml"/>
</extension>
</pre>
</p>
<p>(in file <tt>contentExtensionFile.xml</tt>)
<pre>
<contentExtension>
<topicExtension content="xhtml/topicA.xhtml"
path="org.xxx.yyy.somePluginId/xhtml/someHelpPage.xhtml/topicAnchor"/>
</contentExtension>
</pre>
</p>
<p>The above contribution inserts the content of the XHTML file, <samp>topicA.xhtml</samp>, into the target Help system page specified by the <samp>path</samp> attribute. In this case, the content extension will be inserted in the location of an anchor called <samp>topicAnchor</samp> in page <samp>someHelpPage.xhtml</samp> in plugin <samp>org.xxx.yyy.somePluginId</samp>.
</p>
<p>The above contribution inserts the content of the XHTML file, <samp>topicA.xhtml</samp>, into the target Help system page specified by the <samp>path</samp> attribute. In this case, the content extension will be inserted in the location of an anchor called <samp>topicAnchor</samp> in page <samp>someHelpPage.xhtml</samp> in plugin <samp>org.xxx.yyy.somePluginId</samp>.</p>
No code is required to use this extension point. All that is needed is to supply the appropriate content files mentioned in the plugin.xml file.
The default implementation of the base help system supplied with the Eclipse platform fully supports this <samp>contentExtension</samp> extension point.
Copyright (c) 2000, 2006 IBM Corporation and others.<br>
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 <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>