Fix for Bug 67734

1 files changed, 46 insertions, 46 deletions

diff --git a/org.eclipse.ui.intro/schema/config.exsd b/org.eclipse.ui.intro/schema/config.exsd
index 61a0cd59a..12a5ee9f9 100644
--- a/org.eclipse.ui.intro/schema/config.exsd
+++ b/org.eclipse.ui.intro/schema/config.exsd
@@ -6,16 +6,13 @@
          <meta.schema plugin="org.eclipse.ui.intro" id="config" name="Intro Part Configuration"/>

       </appInfo>

       <documentation>

-         This extension point is used to register an intro configuration. This configuration provides presentation implementations and content for a given intro contribution. An intro appears when the workbench is first launched and as a choice from the &quot;Help&quot; menu. The intro is typically used to introduce a user to a product built on Eclipse.

+         This extension point is used to register an intro configuration. This configuration provides presentation implementations and content for a given intro contribution. An intro appears when the workbench is first launched and as a choice from the &quot;Help&quot; menu. The intro is typically used to introduce a user to a product built on Eclipse.
+&lt;p&gt;
+The intros are organized into pages which usually reflect a particular category of introductory material.  For instance, a What&apos;s New page may introduce new concepts or functionality since previous versions.  The content defined by one intro configuration can be referenced and extended from other plug-ins using the &lt;a href=&quot;org.eclipse.ui.intro.configExtension.exsd&quot;&gt;org.eclipse.ui.intro.configExtension&lt;/a&gt; extension point.
 &lt;p&gt;

-The intros are organized into pages which usually reflect a particular category of introductory material.  For instance, a What&apos;s New page may introduce new concepts or functionality since previous versions.  The content defined by one intro configuration can be referenced and extended from other plug-ins using the &lt;a href=&quot;org.eclipse.ui.intro.configExtension.exsd&quot;&gt;org.eclipse.ui.intro.configExtension&lt;/a&gt; extension point.

-&lt;p&gt;

-todo - add other APIs here such as IStandbyPart

       </documentation>

    </annotation>

 

-   <include schemaLocation="IntroContent.exsd"/>

-

    <element name="extension">

       <complexType>

          <sequence>

@@ -48,7 +45,7 @@ todo - add other APIs here such as IStandbyPart
    <element name="config">

       <annotation>

          <documentation>

-            A config element can be used to configure a customizable Intro Part. A config element must specify an id, an introId, and a content file.

+            A config element can be used to configure a customizable Intro Part. A config element must specify an id, an introId, and a content file.
 The intro content file is an XML file that describes the pages, groups and links that the intro has.

          </documentation>

       </annotation>

@@ -73,7 +70,7 @@ The intro content file is an XML file that describes the pages, groups and links
          <attribute name="content" type="string" use="required">

             <annotation>

                <documentation>

-                  an intro content file. The content file is an XML file that contains the specifics of the intro (&lt;a href=&quot;introContentFileSpec.html&quot;&gt;intro content file format specification)&lt;/a&gt;.

+                  an intro content file. The content file is an XML file that contains the specifics of the intro (&lt;a href=&quot;introContentFileSpec.html&quot;&gt;intro content file format specification)&lt;/a&gt;.
 The content file is parsed at run time by the intro framework. Based on the settings in this file, a certain number of pages, groups, and links are shown to the user when the intro is opened.

                </documentation>

             </annotation>

@@ -94,7 +91,7 @@ The content file is parsed at run time by the intro framework. Based on the sett
          <attribute name="home-page-id" type="string" use="required">

             <annotation>

                <documentation>

-                  the id of the home (root) page.

+                  the id of the home (root) page, which is the first page of the introduction.  This page can be used as an entry point to the other main pages that make up the intro.

                </documentation>

             </annotation>

          </attribute>

@@ -111,7 +108,7 @@ The content file is parsed at run time by the intro framework. Based on the sett
    <element name="implementation">

       <annotation>

          <documentation>

-            The presentation of the Platform&apos;s out of the box experience has two implementations. One of them is SWT Browser based, while the other is UI Forms based. The customizable intro part can be configured to pick one of those two presentation based on the current OS and WS. The type of the implementation can be swt or html.

+            The presentation of the Platform&apos;s out of the box experience has two implementations. One of them is SWT Browser based, while the other is UI Forms based. The customizable intro part can be configured to pick one of those two presentations based on the current OS and WS. The type of the implementation can be swt or html.

          </documentation>

       </annotation>

       <complexType>

@@ -121,7 +118,7 @@ The content file is parsed at run time by the intro framework. Based on the sett
          <attribute name="kind" use="required">

             <annotation>

                <documentation>

-                  

+                  Specifies the type of this implementation.  The swt kind indicates a UI Forms based implementation, and the html kind indicates an SWT Browser based implementation

                </documentation>

             </annotation>

             <simpleType>

