Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd')
-rw-r--r--org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd434
1 files changed, 65 insertions, 369 deletions
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>

Back to the top