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.
<!ELEMENT extension (contentExtension | contentExtensionProvider)+>
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT contentExtension EMPTY>
file CDATA #REQUIRED>
Defines content extension to one or more user assistance documents. The location of the content extension file is specified by the
This content file should have the a syntax like the following:
<contentExtension> <contribution content="bundleRelativePath/content.xhml" path="pluginId/path/file.xml#elementId"/> <replacement content="bundleRelativePath/content.xhml" path="pluginId/path/file.xml#elementId"/> </contentExtension>
contribution is the element used to insert content at the target anchor location.
replacement 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.
<!ELEMENT contentExtensionProvider EMPTY>
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.
org.eclipse.help.AbstractContentExtensionProviderinterface and must have a no-arg constructor.
The following is an example of using the
contentExtension extension point.
<extension point="org.eclipse.help.contentExtension"> <contentExtension file="contentExtensionFile.xml"/> </extension>
<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
An implementation of
org.eclipse.help.AbstractContentExtensionProvider must be supplied if a
contentExtensionProvider is used.
replacement were introduced in 3.3, replacing the old
topicReplace elements, in order to be more general. The old elements are deprecated but will still work.
Copyright (c) 2000, 2006 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0