Content Extension

Identifier:
org.eclipse.help.contentExtension

Description:

This extension point is for supporting dynamic and reusable content in user assistance documents. It allows for contributing content into an existing document. A document can declare that it can accept content contributions by explicitly specifying these contribution points using an anchor element. An element in a document with a unique id attribute specified can be replaced.

Content extensions are applicable to the following types of documents:

Welcome content is extended using the org.eclipse.ui.intro.configExtension extension point.

Configuration Markup:

<!ELEMENT extension (contentExtension | contentExtensionProvider)+>

<!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 user assistance documents. The location of the content extension file is specified by the file attribute.



<!ELEMENT contentExtensionProvider EMPTY>

<!ATTLIST contentExtensionProvider

class CDATA #REQUIRED>

(since 3.3) Allows java code to be plugged-in so that extensions can be generated at run-time. This is an alternative to the XML file, has the same capabilities, but doesn't require you to provide static XML.



Examples:

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>
      <contribution
            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.

API Information:

An implementation of org.eclipse.help.AbstractContentExtensionProvider must be supplied if a contentExtensionProvider is used.

Note: contribution and replacement were introduced in 3.3, replacing the old topicExtension and topicReplace elements, in order to be more general. The old elements are deprecated but will still work.

Supplied Implementation:
The default implementation of the base help system supplied with the Eclipse platform fully supports this extension point.


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