| <?xml version='1.0' encoding='UTF-8'?> |
| <!-- Schema file written by PDE --> |
| <schema targetNamespace="org.eclipse.ui"> |
| <annotation> |
| <appInfo> |
| <meta.schema plugin="org.eclipse.ui" id="intro" name="Intro Part"/> |
| </appInfo> |
| <documentation> |
| <p>This extension point is used to register implementations of special workbench parts, called intro parts, that are responsible for introducing a product to new users. An intro part is typically shown the first time a product is started up. Rules for associating an intro part implementation with particular products are also contributed via this extension point. |
| </p> |
| The life cycle is as follows: |
| <ul> |
| <li>The intro area is created on workbench start up. As with editor and view areas, this area is managed by an intro site (implementing <code>org.eclipse.ui.intro.IIntroSite</code>).</li> |
| <li>The id of the current product (Platform.getProduct()) is used to choose the relevant intro part implementation. |
| </li> |
| <li>The intro part class (implementing <code>org.eclipse.ui.intro.IIntroPart</code>) is created and initialized with the intro site. |
| </li> |
| <li>While the intro part is showing to the user, it can transition back and forth between full and standby mode (either programmatically or explicitly by the user). |
| </li> |
| <li>Eventually the intro part is closed (either programmatically or explicitly by the user). The current perspective takes over the entire workbench window area. |
| </li> |
| </ul> |
| </documentation> |
| </annotation> |
| |
| <element name="extension"> |
| <complexType> |
| <sequence> |
| <element ref="intro" minOccurs="0" maxOccurs="unbounded"/> |
| <element ref="introProductBinding" minOccurs="0" maxOccurs="unbounded"/> |
| </sequence> |
| <attribute name="point" type="string" use="required"> |
| <annotation> |
| <documentation> |
| a fully qualified identifier of the target extension point |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="id" type="string"> |
| <annotation> |
| <documentation> |
| an optional identifier of the extension instance |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="name" type="string"> |
| <annotation> |
| <documentation> |
| an optional name of the extension instance |
| </documentation> |
| <appInfo> |
| <meta.attribute translatable="true"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <element name="intro"> |
| <annotation> |
| <appInfo> |
| <meta.element labelAttribute="id" icon="icon"/> |
| </appInfo> |
| <documentation> |
| Specifies an introduction. An introduction is a product-specific presentation shown to first-time users on product start up. |
| </documentation> |
| </annotation> |
| <complexType> |
| <attribute name="id" type="string" use="required"> |
| <annotation> |
| <documentation> |
| a unique identifier for this introduction |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="icon" type="string"> |
| <annotation> |
| <documentation> |
| a plug-in-relative file name of the icon that will be associated with this introduction |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="resource"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| <attribute name="class" type="string" use="required"> |
| <annotation> |
| <documentation> |
| a fully qualified name of the class implementing the <code>org.eclipse.ui.intro.IIntroPart</code> interface. A common practice |
| is to subclass <samp>org.eclipse.ui.part.intro.IntroPart</samp> |
| in order to inherit the default functionality. This class implements the introduction. |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="java" basedOn="org.eclipse.ui.intro.IIntroPart"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| <attribute name="contentDetector" type="string"> |
| <annotation> |
| <documentation> |
| a fully qualified name of a class extending <code>org.eclipse.ui.intro.IntroContentDetector</code>. This optional class is used to detect newly added introduction content. If new content is available, the view showing the introduction will be opened again. |
| </documentation> |
| <appInfo> |
| <meta.attribute kind="java" basedOn="org.eclipse.ui.intro.IntroContentDetector"/> |
| </appInfo> |
| </annotation> |
| </attribute> |
| <attribute name="label" type="string"> |
| <annotation> |
| <documentation> |
| an string label for this introduction that will be used in the construction of the open action as well as the part label |
| Since 3.2 |
| </documentation> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <element name="introProductBinding"> |
| <annotation> |
| <documentation> |
| Specifies a binding between a product and an introduction. These bindings determine which introduction is appropriate for the current product (as defined by <code>org.eclipse.core.runtime.Platform.getProduct()</code>). |
| </documentation> |
| </annotation> |
| <complexType> |
| <attribute name="productId" type="string" use="required"> |
| <annotation> |
| <documentation> |
| unique id of a product |
| </documentation> |
| </annotation> |
| </attribute> |
| <attribute name="introId" type="string" use="required"> |
| <annotation> |
| <documentation> |
| unique id of an introduction |
| </documentation> |
| </annotation> |
| </attribute> |
| </complexType> |
| </element> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="since"/> |
| </appInfo> |
| <documentation> |
| 3.0 |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="examples"/> |
| </appInfo> |
| <documentation> |
| The following is an example of an intro part extension that contributes an particular introduction and associates it with a particular product: |
| <p> |
| <pre> |
| <extension point="org.eclipse.ui.intro"> |
| <intro |
| id="com.example.xyz.intro.custom" |
| class="com.example.xyz.intro.IntroPart"/> |
| <introProductBinding |
| productId="com.example.xyz.Product" |
| introId="com.example.xyz.intro.custom"/> |
| </extension> |
| </pre> |
| </p> |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="apiInfo"/> |
| </appInfo> |
| <documentation> |
| The value of the <code>class</code> attribute must be the fully qualified name of a class that implements the<code>org.eclipse.ui.intro.IIntroPart</code> interface by subclassing <code>org.eclipse.ui.part.intro.IntroPart</code>. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="implementation"/> |
| </appInfo> |
| <documentation> |
| There are no default implementations of the initial user experience. Each Eclipse-based product is responsible for providing one that is closely matched to its branding and function. |
| </documentation> |
| </annotation> |
| |
| <annotation> |
| <appInfo> |
| <meta.section type="copyright"/> |
| </appInfo> |
| <documentation> |
| Copyright (c) 2004, 2007 IBM Corporation and others.<br> |
| All rights reserved. This program and the accompanying materials are made |
| available under the terms of the Eclipse Public License v1.0 which accompanies |
| this distribution, and is available at <a |
| href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> |
| </documentation> |
| </annotation> |
| |
| </schema> |