Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorlparsons2004-04-23 05:09:30 +0000
committerlparsons2004-04-23 05:09:30 +0000
commite1b2b37ec43333eb2e725ed8c57ba3579a4f7d01 (patch)
treeebae1bee1366c1b74f9b2e98ee8760113c770722
parent56a10cd866057f3c87183bedc5e5496d086ef9f3 (diff)
downloadeclipse.platform.ua-e1b2b37ec43333eb2e725ed8c57ba3579a4f7d01.tar.gz
eclipse.platform.ua-e1b2b37ec43333eb2e725ed8c57ba3579a4f7d01.tar.xz
eclipse.platform.ua-e1b2b37ec43333eb2e725ed8c57ba3579a4f7d01.zip
First review of APIs
-rw-r--r--org.eclipse.ui.intro/schema/introContentFileSpec.html241
-rw-r--r--org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd434
-rw-r--r--org.eclipse.ui.intro/schema/org.eclipse.ui.intro.configExtension.exsd450
-rw-r--r--org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/IStandbyContentPart.java61
4 files changed, 409 insertions, 777 deletions
diff --git a/org.eclipse.ui.intro/schema/introContentFileSpec.html b/org.eclipse.ui.intro/schema/introContentFileSpec.html
new file mode 100644
index 000000000..3ca172001
--- /dev/null
+++ b/org.eclipse.ui.intro/schema/introContentFileSpec.html
@@ -0,0 +1,241 @@
+<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
+ <meta content="text/html; charset=iso-8859-1"
+ http-equiv="Content-Type">
+ <meta content="Microsoft FrontPage 4.0" name="GENERATOR">
+ <meta content="FrontPage.Editor.Document" name="ProgId">
+ <title>Intro Content File XML Format</title>
+</head>
+<body>
+<h1>Intro Content File XML Format</h1>
+<p>Version 3.0</p>
+<p>This document describes the intro content file structure as a series
+of
+DTD fragments (machine readable <a href="contentFile.xsd">XML schema</a>).</p>
+<h2><code>introContent</code></h2>
+<pre>&lt;!ELEMENT introContent (page+ | div* | extensionContent*)&gt;&nbsp;<br>&lt;!ATTLIST introContent&nbsp;<br>&gt;</pre>
+<p>The &lt;introContent&gt; element defines the body of the intro
+content
+file. &lt;intoContent&gt; has no attributes.<br>
+</p>
+<h2><code>page</code></h2>
+<pre>&lt;!ELEMENT page (div* | link* | text* | head? | img* | include* | html* | title?)&gt;<br>&lt;!ATTLIST page<br>&nbsp; id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED <br>&nbsp; title &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED <br> style &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED <br> alt-style&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED <br> url&nbsp;&nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED <br> standby-url CDATA #IMPLIED <br> standby-style CDATA #IMPLIED <br> standby-alt-style CDATA #IMPLIED<br> &nbsp;class-id CDATA #IMPLIED <br>&gt;</pre>
+<p>The &lt;page&gt; element is used to describe a page to
+be displayed. The &lt;page&gt; is either either dynamic or static.
+&lt;page&gt; attributes are as follows:</p>
+<ul>
+ <li><b>id</b> - A unique name that can be used to identify this page.<br>
+ </li>
+ <li><b>style</b> - A relative path to a CSS file which is applied to
+the page only when using the Web based presentation.<br>
+ </li>
+ <li><b>alt-style</b> - A relative path to a SWT presentation
+properies file which is applied to the page only when using the SWT
+based presentation. </li>
+ <li><b>url</b> - The optional relative path to an HTML file. When
+using the Web based presentation, this HTML file will displayed instead
+of any content defined for this page. </li>
+ <li><b>standby-url</b> - (todo - is this even used?)<br>
+ </li>
+ <li><b>standby-style</b> - (todo - is this even used?) </li>
+ <li><b>standby-alt-style</b> - (todo - is this even used?) </li>
+ <li><span style="font-weight: bold;">class-id</span> - A means to
+classifiy the page into a given category so that a common style may be
+applied.</li>
+</ul>
+Static pages allow for reuse of existing HTML documents within ones
+introduction. When a static page is used, none of the subelements are
+utilized. Also note when the SWT presentation is used and a static page
+is to be displayed an external brower is launched and the current page
+remains visible.<br>
+<br>
+Dynamic pages do not have a <span style="font-weight: bold;">url</span>
+defined and their contents are generated from the subelements of the
+page. The <span style="font-weight: bold;">style</span> or <span
+ style="font-weight: bold;">alt-style</span> will be applied depending
+on the presentation. The styles can be further enhanced by referencing
+the <span style="font-weight: bold;">id</span> or <span
+ style="font-weight: bold;">class-id</span>.<br>
+<br>
+A &lt;div&gt; subelement is used to group of content and apply style
+across the grouped content. A &lt;link&gt; subelement defines a link
+which can be used to link to a page and run an intro
+action/command.&nbsp; A link is normally defined at the page level to
+navigate between main pages verses links within a page. A &lt;text&gt;
+subelement defines textual content for the page level. A &lt;head&gt;
+subelement is only applicable for the Web based presentation and allows
+for additional html to be added to the HTML &lt;head&gt; section. This
+is useful for adding java srcipts or extra styles sheets. An
+&lt;img&gt; subelement defines image content for the page level. An
+&lt;include&gt; subelement allows for reuse any element other than a
+page. An &lt;html&gt; subelement is only applicable for the Web based
+presentation and allows for the embedding or inclusion of html into the
+page's content. Embedding allows for a fully defined html file to be
+embeded within an HTML &lt;object&gt; by referencing the html file.
+Inclusion allows for embedding an html snippets directly from html
+file. A &lt;title&gt; subelement defines the title of the page.<br>
+<h2><code>div</code></h2>
+<pre>&lt;!ELEMENT div (div* | link* | text* | img* | include* | html*)&gt;&nbsp;<br>&lt;!ATTLIST div&nbsp;<br>&nbsp; id &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; label&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; &nbsp; CDATA #IMPLIED&nbsp;<br>&nbsp; class-id &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&gt;</pre>
+<p>The &lt;div&gt; element is used to group related elements, either
+content or presentation-wise. &lt;div&gt; attributes are
+as
+follows:</p>
+<ul type="disc">
+ <li><b>id</b>- A unique name that can be used to identify this div. </li>
+ <li><b>label</b>- The title of the div item. (todo - should this be
+moved to a title element?)<br>
+ </li>
+ <li><b>class-id</b>- A means to classifiy the div into a given
+category so that a common style may be applied.</li>
+</ul>
+A &lt;link&gt; subelement defines a link which can be used to link to a
+page and run an intro action/command.&nbsp; A link is normally defined
+at
+the page level to navigate between main pages verses links within a
+page. A &lt;text&gt; subelement defines textual content for the page
+level. An &lt;img&gt; subelement defines image content for the
+page level. An &lt;include&gt; subelement allows for reuse any element
+other than a page. An &lt;html&gt; subelement is only applicable for
+the Web based presentation and allows for the embedding or inclusion of
+html into the page's content. Embedding allows for a fully defined html
+file to be embeded within an HTML &lt;object&gt; by referencing the
+html file. Inclusion allows for embedding an html snippets directly
+from html file.
+<h2><code></code>link</h2>
+<code></code>
+<pre>&lt;!ELEMENT link (text?)&gt;&nbsp;<br>&lt;!ATTLIST link&nbsp;<br>&nbsp; url&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br> id CDATA #IMPLIED<br> label CDATA #IMPLIED<br> class-id CDATA #IMPLIED<br>&gt;</pre>
+<p>Each &lt;conditional-subitem&gt; element describes a single sub-step
+whose
+form can differ based on a condition known at the time the item is
+expanded.
+&lt;conditional-subitem&gt; attributes are as follows:</p>
+<ul type="disc">
+ <li><span style="font-weight: bold;">url</span> - A valid URL to
+external web site or a 'special' URL syntax will be reserved for
+Eclipse actions. All URLs in the following form
+http://org.eclipse.ui.intro/&lt;command&gt;?p1=v1&amp;p2=v2...will be
+processed as Eclipse requests. (todo - either include all the commands
+here or reference the file describing the commands)<br>
+ </li>
+ <li><b>id</b> - A unique name that can be used to identify this link.
+ </li>
+ <li><b>label</b> - The title of the div item. </li>
+ <li><b>class-id</b> - A means to classifiy the div into a given
+category so that a common style may be applied.</li>
+</ul>
+<h2><code>text</code></h2>
+<pre>&lt;!ELEMENT text EMPTY&gt;&nbsp;<br>&lt;!ATTLIST text&nbsp;<br>&nbsp; id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&nbsp; class-id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&gt;</pre>
+<p>Each &lt;text&gt; element defines textual content. &lt;text&gt;
+attributes
+are as
+follows:</p>
+<ul type="disc">
+ <li><b>id</b> - A unique name that can be used to identify this text.</li>
+ <li><b>class-id</b> - A means to classifiy the div into a given
+category so that a common style may be applied.</li>
+</ul>
+<h2><code>head</code></h2>
+<pre>&lt;!ELEMENT head EMPTY&gt;&nbsp;<br>&lt;!ATTLIST head&nbsp;<br>&nbsp; src&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&gt;</pre>
+<p>A &lt;head&gt; element is only applicable for the Web based
+presentation and allows for additional html to be added to the HTML
+&lt;head&gt; section. This is useful for adding java srcipts or extra
+styles sheets.
+&lt;head&gt; attributes are as follows:</p>
+<ul type="disc">
+ <li><b>src</b>- A relative URL to a file containing the HTML to
+include directly into the HTML &lt;head&gt; section. </li>
+</ul>
+<h2><code>img</code></h2>
+<pre>&lt;!ELEMENT img EMPTY&gt;&nbsp;<br>&lt;!ATTLIST img&nbsp;<br>&nbsp; id &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; src &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; alt&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&nbsp; class-id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&gt;</pre>
+<p>Each &lt;img&gt; element describes an image that represents intro
+content.not presentation content.
+&lt;img&gt; attributes are as follows:</p>
+<ul type="disc">
+ <li><b>id</b> - A unique name that can be used to identify this img.</li>
+ <li><b>src</b> - A relative URL to the image file. </li>
+ <li><b>alt</b> - The alternative text to use when the image can not
+be load or is not use by the presentation.</li>
+ <li><b>class-id</b> - A means to classifiy the div into a given
+category so that a common style may be applied.</li>
+</ul>
+<h2><code>include</code></h2>
+<pre>&lt;!ELEMENT include EMPTY&gt;&nbsp;<br>&lt;!ATTLIST include&nbsp;<br>&nbsp; path &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; configId &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; merge-style&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ("true" | "false") "false"<br>&gt;</pre>
+<p>Each &lt;include&gt; element expands an element targeted by the
+given path and an optional configId attributes. The path should
+uniquely address an element within the specified configuration. It
+could point to a div defined at the configuration level, or any element
+in a page.(todo - can the path reference elements within divs? I
+thought it could reference any element.)
+&lt;include&gt; attributes are as follows:</p>
+<ul type="disc">
+ <li><b>path</b> - The path that uniquely represents the target
+element within the configuration (e.g. page/div1/div2). It may be a div
+element, or any element that may be contained in a div. You can not
+include a page.</li>
+ <li><b>configId</b> - An identifier of an intro configuration where
+the included element is defined. If specified, it is assumed that the
+element to be included is specified in another configuration, and not
+the enclosing configuration. In this case, that external config is
+loaded and the element is resolved from that new config. If not
+specified, enclosing (parent) configuration of this include is assumed.
+(todo - the configId was marked as required in the schema but the
+description states that it is optional. So is it optional?)</li>
+ <li><b>mergeStyle</b> - If true, style belonging to the page that
+owns the included element will be added to list of styles of the
+including page. If false, the including page is responsible for
+controling properties of the included element.</li>
+</ul>
+<h2><code>html</code></h2>
+<pre>&lt;!ELEMENT html ( [img|text] )&gt;&nbsp;<br>&lt;!ATTLIST html&nbsp;<br>&nbsp; id &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; src &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ("embed" | "inline") <br>&nbsp; class-id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&gt;</pre>
+<p>An &lt;html&gt; element is only applicable for
+the Web based presentation and allows for the embedding or inclusion of
+html into the page's content. Embedding allows for a fully defined html
+file to be embeded within an HTML &lt;object&gt; by referencing the
+html file. Inclusion allows for embedding an html snippets directly
+from html file. &lt;html&gt; attributes are as follows:</p>
+<ul type="disc">
+ <li><b>id</b> - A unique name that can be used to identify this html.</li>
+ <li><b>src</b> - A relative URL to a file containing the HTML embed
+or include.</li>
+ <li><span style="font-weight: bold;">type</span> - If 'embed', a
+valid (full) HTML document will be embedded using HTML &lt;object&gt;
+tag. If 'inline', value of 'src' will be treated as a snippet of HTML
+to emit 'in-place'. If type is not specified, the html element will be
+ignored by the intro configuration. </li>
+ <li><b>class-id</b> - A means to classifiy the div into a given
+category so that a common style may be applied.<br>
+ </li>
+</ul>
+<h2><code>title</code></h2>
+<pre>&lt;!ELEMENT title EMPTY&gt;&nbsp;<br>&lt;!ATTLIST title&nbsp;<br>&nbsp; id &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&nbsp; class-id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&gt;</pre>
+<p>A &lt;title&gt; element defines a page's title.
+&lt;title&gt; attributes are as follows:</p>
+<ul type="disc">
+ <li><b>id</b> - A unique name that can be used to identify this title.</li>
+ <li><b>class-id</b> - A means to classifiy the div into a given
+category so that a common style may be applied.<br>
+ </li>
+</ul>
+<h2><code>extensionContent</code></h2>
+<pre>&lt;!ELEMENT extensionContent( div* | link* )&gt;&nbsp;<br>&lt;!ATTLIST extensionContent<br>&nbsp; path &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #REQUIRED<br>&nbsp; style &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&nbsp; alt-style &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CDATA #IMPLIED<br>&gt;</pre>
+<p>An &lt;extensionContent&gt; element defines the content to be added
+to the target page or div. (todo - what happen to placeholders?)
+&lt;extensionContent&gt; attributes are as follows:</p>
+<ul type="disc">
+ <li><b>path</b>- The path that uniquely represents the element (e.g.
+page/div1/div2) within the target configuration to be extended. It can
+only be a page or a div, including shared divs at configuration level. </li>
+ <li><b>style</b> - A relative path to a CSS file which is applied to
+the page only when using the Web based presentation.<br>
+ </li>
+ <li><b>alt-style</b> - A relative path to a SWT presentation
+properies file which is applied to the page only when using the SWT
+based presentation. </li>
+</ul>
+<h2><code></code>Example</h2>
+<p>The following is an example of a very simple cheat sheet content
+file:</p>
+<pre>&lt;?xml version="1.0" encoding="UTF-8"?&gt;<br>&lt;cheatsheet title="Example"&gt;<br> &lt;intro&gt;<br> &lt;description&gt;Example cheat sheet with two steps.&lt;/description&gt;<br> &lt;/intro&gt;<br> &lt;item title="Step 1"&gt;<br> &lt;description&gt;This is a step with an action.&lt;/description&gt;<br> &lt;action class="com.xyz.myaction" pluginId="com.xyz"/&gt;<br> &lt;/item&gt;<br> &lt;item title="Step 2"&gt;<br> &lt;description&gt;This is a fully manual step.&lt;/description&gt;<br> &lt;/item&gt;<br>&lt;/cheatsheet&gt;</pre>
+</body>
+</html>
diff --git a/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd b/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd
index acb68a983..782502996 100644
--- a/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd
+++ b/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd
@@ -6,7 +6,11 @@
<meta.schema plugin="org.eclipse.ui.intro" id="config" name="Intro Part Configuration"/>
</appInfo>
<documentation>
- This extension point is used to define and configure the Eclipse &apos;Out of The Box Experience&apos;. The extension point can be used to define if the OOBE will be presented to the user through a Browser based implementation or an SWT based implementation.
+ 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;
+todo - add other APIs here such as IStandbyPart
</documentation>
</annotation>
@@ -18,21 +22,21 @@
<attribute name="point" type="string" use="required">
<annotation>
<documentation>
- the fully qualified identifier of the target extension point
+ a fully qualified identifier of the target extension point
</documentation>
</annotation>
</attribute>
<attribute name="id" type="string">
<annotation>
<documentation>
- an optional identifier for this extension instance
+ an optional identifier of the extension instance
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string">
<annotation>
<documentation>
- an optional name for this extension instance
+ an optional name of the extension instance
</documentation>
</annotation>
</attribute>
@@ -40,30 +44,35 @@
</element>
<element name="config">
+ <annotation>
+ <documentation>
+ A config element is put into the config extension point if there is a cheat sheet to be contributed to the workbench. 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>
<complexType>
<sequence>
<element ref="presentation"/>
- <element ref="page" minOccurs="1" maxOccurs="unbounded"/>
- <element ref="div" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="introId" type="string" use="required">
<annotation>
<documentation>
- the id of an intro part &lt;Intro&gt; contribution that will be used to associated this configuration with that intro part.
+ the id of an intro part contribution that this configuration will be associated with
</documentation>
</annotation>
</attribute>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
- unique id of this intro configuration
+ a unique name that can be used to identify this intro configuration
</documentation>
</annotation>
</attribute>
<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;.
+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>
</attribute>
@@ -73,7 +82,7 @@
<element name="presentation">
<annotation>
<documentation>
- Presentation element that defines all the possible implementations of an intro part. It can have one ore more implementation defined in it. Only one implementation will be chosen at startup, based on OS attribute. If there are more than one implementation, first one with an os attribute that matches currebt OS wins. Otherwise, first one with no os attribute defiened wins.
+ Presentation element that defines all the possible implementations of an intro part. It can have one or more implementation defined in it. Only one implementation will be chosen at startup, based the os/ws attributes of the implementations. Otherwise, the first one with no os/ws attributes defined will be chosen.
</documentation>
</annotation>
<complexType>
@@ -83,14 +92,14 @@
<attribute name="title" type="string">
<annotation>
<documentation>
- The general title of this OOBE.
+ the title of the intro presentation (todo - is this still valid?)
</documentation>
</annotation>
</attribute>
<attribute name="home-page-id" type="string" use="required">
<annotation>
<documentation>
- the id of the home (root) page. This value can be overriden by either plugin_customization.ini or by user preference.
+ the id of the home (root) page. This value can be overriden by either plugin_customization.ini or by user preference. (todo - is this overriding currently possible? will it ever be a user preference?)
</documentation>
</annotation>
</attribute>
@@ -98,14 +107,16 @@
</element>
<element name="implementation">
+ <annotation>
+ <documentation>
+ Implementation defines the presentation class that will be used for the matching os/ws attributes.
+ </documentation>
+ </annotation>
<complexType>
- <sequence>
- <element ref="head" minOccurs="0" maxOccurs="1"/>
- </sequence>
<attribute name="id" type="string">
<annotation>
<documentation>
-
+ an optional unique name that can be used to identify this implementation (todo - is this still needed?)
</documentation>
</annotation>
</attribute>
@@ -113,7 +124,7 @@
<annotation>
<documentation>
the fully qualified name of a class that implements &lt;samp&gt;org.eclipse.ui.config.XXX&lt;/samp&gt;.
-Note: do we really wanna expose this implementation detail?
+(todo - do we really wanna expose this implementation detail? If we go with kind=&quot;swt|html&quot; will this attribute be required? Currently the classes referenced are internal which is an API no-no, more reason for the kind attribute.)
</documentation>
<appInfo>
<meta.attribute kind="java" basedOn="org.eclipse.ui.XXX"/>
@@ -123,353 +134,21 @@ Note: do we really wanna expose this implementation detail?
<attribute name="style" type="string">
<annotation>
<documentation>
- The shared style that will be applied to all pages presented by this intro part implementation.
+ The shared style that will be applied to all pages presented by this intro presentation implementation.
</documentation>
</annotation>
</attribute>
<attribute name="os" type="string">
<annotation>
<documentation>
- an optional os string to enable choosing of implementation based on current OS. eg: win32,linux
+ 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?)
</documentation>
</annotation>
</attribute>
<attribute name="ws" type="string">
<annotation>
<documentation>
- an optional os string to enable choosing of implementation based on current WS. eg: win32,gtk
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="page">
- <complexType>
- <choice>
- <element ref="div"/>
- <element ref="link"/>
- <element ref="text"/>
- <element ref="head"/>
- <element ref="img"/>
- <element ref="include"/>
- <element ref="html"/>
- <element ref="title"/>
- </choice>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="title" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="alt-style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="url" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="standby-url" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="standby-style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="standby-alt-style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="link">
- <complexType>
- <sequence>
- <element ref="text" minOccurs="0" maxOccurs="1"/>
- </sequence>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="label" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="url" type="string" use="required">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="div">
- <complexType>
- <choice>
- <element ref="text"/>
- <element ref="div"/>
- <element ref="link"/>
- <element ref="img"/>
- <element ref="include"/>
- <element ref="html"/>
- </choice>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- unique identifier of the division
- </documentation>
- </annotation>
- </attribute>
- <attribute name="label" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="html">
- <annotation>
- <documentation>
- direct HTML to include in the page either by embedding the entire document, or inlining a snippet of HTML in-place. A fallback image or text must be defined for alternative rendering.
- </documentation>
- </annotation>
- <complexType>
- <choice>
- <element ref="img"/>
- <element ref="text"/>
- </choice>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- unique identifier of this HTML element
- </documentation>
- </annotation>
- </attribute>
- <attribute name="src" type="string" use="required">
- <annotation>
- <documentation>
- relative or absolute URL to a file containing HTML
- </documentation>
- </annotation>
- </attribute>
- <attribute name="type" use="required">
- <annotation>
- <documentation>
- if &apos;inline&apos;, value of &apos;src&apos; will be treated as a snippet of HTML to emit &apos;in-place&apos;. If &apos;embed&apos;, a valid (full) HTML document will be embedded using HTML &apos;OBJECT&apos; tag. (if type is not specified, this html object is ignored by the intro configuration).
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="inline">
- </enumeration>
- <enumeration value="embed">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="head">
- <annotation>
- <documentation>
- direct HTML to include in a page&apos;s HEAD content area. This markup is only to be used with an SWT Based intro part implementation. It is simply ignored in the case of a UI Forms implementation. A page can have more than one head element. An implementation can have one and only one head element (since it is a shared head content, it makes sense to just define it in one file).
- </documentation>
- </annotation>
- <complexType>
- <attribute name="src" type="string" use="required">
- <annotation>
- <documentation>
- relative or absolute URL to a file containing HTML
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="img">
- <annotation>
- <documentation>
- an image that represents presentation content (as opposed to decoration images defined in styles).
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- unique identifier of this image
- </documentation>
- </annotation>
- </attribute>
- <attribute name="src" type="string" use="required">
- <annotation>
- <documentation>
- the file to load the image from
- </documentation>
- </annotation>
- </attribute>
- <attribute name="alt" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="title">
- <annotation>
- <documentation>
- a snippet of text that can optionally contain escaped HTML tags. It is used as the page Title.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique identifier of this title.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="text">
- <annotation>
- <documentation>
- a snippet of text that can optionally contain escaped HTML tags.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique identifier of this text.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="include">
- <annotation>
- <documentation>
- expands an element targeted by the given path, and optional configId attributes. Path should uniquely address an element within the specified configuration. It could point to a div defined at the configuration level, or any element in a page.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="configId" type="string">
- <annotation>
- <documentation>
- identifier of a configuration where the included element is defined. If specified, it is assumed that the element to be included is specified in another configuration, and not the enclosing configuration. In this case, that external config is loaded and the element is resolved from that new config. If not specified, enclosing (parent) configuration of this include is assumed.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="path" type="string" use="required">
- <annotation>
- <documentation>
- the path that uniquely represents the target element within the configuration (e.g. page/div1/div2). It may be a div element, or any element that may be contained in a div. You can not include a page.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="merge-style" type="boolean">
- <annotation>
- <documentation>
- if &lt;code&gt;true&lt;/code&gt;, style belonging to the page that owns the included element will be added to list of styles of the including page. If &lt;code&gt;false&lt;/code&gt; (the default), the including page is responsible for controling properties of the included element.
+ 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?)
</documentation>
</annotation>
</attribute>
@@ -490,11 +169,29 @@ Note: do we really wanna expose this implementation detail?
<meta.section type="examples"/>
</appInfo>
<documentation>
- An example here:
-
-&lt;pre&gt;
- &lt;page&gt;dsads &lt;/page&gt;
-&lt;/pre&gt;
+ 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;
</documentation>
</annotation>
@@ -512,17 +209,7 @@ Note: do we really wanna expose this implementation detail?
<meta.section type="implementation"/>
</appInfo>
<documentation>
- There are two supplied implementations that can be used to specify the OOBE presentation UI.
-
-
-
-&lt;samp&gt;org.eclipse.ui.IIntroPart&lt;/samp&gt; interface. However, these parts are only available through the following optional plugin:
-&lt;p&gt;
-&lt;pre&gt;
-plugin name: UI Intro.
-plugin ID: org.eclipse.ui.intro
-&lt;/pre&gt;
-&lt;/p&gt;
+ The intro contributed by the org.eclipse.platform plugin is the only implementation within Eclipse.
</documentation>
</annotation>
@@ -531,7 +218,16 @@ plugin ID: org.eclipse.ui.intro
<meta.section type="copyright"/>
</appInfo>
<documentation>
- Copyright (c) 2000, 2003 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 &lt;a href=&quot;http://www.eclipse.org/legal/cpl-v10.html&quot;&gt;http://www.eclipse.org/legal/cpl-v10.html&lt;/a&gt;.
+ /************************************************************************
+ * 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>
diff --git a/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.configExtension.exsd b/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.configExtension.exsd
index 6569eb9ec..24ff9f342 100644
--- a/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.configExtension.exsd
+++ b/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.configExtension.exsd
@@ -3,10 +3,10 @@
<schema targetNamespace="org.eclipse.ui.intro">
<annotation>
<appInfo>
- <meta.schema plugin="org.eclipse.ui.intro" id="config" name="Intro Part Configuration"/>
+ <meta.schema plugin="org.eclipse.ui.intro" id="configExtension" name="Intro Part Configuration Extension"/>
</appInfo>
<documentation>
- This extension point is used to define and configure the Eclipse &apos;Out of The Box Experience&apos;. The extension point can be used to define if the OOBE will be presented to the user through a Browser based implementation or an SWT based implementation.
+ This extension point is used to extend an existing intro configuration by provide either more content or additional StandbyParts.
</documentation>
</annotation>
@@ -19,21 +19,21 @@
<attribute name="point" type="string" use="required">
<annotation>
<documentation>
- the fully qualified identifier of the target extension point
+ a fully qualified identifier of the target extension point
</documentation>
</annotation>
</attribute>
<attribute name="id" type="string">
<annotation>
<documentation>
- an optional identifier for this extension instance
+ an optional identifier of the extension instance
</documentation>
</annotation>
</attribute>
<attribute name="name" type="string">
<annotation>
<documentation>
- an optional name for this extension instance
+ an optional name of the extension instance
</documentation>
</annotation>
</attribute>
@@ -43,400 +43,24 @@
<element name="configExtension">
<annotation>
<documentation>
- Defines an extension to an intro part configuration. Any page or div in an intro part configuration can be extended, if that page has declared extensability through the expandable-by flag.
+ Defines an extension to an intro configuration. Any page or div in an intro part configuration can be extended, if that page has declared extensability through the expandable-by flag. (todo - what happened to place holders, I thought we removed the extendable attribute)
</documentation>
</annotation>
<complexType>
<sequence>
- <element ref="extensionContent"/>
- <element ref="page" minOccurs="1" maxOccurs="unbounded"/>
- <element ref="div" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="configId" type="string" use="required">
<annotation>
<documentation>
- the id of an intro part contribution that will be extended by this configExtension.
+ the id of an intro contribution that will be extended
</documentation>
</annotation>
</attribute>
<attribute name="content" type="string" use="required">
<annotation>
<documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="extensionContent">
- <annotation>
- <documentation>
- The content to be added to the target page or div. Only one extensionContent is allowed in a given configExtension because if this extension could not be resolved (if the config could not be found, or the target element could not be found, for example) then the pages and/or divs in the extension need to be ingnored.
- </documentation>
- </annotation>
- <complexType>
- <choice>
- <element ref="text"/>
- <element ref="div"/>
- <element ref="link"/>
- </choice>
- <attribute name="style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="alt-style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="path" type="string" use="required">
- <annotation>
- <documentation>
- the path that uniquely represents the element (e.g. page/div1/div2) within the target configuration to be extended. It can only be a page or a div, including shared divs at configuration level.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="page">
- <complexType>
- <choice>
- <element ref="div"/>
- <element ref="link"/>
- <element ref="text"/>
- <element ref="html"/>
- <element ref="img"/>
- <element ref="include"/>
- <element ref="title"/>
- </choice>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="title" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="alt-style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="url" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="standby-url" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="standby-style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="standby-alt-style" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="title">
- <annotation>
- <documentation>
- a snippet of text that can optionally contain escaped HTML tags. It is used as the page Title.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique identifier of this title.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="link">
- <complexType>
- <sequence>
- <element ref="text" minOccurs="0" maxOccurs="1"/>
- </sequence>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="label" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="url" type="string" use="required">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="title">
- <annotation>
- <documentation>
- a snippet of text that can optionally contain escaped HTML tags. It is used as the page Title.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique identifier of this title.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="div">
- <complexType>
- <choice>
- <element ref="text"/>
- <element ref="div"/>
- <element ref="link"/>
- <element ref="html"/>
- <element ref="img"/>
- <element ref="include"/>
- </choice>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- unique identifier of the division
- </documentation>
- </annotation>
- </attribute>
- <attribute name="label" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="html">
- <annotation>
- <documentation>
- direct HTML to include in the page either by embedding the entire document, or inlining a snippet of HTML in-place. A fallback image or text must be defined for alternative rendering.
- </documentation>
- </annotation>
- <complexType>
- <choice>
- <element ref="img"/>
- <element ref="text"/>
- </choice>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- unique identifier of this HTML element
- </documentation>
- </annotation>
- </attribute>
- <attribute name="src" type="string" use="required">
- <annotation>
- <documentation>
- relative or absolute URL to a file containing HTML
- </documentation>
- </annotation>
- </attribute>
- <attribute name="type" use="required">
- <annotation>
- <documentation>
- if &apos;inline&apos;, value of &apos;src&apos; will be treated as a snippet of HTML to emit &apos;in-place&apos;. If &apos;embed&apos;, a valid (full) HTML document will be embedded using HTML &apos;OBJECT&apos; tag. (if type is not specified, this html object is ignored by the intro configuration).
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="inline">
- </enumeration>
- <enumeration value="embed">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="img">
- <annotation>
- <documentation>
- an image that represents presentation content (as opposed to decoration images defined in styles).
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- unique identifier of this image
- </documentation>
- </annotation>
- </attribute>
- <attribute name="src" type="string" use="required">
- <annotation>
- <documentation>
- the file to load the image from
- </documentation>
- </annotation>
- </attribute>
- <attribute name="alt" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="text">
- <annotation>
- <documentation>
- a snippet of text that can optionally contain escaped HTML tags.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique identifier of this text.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class-id" type="string">
- <annotation>
- <documentation>
-
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="include">
- <annotation>
- <documentation>
- expands an element targeted by the given path, and optional configId attributes. Path should uniquely address an element within the specified configuration. It could point to a div defined at the configuration level, or any element in a page.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="configId" type="string">
- <annotation>
- <documentation>
- identifier of a configuration where the included element is defined. If specified, it is assumed that the element to be included is specified in another configuration, and not the enclosing configuration. In this case, that external config is loaded and the element is resolved from that new config. If not specified, enclosing (parent) configuration of this include is assumed.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="path" type="string" use="required">
- <annotation>
- <documentation>
- the path that uniquely represents the target element within the configuration (e.g. page/div1/div2). It may be a div element, or any element that may be contained in a div.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="merge-style" type="boolean">
- <annotation>
- <documentation>
- if &lt;code&gt;true&lt;/code&gt;, style belonging to the page that owns the included element will be added to list of styles of the including page. If &lt;code&gt;false&lt;/code&gt; (the default), the including page is responsible for controling properties of the included element.
+ 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>
</attribute>
@@ -446,28 +70,29 @@
<element name="standbyPart">
<annotation>
<documentation>
- standby part registration.
+ standby part registration. (todo - seems out of place) (todo - say something about the intro command and the id to reference this standbypart)
</documentation>
</annotation>
<complexType>
<attribute name="id" type="string" use="required">
<annotation>
<documentation>
-
+ (todo - say something about the intro command and the id to reference this standbypart)
</documentation>
</annotation>
</attribute>
- <attribute name="pluginId" type="string" use="required">
+ <attribute name="pluginId" type="string">
<annotation>
<documentation>
- The name of the plugin that holds the class defined in the &quot;class&quot; attribute.
+ The name of the plugin that holds the class defined in the &quot;class&quot; attribute. (todo - is this needed? shouldn&apos;t the class be in the declaring plugin already.)
</documentation>
</annotation>
</attribute>
<attribute name="class" type="string" use="required">
<annotation>
<documentation>
- The name of a class that implements IStandbyContent interface in org.eclipse.ui.intro.
+ The fully qualified class name of the class that implements &lt;code&gt;org.eclipse.ui.intro.IStandbyContentPart&lt;/code&gt; to handle displaying alternative standby content, such as a cheat sheet. The class must be public, and have a public 1-argument constructor that accepts the attribute name
+(a &lt;code&gt;String&lt;/code&gt;).
</documentation>
</annotation>
</attribute>
@@ -488,11 +113,18 @@
<meta.section type="examples"/>
</appInfo>
<documentation>
- An example here:
-
-&lt;pre&gt;
- &lt;page&gt;dsads &lt;/page&gt;
-&lt;/pre&gt;
+ Here is an example implementation of this extension point:
+
+&lt;extension point=&quot;org.eclipse.ui.intro.configExtension&quot;&gt;
+ &lt;configExtension
+ configId=&quot;com.org.xyz.introConfig&quot;
+ content=&quot;extensionContent.xml&quot;/&gt;
+
+ &lt;standbyPart
+ id=&quot;com.org.xyz.myStandbyPart&quot;
+ class=&quot;com.org.xyz.internal.MyStandbyContent&quot;
+ pluginId=&quot;org.eclipse.platform&quot;/&gt; (todo - remove the pluginId?)
+&lt;/extension&gt;
</documentation>
</annotation>
@@ -510,17 +142,12 @@
<meta.section type="implementation"/>
</appInfo>
<documentation>
- There are two supplied implementations that can be used to specify the OOBE presentation UI.
-
-
-
-&lt;samp&gt;org.eclipse.ui.IIntroPart&lt;/samp&gt; interface. However, these parts are only available through the following optional plugin:
-&lt;p&gt;
-&lt;pre&gt;
-plugin name: UI Intro.
-plugin ID: org.eclipse.ui.intro
-&lt;/pre&gt;
-&lt;/p&gt;
+ There are three supplied implementations:
+&lt;ul&gt;
+&lt;li&gt;org.eclipse.jdt, makes use of configExtension&lt;/li&gt;
+&lt;li&gt;org.eclipse.pde, makes use of configExtension&lt;/li&gt;
+&lt;li&gt;org.eclipse.platform, makes use of standbyPoint&lt;/li&gt;
+&lt;/ul&gt;
</documentation>
</annotation>
@@ -529,7 +156,16 @@ plugin ID: org.eclipse.ui.intro
<meta.section type="copyright"/>
</appInfo>
<documentation>
- Copyright (c) 2000, 2003 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 &lt;a href=&quot;http://www.eclipse.org/legal/cpl-v10.html&quot;&gt;http://www.eclipse.org/legal/cpl-v10.html&lt;/a&gt;.
+ /************************************************************************
+ * 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>
diff --git a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/IStandbyContentPart.java b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/IStandbyContentPart.java
index af9faf99c..eea3ed64f 100644
--- a/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/IStandbyContentPart.java
+++ b/org.eclipse.ui.intro/src/org/eclipse/ui/internal/intro/impl/parts/IStandbyContentPart.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * 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
@@ -14,17 +14,76 @@ import org.eclipse.swt.widgets.*;
import org.eclipse.ui.forms.widgets.*;
import org.eclipse.ui.intro.*;
+/**
+ * A view is a visual component within a workbench page. It is typically used to
+ * navigate a hierarchy of information (like the workspace), open an editor,
+ * or display properties for the active editor. Modifications made in a view are
+ * saved immediately (in contrast to an editor part, which conforms to a more
+ * elaborate open-save-close lifecycle).
+ * <p>
+ * (todo - need to mention extension point used to contribute standby parts to the intro)
+ * </p>
+ *
+ * @since 3.0
+ */
public interface IStandbyContentPart {
+ /**
+ * Creates the SWT controls for this cheat sheet viewer.
+ * <p>
+ * Clients should not call this method (the intro framework calls this method when
+ * it needs to, which may be never).
+ * </p>
+ *
+ * @param parent the parent control
+ * @param toolkit the form toolkit being used by the IIntroPart implementation
+ */
public void createPartControl(Composite parent, FormToolkit toolkit);
+ /**
+ * Returns the primary control associated with this viewer.
+ *
+ * @return the SWT control which displays this standby part's
+ * content, or <code>null</code> if this standby part's controls
+ * have not yet been created.
+ */
public Control getControl();
+ /**
+ * Initializes this standby part with the introPart.
+ * <p>
+ * This method is automatically called by the intro framework shortly after part
+ * construction. It marks the start of the standby part's lifecycle. Clients must
+ * not call this method.
+ * </p>
+ *
+ * @param introPart the intro part
+ */
public void init(IIntroPart introPart);
+ /**
+ * Sets the input to show in this standby part.
+ *
+ * @param input the new input, or <code>null</code> to show
+ * the default content in this standby part
+ */
public void setInput(Object input);
+ /**
+ * Asks this cheat sheet viewer to take focus.
+ * <p>
+ * Clients should not call this method (the intro framework calls this method at
+ * appropriate times).
+ * </p>
+ */
public void setFocus();
+ /**
+ * Disposes of this cheat sheet viewer.
+ * <p>
+ * Clients should not call this method (the intro framework calls this method at
+ * appropriate times).
+ * </p>
+ */
public void dispose();
} \ No newline at end of file

Back to the top