Help Content Extension

org.eclipse.help.contentExtension

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 anchor element. XHTML snippets can then be dynamically inserted into these documents at runtime.

<!ELEMENT extension (contentExtension+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT contentExtension EMPTY>

<!ATTLIST contentExtension

file CDATA #REQUIRED>

Defines content extension to one or more Help system pages. The location of the content extension file is specified by the file attribute.



The following is an example of using the contentExtension extension point.

(in file plugin.xml)

 

<extension point=

"org.eclipse.help.contentExtension"

>

<contentExtension file=

"contentExtensionFile.xml"

/>

</extension>

(in file contentExtensionFile.xml)

<contentExtension>

<topicExtension content=

"xhtml/topicA.xhtml"

path=

"org.xxx.yyy.somePluginId/xhtml/someHelpPage.xhtml/topicAnchor"

/>

</contentExtension>

The above contribution inserts the content of the XHTML file, topicA.xhtml, into the target Help system page specified by the path attribute. In this case, the content extension will be inserted in the location of an anchor called topicAnchor in page someHelpPage.xhtml in plugin org.xxx.yyy.somePluginId.

The above contribution inserts the content of the XHTML file, topicA.xhtml, into the target Help system page specified by the path attribute. In this case, the content extension will be inserted in the location of an anchor called topicAnchor in page someHelpPage.xhtml in plugin org.xxx.yyy.somePluginId.

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 contentExtension extension point.