From 85e40ffb5c6bee26ea7311227478a83b22ce1e6d Mon Sep 17 00:00:00 2001 From: lparsons Date: Fri, 4 Jun 2004 18:27:16 +0000 Subject: Fix for Bug 65635 --- org.eclipse.ui.intro/schema/config.exsd | 236 +++++++++++++++++++++ org.eclipse.ui.intro/schema/configExtension.exsd | 201 ++++++++++++++++++ .../schema/org.eclipse.ui.intro.config.exsd | 236 --------------------- .../org.eclipse.ui.intro.configExtension.exsd | 201 ------------------ 4 files changed, 437 insertions(+), 437 deletions(-) create mode 100644 org.eclipse.ui.intro/schema/config.exsd create mode 100644 org.eclipse.ui.intro/schema/configExtension.exsd delete mode 100644 org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd delete mode 100644 org.eclipse.ui.intro/schema/org.eclipse.ui.intro.configExtension.exsd (limited to 'org.eclipse.ui.intro') diff --git a/org.eclipse.ui.intro/schema/config.exsd b/org.eclipse.ui.intro/schema/config.exsd new file mode 100644 index 000000000..61a0cd59a --- /dev/null +++ b/org.eclipse.ui.intro/schema/config.exsd @@ -0,0 +1,236 @@ + + + + + + + + + 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 "Help" menu. The intro is typically used to introduce a user to a product built on Eclipse. +<p> +The intros are organized into pages which usually reflect a particular category of introductory material. For instance, a What'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 <a href="org.eclipse.ui.intro.configExtension.exsd">org.eclipse.ui.intro.configExtension</a> extension point. +<p> +todo - add other APIs here such as IStandbyPart + + + + + + + + + + + + + + a fully qualified identifier of the target extension point + + + + + + + an optional identifier of the extension instance + + + + + + + an optional name of the extension instance + + + + + + + + + + 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. + + + + + + + + + + the id of an intro part contribution that this configuration will be associated with. + + + + + + + a unique name that can be used to identify this intro configuration + + + + + + + an intro content file. The content file is an XML file that contains the specifics of the intro (<a href="introContentFileSpec.html">intro content file format specification)</a>. +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. + + + + + + + + + + Presentation element that defines all the possible implementations of an intro part's presentation. 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. + + + + + + + + + + the id of the home (root) page. + + + + + + + an optional attribute to define the id of the standby page. The standby page will be shown to the user when the Intro is set to standby. + + + + + + + + + + The presentation of the Platform'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 shared style that will be applied to all pages presented by this intro presentation implementation. + + + + + + + os string used when choosing the presentation's implementation based on current OS. eg: win32,linux (todo - where are the valid OS strings used by Eclipse defined?) + + + + + + + ws string used when choosing the presentation'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?) + + + + + + + + + + + + 3.0 + + + + + + + + + Here is a sample usage of the config extension point. + +<extension id="intro" point="org.eclipse.ui.intro.config"> + <config + introId="com.org.xyz.intro" + id="com.org.xyz.introConfig" + content="introContent.xml"> + <presentation + home-page-id="root" + title="%intro.title"> + <implementation + ws="win32" + style="css/shared.css" + class="org.eclipse.ui.internal.intro.impl.presentations.BrowserIntroPartImplementation" + os="win32"> + </implementation> + <implementation + style="css/shared_swt.properties" + class="org.eclipse.ui.internal.intro.impl.presentations.FormIntroPartImplementation"> + </implementation> + </presentation> + </config> +</extension> + + + + + + + + + [Enter API information here.] + + + + + + + + + The intro contributed by the org.eclipse.platform plugin is the only implementation within Eclipse. + + + + + + + + + /************************************************************************ + * 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 + *************************************************************************/ + + + + diff --git a/org.eclipse.ui.intro/schema/configExtension.exsd b/org.eclipse.ui.intro/schema/configExtension.exsd new file mode 100644 index 000000000..c7135728c --- /dev/null +++ b/org.eclipse.ui.intro/schema/configExtension.exsd @@ -0,0 +1,201 @@ + + + + + + + + + This extension point is used to extend an existing intro configuration by providing more content, additional StandbyContentParts or additional IntroUrl actions. + + + + + + + + + + + + + + a fully qualified identifier of the target extension point + + + + + + + an optional identifier of the extension instance + + + + + + + an optional name of the extension instance + + + + + + + + + + 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 defining place holders. + + + + + + + the id of an intro contribution that will be extended + + + + + + + an intro content file. The content file is an XML file that contains the specifics of the intro (<a href="introContentFileSpec.html">intro content file format specification)</a>. +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. + + + + + + + + + + standby content part registration. Once registered, standby parts can be launched through an introURL action of the following format: +<pre> +http://org.eclipse.ui.intro/showStandby?partId=org.eclipse.ui.intro.config.contextHelp +</pre> + + + + + + + a unique id that identifies this standbyPart. + + + + + + + The name of the plugin that holds the class defined in the "class" attribute. (todo - is this needed? shouldn't the class be in the declaring plugin already.) + + + + + + + The fully qualified class name of the class that implements <code>org.eclipse.ui.intro.config.IStandbyContentPart</code> to handle displaying alternative standby content, such as a cheat sheet. + + + + + + + + + + Custom Intro URL action registration. This can be used to create new Intro URL actions. It can be used to create a shortCut action or create custom actions. +For example: +a short cut command is: + +a custom command is: + + + + + + + + + + + + + + + + + + + + + + + + + + 3.0 + + + + + + + + + Here is an example implementation of this extension point: + +<extension point="org.eclipse.ui.intro.configExtension"> + <configExtension + configId="com.org.xyz.introConfig" + content="extensionContent.xml"/> + + <standbyPart + id="com.org.xyz.myStandbyPart" + class="com.org.xyz.internal.MyStandbyContent" + pluginId="org.eclipse.platform"/> (todo - remove the pluginId?) +</extension> + + + + + + + + + [Enter API information here.] + + + + + + + + + There are three supplied implementations: +<ul> +<li>org.eclipse.jdt, makes use of configExtension</li> +<li>org.eclipse.pde, makes use of configExtension</li> +<li>org.eclipse.platform, makes use of standbyPoint</li> +</ul> + + + + + + + + + /************************************************************************ + * 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 + *************************************************************************/ + + + + 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 deleted file mode 100644 index 387dd8364..000000000 --- a/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.config.exsd +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - - - - 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 "Help" menu. The intro is typically used to introduce a user to a product built on Eclipse. -<p> -The intros are organized into pages which usually reflect a particular category of introductory material. For instance, a What'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 <a href="org.eclipse.ui.intro.configExtension.exsd">org.eclipse.ui.intro.configExtension</a> extension point. -<p> -todo - add other APIs here such as IStandbyPart - - - - - - - - - - - - - - a fully qualified identifier of the target extension point - - - - - - - an optional identifier of the extension instance - - - - - - - an optional name of the extension instance - - - - - - - - - - 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. - - - - - - - - - - the id of an intro part contribution that this configuration will be associated with. - - - - - - - a unique name that can be used to identify this intro configuration - - - - - - - an intro content file. The content file is an XML file that contains the specifics of the intro (<a href="introContentFileSpec.html">intro content file format specification)</a>. -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. - - - - - - - - - - Presentation element that defines all the possible implementations of an intro part's presentation. 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. - - - - - - - - - - the id of the home (root) page. - - - - - - - an optional attribute to define the id of the standby page. The standby page will be shown to the user when the Intro is set to standby. - - - - - - - - - - The presentation of the Platform'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 shared style that will be applied to all pages presented by this intro presentation implementation. - - - - - - - os string used when choosing the presentation's implementation based on current OS. eg: win32,linux (todo - where are the valid OS strings used by Eclipse defined?) - - - - - - - ws string used when choosing the presentation'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?) - - - - - - - - - - - - 3.0 - - - - - - - - - Here is a sample usage of the config extension point. - -<extension id="intro" point="org.eclipse.ui.intro.config"> - <config - introId="com.org.xyz.intro" - id="com.org.xyz.introConfig" - content="introContent.xml"> - <presentation - home-page-id="root" - title="%intro.title"> - <implementation - ws="win32" - style="css/shared.css" - class="org.eclipse.ui.internal.intro.impl.presentations.BrowserIntroPartImplementation" - os="win32"> - </implementation> - <implementation - style="css/shared_swt.properties" - class="org.eclipse.ui.internal.intro.impl.presentations.FormIntroPartImplementation"> - </implementation> - </presentation> - </config> -</extension> - - - - - - - - - [Enter API information here.] - - - - - - - - - The intro contributed by the org.eclipse.platform plugin is the only implementation within Eclipse. - - - - - - - - - /************************************************************************ - * 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 - *************************************************************************/ - - - - 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 deleted file mode 100644 index c3b40c01b..000000000 --- a/org.eclipse.ui.intro/schema/org.eclipse.ui.intro.configExtension.exsd +++ /dev/null @@ -1,201 +0,0 @@ - - - - - - - - - This extension point is used to extend an existing intro configuration by providing more content, additional StandbyContentParts or additional IntroUrl actions. - - - - - - - - - - - - - - a fully qualified identifier of the target extension point - - - - - - - an optional identifier of the extension instance - - - - - - - an optional name of the extension instance - - - - - - - - - - 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 defining place holders. - - - - - - - the id of an intro contribution that will be extended - - - - - - - an intro content file. The content file is an XML file that contains the specifics of the intro (<a href="introContentFileSpec.html">intro content file format specification)</a>. -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. - - - - - - - - - - standby content part registration. Once registered, standby parts can be launched through an introURL action of the following format: -<pre> -http://org.eclipse.ui.intro/showStandby?partId=org.eclipse.ui.intro.config.contextHelp -</pre> - - - - - - - a unique id that identifies this standbyPart. - - - - - - - The name of the plugin that holds the class defined in the "class" attribute. (todo - is this needed? shouldn't the class be in the declaring plugin already.) - - - - - - - The fully qualified class name of the class that implements <code>org.eclipse.ui.intro.config.IStandbyContentPart</code> to handle displaying alternative standby content, such as a cheat sheet. - - - - - - - - - - Custom Intro URL action registration. This can be used to create new Intro URL actions. It can be used to create a shortCut action or create custom actions. -For example: -a short cut command is: - -a custom command is: - - - - - - - - - - - - - - - - - - - - - - - - - - 3.0 - - - - - - - - - Here is an example implementation of this extension point: - -<extension point="org.eclipse.ui.intro.configExtension"> - <configExtension - configId="com.org.xyz.introConfig" - content="extensionContent.xml"/> - - <standbyPart - id="com.org.xyz.myStandbyPart" - class="com.org.xyz.internal.MyStandbyContent" - pluginId="org.eclipse.platform"/> (todo - remove the pluginId?) -</extension> - - - - - - - - - [Enter API information here.] - - - - - - - - - There are three supplied implementations: -<ul> -<li>org.eclipse.jdt, makes use of configExtension</li> -<li>org.eclipse.pde, makes use of configExtension</li> -<li>org.eclipse.platform, makes use of standbyPoint</li> -</ul> - - - - - - - - - /************************************************************************ - * 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 - *************************************************************************/ - - - - -- cgit v1.2.3