163558 Dynamic content support for all UA

1 files changed, 32 insertions, 8 deletions

diff --git a/org.eclipse.help/schema/contentExtension.exsd b/org.eclipse.help/schema/contentExtension.exsd
index a86adf8a4..5dc45409e 100644
--- a/org.eclipse.help/schema/contentExtension.exsd
+++ b/org.eclipse.help/schema/contentExtension.exsd
@@ -6,7 +6,24 @@
          <meta.schema plugin="org.eclipse.help" id="contentExtension" name="Content Extension"/>
       </appInfo>
       <documentation>
-         This extension point is for supporting dynamic and reusable content in user assistance documents. It allows for contributing content into an existing document. Any document can declare that it can accept content contributions by explicitly specifying these contribution points using an &lt;code&gt;anchor&lt;/code&gt; element.
+         &lt;p&gt;
+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 &lt;code&gt;anchor&lt;/code&gt; element. An element in a document with a unique &lt;code&gt;id&lt;/code&gt; attribute specified can be replaced.
+&lt;/p&gt;
+&lt;p&gt;
+Content extensions are applicable to the following types of documents:
+&lt;/p&gt;
+&lt;p&gt;
+&lt;ul&gt;
+&lt;li&gt;Help XHTML topics&lt;/li&gt;
+&lt;li&gt;Help table of contents&lt;/li&gt;
+&lt;li&gt;Help keyword index&lt;/li&gt;
+&lt;li&gt;Help context-sensitive help&lt;/li&gt;
+&lt;li&gt;Cheat sheets (both simple and composite)&lt;/li&gt;
+&lt;/ul&gt;
+&lt;/p&gt;
+&lt;p&gt;
+Welcome content is extended using the &lt;code&gt;org.eclipse.ui.intro.configExtension&lt;/code&gt; extension point.
+&lt;/p&gt;
       </documentation>
    </annotation>
 
@@ -53,24 +70,25 @@
          <attribute name="file" type="string" use="required">
             <annotation>
                <documentation>
-                  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 and the target page where they should be merged into. The content file is parsed at run time by the platform and each content extension is loaded and inserted into the target location specified by the anchor.
+                  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 and the target document where they should be merged into. A content extension is either a contribution of content at a known anchor, or the replacement of an element in an existing document. The content file is parsed at run time by the platform and each content extension is loaded and inserted into the target location specified by the anchor.
 
 &lt;p&gt;
-This content file should have the following syntax:
+This content file should have the a syntax like the following:
 &lt;/p&gt;
 &lt;pre&gt;
 &lt;contentExtension&gt;
-   &lt;topicExtension
+   &lt;contribution
          content=&quot;bundleRelativePath/content.xhml&quot; 
          path=&quot;pluginId/path/file.xml#elementId&quot;/&gt;
-   &lt;topicReplace
+   &lt;replacement
          content=&quot;bundleRelativePath/content.xhml&quot; 
          path=&quot;pluginId/path/file.xml#elementId&quot;/&gt;
 &lt;/contentExtension&gt;
 &lt;/pre&gt;
 
 &lt;p&gt;
-&lt;code&gt;topicExtension&lt;/code&gt; is the element used to insert content at the target anchor location. &lt;code&gt;topicReplace&lt;/code&gt; 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.
+&lt;code&gt;contribution&lt;/code&gt; is the element used to insert content at the target anchor location.
+&lt;code&gt;replacement&lt;/code&gt; 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.
 &lt;/p&gt;
                </documentation>
                <appInfo>
@@ -123,7 +141,7 @@ In file &lt;code&gt;plugin.xml&lt;/code&gt;:
 In file &lt;code&gt;contentExtensionFile.xml&lt;/code&gt;:
 &lt;pre&gt;
    &lt;contentExtension&gt;
-      &lt;topicExtension
+      &lt;contribution
             content=&quot;xhtml/topicA.xhtml&quot;
             path=&quot;/org.xxx.yyy.somePluginId/xhtml/someHelpPage.xhtml#topicAnchor&quot;/&gt;
    &lt;/contentExtension&gt;
@@ -141,7 +159,13 @@ The above contribution inserts the content of the XHTML file, &lt;code&gt;topicA
          <meta.section type="apiInfo"/>
       </appInfo>
       <documentation>
-         An implementation of &lt;code&gt;org.eclipse.help.AbstractContentExtensionProvider&lt;/code&gt; must be supplied if a &lt;code&gt;contentExtensionProvider&lt;/code&gt; is used.
+         &lt;p&gt;
+An implementation of &lt;code&gt;org.eclipse.help.AbstractContentExtensionProvider&lt;/code&gt; must be supplied if a &lt;code&gt;contentExtensionProvider&lt;/code&gt; is used.
+&lt;/p&gt;
+&lt;p&gt;
+Note: &lt;code&gt;contribution&lt;/code&gt; and &lt;code&gt;replacement&lt;/code&gt; were introduced in 3.3, replacing the old &lt;code&gt;topicExtension&lt;/code&gt; and &lt;code&gt;topicReplace&lt;/code&gt; elements, in order to be more general. The old elements are deprecated but will still work.
+&lt;/p&gt;
+
       </documentation>
    </annotation>