@@ -143,14 +140,14 @@ The content file is parsed at run time by the intro framework. Based on the sett
          <attribute name="os" type="string">

             <annotation>

                <documentation>

-                  os string used when choosing the presentation&apos;s implementation based on current OS. eg: win32,linux (todo - where are the valid OS strings used by Eclipse defined?)

+                  The optional operating system specification used when choosing the presentation&apos;s implementation.  It can be any of the os designators defined by Eclipse, e.g., win32, linux, etc (see Javadoc for &lt;code&gt;org.eclipse.core.runtime.Platform&lt;/code&gt;).

                </documentation>

             </annotation>

          </attribute>

          <attribute name="ws" type="string">

             <annotation>

                <documentation>

-                  ws string used when choosing the presentation&apos;s implementation based on current WS. eg: win32,gtk (todo - where are the valid WS strings used by Eclipse defined? Should we expand WS to windowing system?)

+                  The optional windowing system specification used when choosing the presentation&apos;s implementation.  It can be any of the ws designators defined by Eclipse (see Javadoc for &lt;code&gt;org.eclipse.core.runtime.Platform&lt;/code&gt;).

                </documentation>

             </annotation>

          </attribute>

@@ -171,29 +168,32 @@ The content file is parsed at run time by the intro framework. Based on the sett
          <meta.section type="examples"/>

       </appInfo>

       <documentation>

-         Here is a sample usage of the config extension point.

-

-&lt;extension id=&quot;intro&quot; point=&quot;org.eclipse.ui.intro.config&quot;&gt;

-   &lt;config

-      introId=&quot;com.org.xyz.intro&quot;

-      id=&quot;com.org.xyz.introConfig&quot;

-      content=&quot;introContent.xml&quot;&gt;

-      &lt;presentation

-         home-page-id=&quot;root&quot;

-         title=&quot;%intro.title&quot;&gt;

-         &lt;implementation

-            ws=&quot;win32&quot;

-            style=&quot;css/shared.css&quot;

-            class=&quot;org.eclipse.ui.internal.intro.impl.presentations.BrowserIntroPartImplementation&quot;

-            os=&quot;win32&quot;&gt;

-         &lt;/implementation&gt;

-         &lt;implementation

-            style=&quot;css/shared_swt.properties&quot;

-            class=&quot;org.eclipse.ui.internal.intro.impl.presentations.FormIntroPartImplementation&quot;&gt;

-         &lt;/implementation&gt;

-      &lt;/presentation&gt;

-   &lt;/config&gt;

-&lt;/extension&gt;

+         Here is a sample usage of the config extension point.
+&lt;p&gt;
+&lt;pre&gt;
+&lt;extension id=&quot;intro&quot; point=&quot;org.eclipse.ui.intro.config&quot;&gt;
+   &lt;config
+      introId=&quot;com.org.xyz.intro&quot;
+      id=&quot;com.org.xyz.introConfig&quot;
+      content=&quot;introContent.xml&quot;&gt;
+      &lt;presentation
+         home-page-id=&quot;root&quot;
+         title=&quot;%intro.title&quot;&gt;
+         &lt;implementation
+            ws=&quot;win32&quot;
+            style=&quot;css/shared.css&quot;
+            class=&quot;org.eclipse.ui.internal.intro.impl.presentations.BrowserIntroPartImplementation&quot;
+            os=&quot;win32&quot;&gt;
+         &lt;/implementation&gt;
+         &lt;implementation
+            style=&quot;css/shared_swt.properties&quot;
+            class=&quot;org.eclipse.ui.internal.intro.impl.presentations.FormIntroPartImplementation&quot;&gt;
+         &lt;/implementation&gt;
+      &lt;/presentation&gt;
+   &lt;/config&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
+&lt;/p&gt;

       </documentation>

    </annotation>

 

@@ -202,7 +202,7 @@ The content file is parsed at run time by the intro framework. Based on the sett
          <meta.section type="apiInfo"/>

       </appInfo>

       <documentation>

-         [Enter API information here.]

+         For further details see the spec for the org.eclipse.ui.intro.config API package.

       </documentation>

    </annotation>

 

@@ -220,15 +220,15 @@ The content file is parsed at run time by the intro framework. Based on the sett
          <meta.section type="copyright"/>

       </appInfo>

       <documentation>

-         /************************************************************************

- * Copyright (c) 2004 IBM Corporation and others.

- * All rights reserved. This program and the accompanying materials

- * are made available under the terms of the Common Public License v1.0

- * which accompanies this distribution, and is available at

- * http://www.eclipse.org/legal/cpl-v10.html

- * 

- * Contributors:

- *  IBM Corporation - Initial API and implementation

+         /************************************************************************
+ * Copyright (c) 2004 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *  IBM Corporation - Initial API and implementation
  *************************************************************************/

       </documentation>

    </annotation>