diff options
| author | Mazen Faraj | 2004-06-23 21:29:13 +0000 |
|---|---|---|
| committer | Mazen Faraj | 2004-06-23 21:29:13 +0000 |
| commit | 7f339727c8c4a91f2fb011c285a943ceb4505faa (patch) | |
| tree | f704c9186c055c5a9f8705b21d285b593ea22b8f | |
| parent | 2e98d59317c9a6cc7002e401e7d324a0a3cea01f (diff) | |
| download | eclipse.platform.ua-7f339727c8c4a91f2fb011c285a943ceb4505faa.tar.gz eclipse.platform.ua-7f339727c8c4a91f2fb011c285a943ceb4505faa.tar.xz eclipse.platform.ua-7f339727c8c4a91f2fb011c285a943ceb4505faa.zip | |
changing file to -kkv
| -rw-r--r-- | org.eclipse.ui.intro/schema/IntroContent.exsd | 1282 | ||||
| -rw-r--r-- | org.eclipse.ui.intro/schema/config.exsd | 472 | ||||
| -rw-r--r-- | org.eclipse.ui.intro/schema/configExtension.exsd | 416 |
3 files changed, 1085 insertions, 1085 deletions
diff --git a/org.eclipse.ui.intro/schema/IntroContent.exsd b/org.eclipse.ui.intro/schema/IntroContent.exsd index a0ebf6e6b..b072a607c 100644 --- a/org.eclipse.ui.intro/schema/IntroContent.exsd +++ b/org.eclipse.ui.intro/schema/IntroContent.exsd @@ -1,641 +1,641 @@ -<?xml version='1.0' encoding='UTF-8'?>
-<!-- Schema file written by PDE -->
-<schema targetNamespace="org.eclipse.ui.intro">
-<annotation>
- <appInfo>
- <meta.schema plugin="org.eclipse.ui.intro" id="null" name=""/>
- </appInfo>
- <documentation>
-
- </documentation>
- </annotation>
-
- <element name="introContent">
- <annotation>
- <documentation>
- The introContent element defines the body of the intro content file. The content file is made up of pages, shared groups that can be included in multiple pages, and extensions to anchor points defined in other configurations.
- </documentation>
- </annotation>
- <complexType>
- <sequence>
- <element ref="page" minOccurs="1" maxOccurs="unbounded"/>
- <element ref="group" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="extensionContent" minOccurs="0" maxOccurs="unbounded"/>
- </sequence>
- </complexType>
- </element>
-
- <element name="page">
- <annotation>
- <documentation>
- This element is used to describe a page to be displayed. The intro can display both dynamic and static pages.<br>
-<br>
-Content for dynamic pages is generated from the subelements of the page, described below. The style or alt-style will be applied depending on the presentation. The styles can be further enhanced by referencing the id or class-id.<br>
-<br/>
-Static pages allow for the reuse of existing HTML documents within one's introduction, and can be linked to from any static or dynamic page. Static pages are not defined in a page element, they are simply html files that can be linked to by other pages.<br>
-<br/>
-The home page, whose id is specified in the presentation element of the intro config extension point, can have a url indicating that it is a static page. If no url is specified then the home page is assumed to be dynamic. All other pages described using the page element are dynamic.
-<br/>
- Also note that 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/>
-
-The subelements used in a dynamic page are as follows: A <b>group</b> subelement is used to group related content and apply style across the grouped content. A <b>link</b> subelement defines a link which can be used to link to a static or dynamic page and run an intro action/command. A link is normally defined at the page level to navigate between main pages versus links within a page. A <b>text</b> subelement defines textual content at the page level. A <b>head</b> subelement is only applicable for the Web based presentation and allows for additional html to be added to the HTML <b>head</b> section. This is useful for adding java scripts or extra style sheets. An <b>img</b> subelement defines image content for the page level. An <b>include</b> subelement allows for reuse of any element other than a page. An <b>html</b> 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 <b>object</b> by referencing the html file. Inclusion allows for including an html snippet directly from an html file. A <b>title</b> subelement defines the title of the page. An <b>anchor</b> subelement defines a point where external contributions can be made by an <extensionContent> element.
- </documentation>
- </annotation>
- <complexType>
- <choice>
- <element ref="group" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="link" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="text" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="head" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="img" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="include" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="html" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="title" minOccurs="0" maxOccurs="1"/>
- <element ref="anchor" minOccurs="0" maxOccurs="unbounded"/>
- </choice>
- <attribute name="url" type="string">
- <annotation>
- <documentation>
- The optional relative path to an HTML file. When using the Web based presentation, this HTML file will be displayed instead of any content defined for this page. This attribute is only applicable to the home page, which is identified in the presentation element of the intro config extension point. It is ignored for all other pages.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- A unique name that can be used to identify this page.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style" type="string">
- <annotation>
- <documentation>
- A relative path to a CSS file which is applied to the page only when using the Web based presentation.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="alt-style" type="string">
- <annotation>
- <documentation>
- A relative path to a SWT presentation properies file which is applied to the page only when using the SWT based presentation.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="filteredFrom">
- <annotation>
- <documentation>
- an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- <attribute name="content" type="string">
- <annotation>
- <documentation>
- an optional attribute which can define the location of an introContent.xml file that represents the content of this page. When this attribute is defined, all children and attributes in this page element, except id, are ignored. This is because the content of this page is now assumed to reside in the xml file pointed to by the content file attribute. When resolving to the content of this file, the page with an id that matches the id defined in this page element is chosen.
-This seperation of pages can be used when performance is an issue, as the content of a page is now loaded more lazily.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style-id" type="string">
- <annotation>
- <documentation>
- A means to classifiy the page into a given category so that a common style may be applied.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="group">
- <annotation>
- <documentation>
- Used to group related content, content that should have similar style applied, or content that will be included together in other pages.
- </documentation>
- </annotation>
- <complexType>
- <choice>
- <element ref="group" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="link" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="text" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="img" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="include" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="html" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="anchor" minOccurs="0" maxOccurs="unbounded"/>
- </choice>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- unique identifier of the group
- </documentation>
- </annotation>
- </attribute>
- <attribute name="label" type="string">
- <annotation>
- <documentation>
- a label or heading for this group
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style-id" type="string">
- <annotation>
- <documentation>
- A means to classifiy this group into a given category so that a common style may be applied.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="filteredFrom">
- <annotation>
- <documentation>
- an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- </complexType>
- </element>
-
- <element name="link">
- <annotation>
- <documentation>
- Can link to a static HTML file, an external web site, or can run an Intro URL action.
- </documentation>
- </annotation>
- <complexType>
- <sequence>
- <element ref="text" minOccurs="0" maxOccurs="1"/>
- <element ref="img" minOccurs="0" maxOccurs="1"/>
- </sequence>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- A unique id that can be used to identify this link
- </documentation>
- </annotation>
- </attribute>
- <attribute name="label" type="string">
- <annotation>
- <documentation>
- The text name of this link
- </documentation>
- </annotation>
- </attribute>
- <attribute name="url" type="string" use="required">
- <annotation>
- <documentation>
- A valid URL to an external web site, a static html file, or an Intro URL that represents an Intro action. All intro URLs have the following form: http://org.eclipse.ui.intro/<action name>?param1=value1&param2=value2 and will be processed by the intro framework.
-
-<br><br>
-The predefined actions will be described using this format:
-<br>
-<p style="margin-left:15px;">
-<b>action name</b> - descripton of action<br>
-<i>action parameter1</i> - description of parameter<br>
-<i>action parameter2 (optional)</i> - description of parameter<br>
-<i>action parameter3 (optional) = ("true" | "false") "false"</i> - description of parameter, choice of either true or false and "false" is the default<br>
-</p>
-
-<br>
-The following predefined actions are included in the intro framework:
-<p style="margin-left:15px;">
-<b>close</b> - closes the intro part<br>
-no parameters required<br>
-<br>
-
-<b>navigate</b> - navigate through the intro pages in a given direction or return to the home page<br>
-<i>direction = ("backward" | "forward" | "home")</i> - specifies the direction to navigate<br>
-<br>
-
-<b>openBrowser</b> - open the url in an external browser<br>
-<i>url</i> - a valid URL to an external web site or a static HTML file<br>
-<i>pluginId (optional)</i> - only required if a static HTML file is specified. This is the id of the plug-in containing the file.<br>
-<br>
-
-<b>runAction</b> - runs the specified action<br>
-<i>class</i> - the fully qualified class name of the class that implements one of <code>org.eclipse.ui.intro.config.IIntroAction</code>,
- <code>org.eclipse.jface.actino.IAction</code>, or <code>org.eclipse.ui.IActionDelegate</code><br>
-<i>pluginId</i> - The id of the plug-in which contains the class.<br>
-<i>standby (optional) = ("true" | "false") "false"</i> - indicate whether to set the intro into standby mode after executing the action<br>
-additional parameters - any additional parameters are passed to actions that implement <code>org.eclipse.ui.intro.config.IIntroAction</code><br>
-<br>
-
-<b>setStandbyMode</b> - sets the state of the intro part<br>
-<i>standby = ("true" | "false")</i> - true to put the intro part in its partially visible standy mode, and false to make it fully visible<br>
-<br>
-
-<b>showHelp</b> - Open the help system.<br>
-no parameters required<br>
-<br>
-
-<b>showHelpTopic</b> - Open a help topic.<br>
-<i>id</i> - the URL of the help resource. (See Javadoc for <code>org.eclipse.ui.help.WorkbenchHelp.displayHelpResource</code><br>
-<br>
-
-<b>showMessage</b> - Displays a message to the user using a standard information dialog.<br>
-<i>message</i> - the message to show the user<br>
-<br>
-
-<b>showStandby</b> - Sets the intro part to standby mode and shows the standbyContentPart with the given input<br>
-<i>partId</i> - the id of the standbyContentPart to show<br>
-<i>input</i> - the input to set on the standbyContentPart<br>
-<br>
-
-<b>showPage</b> - show the intro page with the given id<br>
-<i>id</i> - the id of the intro page to show<br>
-<i>standby (optional) = ("true" | "false") "false"</i> - indicate whether to set the intro into standby mode after showing the page<br>
-</p>
-<br>
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style-id" type="string">
- <annotation>
- <documentation>
- A means to classifiy this link into a given category so that a common style may be applied.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="filteredFrom">
- <annotation>
- <documentation>
- an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </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 swt presentation rendering.
-<br>
-Embedding allows for a fully defined html file to be embedded within the dynamic page's content. An HTML <b>object</b> element is created that references the html file.
-<br>
-Inclusion allows for including an html snippet directly from a file into the dynamic html page.
- </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 'embed', a valid (full) HTML document will be embedded using HTML 'OBJECT' tag. If 'inline', value of 'src' will be treated as a snippet of HTML to emit 'in-place'. (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="style-id" type="string">
- <annotation>
- <documentation>
- A means to classifiy this HTML element into a given category so that a common style may be applied.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="filteredFrom">
- <annotation>
- <documentation>
- an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- </complexType>
- </element>
-
- <element name="title">
- <annotation>
- <documentation>
- a snippet of text that can optionally contain escaped HTML tags. It is only used as a Page Title, and so a given page can have a maximum of one title element.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique identifier of this title.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style-id" type="string">
- <annotation>
- <documentation>
- A means to classifiy this element into a given category so that a common style may be applied
- </documentation>
- </annotation>
- </attribute>
- <attribute name="filteredFrom">
- <annotation>
- <documentation>
- an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- </complexType>
- </element>
-
- <element name="text">
- <annotation>
- <documentation>
- a snippet of text that can optionally contain escaped HTML tags. It can include b and li tags. It can also contain anchors for urls.
-If multiple paragraphs are needed, then the text can be divided into multiple sections each begining and ending with the p tag.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique identifier of this text.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style-id" type="string">
- <annotation>
- <documentation>
- A means to classifiy this element into a given category so that a common style may be applied
- </documentation>
- </annotation>
- </attribute>
- <attribute name="filteredFrom">
- <annotation>
- <documentation>
- an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </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 shared group 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/group1/group2). It may be a group element, or any element that may be contained in a group. You can not include a page.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="merge-style" type="boolean">
- <annotation>
- <documentation>
- if <code>true</code>, style belonging to the page that owns the included element will be added to list of styles of the including page. If <code>false</code> (the default), the including page is responsible for controlling properties of the included element.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="head">
- <annotation>
- <documentation>
- Direct HTML to include in a page's HEAD content area. It allows for additional html to be added to the HTML HEAD section. This is useful for adding java srcipts or extra styles sheets.
-This markup is only to be used with an HTML 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 across all pages).
- </documentation>
- </annotation>
- <complexType>
- <attribute name="src" type="string" use="required">
- <annotation>
- <documentation>
- relative or absolute URL to a file containing HTML to include directly into the HTML head section.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="img">
- <annotation>
- <documentation>
- An image that represents intro content and not presentation (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>
- the alternative text to use when the image can not be loaded and as tooltip text for the image.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="style-id" type="string">
- <annotation>
- <documentation>
- A means to classifiy this image into a given category so that a common style may be applied.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="filteredFrom">
- <annotation>
- <documentation>
- an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation.
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- </complexType>
- </element>
-
- <element name="extensionContent">
- <annotation>
- <documentation>
- The content to be added to the target anchor. 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 anchor element could not be found) then the pages and/or groups in the extension need to be ingnored.
- </documentation>
- </annotation>
- <complexType>
- <choice>
- <element ref="text"/>
- <element ref="group"/>
- <element ref="link"/>
- <element ref="html"/>
- <element ref="include"/>
- </choice>
- <attribute name="style" type="string">
- <annotation>
- <documentation>
- A relative path to a CSS file which is applied to the page only when using the Web based presentation.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="alt-style" type="string">
- <annotation>
- <documentation>
- A relative path to a SWT presentation properies file which is applied to the page only when using the SWT based presentation.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="path" type="string" use="required">
- <annotation>
- <documentation>
- the path that uniquely represents the path to an anchor. (e.g. page/group1/group2/anchorId) within the target configuration to be extended. It can only be an anchor which can be in any page or group, including shared groups at configuration level
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="anchor">
- <annotation>
- <documentation>
- an anchor is the element used to declare extensibility. It is a location in the configurtaion that allows for external contributions. Only anchors are valid target values for the path attribute in an extensionContent
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string">
- <annotation>
- <documentation>
- unique id to identify this anchor.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <annotation>
- <appInfo>
- <meta.section type="since"/>
- </appInfo>
- <documentation>
-
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="examples"/>
- </appInfo>
- <documentation>
-
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="apiInfo"/>
- </appInfo>
- <documentation>
-
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="implementation"/>
- </appInfo>
- <documentation>
-
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="copyright"/>
- </appInfo>
- <documentation>
-
- </documentation>
- </annotation>
-
-</schema>
+<?xml version='1.0' encoding='UTF-8'?> +<!-- Schema file written by PDE --> +<schema targetNamespace="org.eclipse.ui.intro"> +<annotation> + <appInfo> + <meta.schema plugin="org.eclipse.ui.intro" id="null" name=""/> + </appInfo> + <documentation> + + </documentation> + </annotation> + + <element name="introContent"> + <annotation> + <documentation> + The introContent element defines the body of the intro content file. The content file is made up of pages, shared groups that can be included in multiple pages, and extensions to anchor points defined in other configurations. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="page" minOccurs="1" maxOccurs="unbounded"/> + <element ref="group" minOccurs="0" maxOccurs="unbounded"/> + <element ref="extensionContent" minOccurs="0" maxOccurs="unbounded"/> + </sequence> + </complexType> + </element> + + <element name="page"> + <annotation> + <documentation> + This element is used to describe a page to be displayed. The intro can display both dynamic and static pages.<br> +<br> +Content for dynamic pages is generated from the subelements of the page, described below. The style or alt-style will be applied depending on the presentation. The styles can be further enhanced by referencing the id or class-id.<br> +<br/> +Static pages allow for the reuse of existing HTML documents within one's introduction, and can be linked to from any static or dynamic page. Static pages are not defined in a page element, they are simply html files that can be linked to by other pages.<br> +<br/> +The home page, whose id is specified in the presentation element of the intro config extension point, can have a url indicating that it is a static page. If no url is specified then the home page is assumed to be dynamic. All other pages described using the page element are dynamic. +<br/> + Also note that 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/> + +The subelements used in a dynamic page are as follows: A <b>group</b> subelement is used to group related content and apply style across the grouped content. A <b>link</b> subelement defines a link which can be used to link to a static or dynamic page and run an intro action/command. A link is normally defined at the page level to navigate between main pages versus links within a page. A <b>text</b> subelement defines textual content at the page level. A <b>head</b> subelement is only applicable for the Web based presentation and allows for additional html to be added to the HTML <b>head</b> section. This is useful for adding java scripts or extra style sheets. An <b>img</b> subelement defines image content for the page level. An <b>include</b> subelement allows for reuse of any element other than a page. An <b>html</b> 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 <b>object</b> by referencing the html file. Inclusion allows for including an html snippet directly from an html file. A <b>title</b> subelement defines the title of the page. An <b>anchor</b> subelement defines a point where external contributions can be made by an <extensionContent> element. + </documentation> + </annotation> + <complexType> + <choice> + <element ref="group" minOccurs="0" maxOccurs="unbounded"/> + <element ref="link" minOccurs="0" maxOccurs="unbounded"/> + <element ref="text" minOccurs="0" maxOccurs="unbounded"/> + <element ref="head" minOccurs="0" maxOccurs="unbounded"/> + <element ref="img" minOccurs="0" maxOccurs="unbounded"/> + <element ref="include" minOccurs="0" maxOccurs="unbounded"/> + <element ref="html" minOccurs="0" maxOccurs="unbounded"/> + <element ref="title" minOccurs="0" maxOccurs="1"/> + <element ref="anchor" minOccurs="0" maxOccurs="unbounded"/> + </choice> + <attribute name="url" type="string"> + <annotation> + <documentation> + The optional relative path to an HTML file. When using the Web based presentation, this HTML file will be displayed instead of any content defined for this page. This attribute is only applicable to the home page, which is identified in the presentation element of the intro config extension point. It is ignored for all other pages. + </documentation> + </annotation> + </attribute> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + A unique name that can be used to identify this page. + </documentation> + </annotation> + </attribute> + <attribute name="style" type="string"> + <annotation> + <documentation> + A relative path to a CSS file which is applied to the page only when using the Web based presentation. + </documentation> + </annotation> + </attribute> + <attribute name="alt-style" type="string"> + <annotation> + <documentation> + A relative path to a SWT presentation properies file which is applied to the page only when using the SWT based presentation. + </documentation> + </annotation> + </attribute> + <attribute name="filteredFrom"> + <annotation> + <documentation> + an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </attribute> + <attribute name="content" type="string"> + <annotation> + <documentation> + an optional attribute which can define the location of an introContent.xml file that represents the content of this page. When this attribute is defined, all children and attributes in this page element, except id, are ignored. This is because the content of this page is now assumed to reside in the xml file pointed to by the content file attribute. When resolving to the content of this file, the page with an id that matches the id defined in this page element is chosen. +This seperation of pages can be used when performance is an issue, as the content of a page is now loaded more lazily. + </documentation> + </annotation> + </attribute> + <attribute name="style-id" type="string"> + <annotation> + <documentation> + A means to classifiy the page into a given category so that a common style may be applied. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="group"> + <annotation> + <documentation> + Used to group related content, content that should have similar style applied, or content that will be included together in other pages. + </documentation> + </annotation> + <complexType> + <choice> + <element ref="group" minOccurs="0" maxOccurs="unbounded"/> + <element ref="link" minOccurs="0" maxOccurs="unbounded"/> + <element ref="text" minOccurs="0" maxOccurs="unbounded"/> + <element ref="img" minOccurs="0" maxOccurs="unbounded"/> + <element ref="include" minOccurs="0" maxOccurs="unbounded"/> + <element ref="html" minOccurs="0" maxOccurs="unbounded"/> + <element ref="anchor" minOccurs="0" maxOccurs="unbounded"/> + </choice> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + unique identifier of the group + </documentation> + </annotation> + </attribute> + <attribute name="label" type="string"> + <annotation> + <documentation> + a label or heading for this group + </documentation> + </annotation> + </attribute> + <attribute name="style-id" type="string"> + <annotation> + <documentation> + A means to classifiy this group into a given category so that a common style may be applied. + </documentation> + </annotation> + </attribute> + <attribute name="filteredFrom"> + <annotation> + <documentation> + an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </attribute> + </complexType> + </element> + + <element name="link"> + <annotation> + <documentation> + Can link to a static HTML file, an external web site, or can run an Intro URL action. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="text" minOccurs="0" maxOccurs="1"/> + <element ref="img" minOccurs="0" maxOccurs="1"/> + </sequence> + <attribute name="id" type="string"> + <annotation> + <documentation> + A unique id that can be used to identify this link + </documentation> + </annotation> + </attribute> + <attribute name="label" type="string"> + <annotation> + <documentation> + The text name of this link + </documentation> + </annotation> + </attribute> + <attribute name="url" type="string" use="required"> + <annotation> + <documentation> + A valid URL to an external web site, a static html file, or an Intro URL that represents an Intro action. All intro URLs have the following form: http://org.eclipse.ui.intro/<action name>?param1=value1&param2=value2 and will be processed by the intro framework. + +<br><br> +The predefined actions will be described using this format: +<br> +<p style="margin-left:15px;"> +<b>action name</b> - descripton of action<br> +<i>action parameter1</i> - description of parameter<br> +<i>action parameter2 (optional)</i> - description of parameter<br> +<i>action parameter3 (optional) = ("true" | "false") "false"</i> - description of parameter, choice of either true or false and "false" is the default<br> +</p> + +<br> +The following predefined actions are included in the intro framework: +<p style="margin-left:15px;"> +<b>close</b> - closes the intro part<br> +no parameters required<br> +<br> + +<b>navigate</b> - navigate through the intro pages in a given direction or return to the home page<br> +<i>direction = ("backward" | "forward" | "home")</i> - specifies the direction to navigate<br> +<br> + +<b>openBrowser</b> - open the url in an external browser<br> +<i>url</i> - a valid URL to an external web site or a static HTML file<br> +<i>pluginId (optional)</i> - only required if a static HTML file is specified. This is the id of the plug-in containing the file.<br> +<br> + +<b>runAction</b> - runs the specified action<br> +<i>class</i> - the fully qualified class name of the class that implements one of <code>org.eclipse.ui.intro.config.IIntroAction</code>, + <code>org.eclipse.jface.actino.IAction</code>, or <code>org.eclipse.ui.IActionDelegate</code><br> +<i>pluginId</i> - The id of the plug-in which contains the class.<br> +<i>standby (optional) = ("true" | "false") "false"</i> - indicate whether to set the intro into standby mode after executing the action<br> +additional parameters - any additional parameters are passed to actions that implement <code>org.eclipse.ui.intro.config.IIntroAction</code><br> +<br> + +<b>setStandbyMode</b> - sets the state of the intro part<br> +<i>standby = ("true" | "false")</i> - true to put the intro part in its partially visible standy mode, and false to make it fully visible<br> +<br> + +<b>showHelp</b> - Open the help system.<br> +no parameters required<br> +<br> + +<b>showHelpTopic</b> - Open a help topic.<br> +<i>id</i> - the URL of the help resource. (See Javadoc for <code>org.eclipse.ui.help.WorkbenchHelp.displayHelpResource</code><br> +<br> + +<b>showMessage</b> - Displays a message to the user using a standard information dialog.<br> +<i>message</i> - the message to show the user<br> +<br> + +<b>showStandby</b> - Sets the intro part to standby mode and shows the standbyContentPart with the given input<br> +<i>partId</i> - the id of the standbyContentPart to show<br> +<i>input</i> - the input to set on the standbyContentPart<br> +<br> + +<b>showPage</b> - show the intro page with the given id<br> +<i>id</i> - the id of the intro page to show<br> +<i>standby (optional) = ("true" | "false") "false"</i> - indicate whether to set the intro into standby mode after showing the page<br> +</p> +<br> + </documentation> + </annotation> + </attribute> + <attribute name="style-id" type="string"> + <annotation> + <documentation> + A means to classifiy this link into a given category so that a common style may be applied. + </documentation> + </annotation> + </attribute> + <attribute name="filteredFrom"> + <annotation> + <documentation> + an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </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 swt presentation rendering. +<br> +Embedding allows for a fully defined html file to be embedded within the dynamic page's content. An HTML <b>object</b> element is created that references the html file. +<br> +Inclusion allows for including an html snippet directly from a file into the dynamic html page. + </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 'embed', a valid (full) HTML document will be embedded using HTML 'OBJECT' tag. If 'inline', value of 'src' will be treated as a snippet of HTML to emit 'in-place'. (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="style-id" type="string"> + <annotation> + <documentation> + A means to classifiy this HTML element into a given category so that a common style may be applied. + </documentation> + </annotation> + </attribute> + <attribute name="filteredFrom"> + <annotation> + <documentation> + an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </attribute> + </complexType> + </element> + + <element name="title"> + <annotation> + <documentation> + a snippet of text that can optionally contain escaped HTML tags. It is only used as a Page Title, and so a given page can have a maximum of one title element. + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string"> + <annotation> + <documentation> + unique identifier of this title. + </documentation> + </annotation> + </attribute> + <attribute name="style-id" type="string"> + <annotation> + <documentation> + A means to classifiy this element into a given category so that a common style may be applied + </documentation> + </annotation> + </attribute> + <attribute name="filteredFrom"> + <annotation> + <documentation> + an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </attribute> + </complexType> + </element> + + <element name="text"> + <annotation> + <documentation> + a snippet of text that can optionally contain escaped HTML tags. It can include b and li tags. It can also contain anchors for urls. +If multiple paragraphs are needed, then the text can be divided into multiple sections each begining and ending with the p tag. + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string"> + <annotation> + <documentation> + unique identifier of this text. + </documentation> + </annotation> + </attribute> + <attribute name="style-id" type="string"> + <annotation> + <documentation> + A means to classifiy this element into a given category so that a common style may be applied + </documentation> + </annotation> + </attribute> + <attribute name="filteredFrom"> + <annotation> + <documentation> + an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </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 shared group 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/group1/group2). It may be a group element, or any element that may be contained in a group. You can not include a page. + </documentation> + </annotation> + </attribute> + <attribute name="merge-style" type="boolean"> + <annotation> + <documentation> + if <code>true</code>, style belonging to the page that owns the included element will be added to list of styles of the including page. If <code>false</code> (the default), the including page is responsible for controlling properties of the included element. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="head"> + <annotation> + <documentation> + Direct HTML to include in a page's HEAD content area. It allows for additional html to be added to the HTML HEAD section. This is useful for adding java srcipts or extra styles sheets. +This markup is only to be used with an HTML 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 across all pages). + </documentation> + </annotation> + <complexType> + <attribute name="src" type="string" use="required"> + <annotation> + <documentation> + relative or absolute URL to a file containing HTML to include directly into the HTML head section. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="img"> + <annotation> + <documentation> + An image that represents intro content and not presentation (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> + the alternative text to use when the image can not be loaded and as tooltip text for the image. + </documentation> + </annotation> + </attribute> + <attribute name="style-id" type="string"> + <annotation> + <documentation> + A means to classifiy this image into a given category so that a common style may be applied. + </documentation> + </annotation> + </attribute> + <attribute name="filteredFrom"> + <annotation> + <documentation> + an optional attribute that allows for filtering a given element out of a specific implementation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt implementation. + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </attribute> + </complexType> + </element> + + <element name="extensionContent"> + <annotation> + <documentation> + The content to be added to the target anchor. 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 anchor element could not be found) then the pages and/or groups in the extension need to be ingnored. + </documentation> + </annotation> + <complexType> + <choice> + <element ref="text"/> + <element ref="group"/> + <element ref="link"/> + <element ref="html"/> + <element ref="include"/> + </choice> + <attribute name="style" type="string"> + <annotation> + <documentation> + A relative path to a CSS file which is applied to the page only when using the Web based presentation. + </documentation> + </annotation> + </attribute> + <attribute name="alt-style" type="string"> + <annotation> + <documentation> + A relative path to a SWT presentation properies file which is applied to the page only when using the SWT based presentation. + </documentation> + </annotation> + </attribute> + <attribute name="path" type="string" use="required"> + <annotation> + <documentation> + the path that uniquely represents the path to an anchor. (e.g. page/group1/group2/anchorId) within the target configuration to be extended. It can only be an anchor which can be in any page or group, including shared groups at configuration level + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="anchor"> + <annotation> + <documentation> + an anchor is the element used to declare extensibility. It is a location in the configurtaion that allows for external contributions. Only anchors are valid target values for the path attribute in an extensionContent + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string"> + <annotation> + <documentation> + unique id to identify this anchor. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <annotation> + <appInfo> + <meta.section type="since"/> + </appInfo> + <documentation> + + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="examples"/> + </appInfo> + <documentation> + + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="apiInfo"/> + </appInfo> + <documentation> + + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="implementation"/> + </appInfo> + <documentation> + + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="copyright"/> + </appInfo> + <documentation> + + </documentation> + </annotation> + +</schema> diff --git a/org.eclipse.ui.intro/schema/config.exsd b/org.eclipse.ui.intro/schema/config.exsd index 22e6e074c..b87073c67 100644 --- a/org.eclipse.ui.intro/schema/config.exsd +++ b/org.eclipse.ui.intro/schema/config.exsd @@ -1,236 +1,236 @@ -<?xml version='1.0' encoding='UTF-8'?>
-<!-- Schema file written by PDE -->
-<schema targetNamespace="org.eclipse.ui.intro">
-<annotation>
- <appInfo>
- <meta.schema plugin="org.eclipse.ui.intro" id="config" name="Intro Part Configuration"/>
- </appInfo>
- <documentation>
- This extension point is used to register an intro configuration. This configuration provides presentation implementations and content for a given intro contribution. An intro appears when the workbench is first launched and as a choice from the "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>
- </documentation>
- </annotation>
-
- <element name="extension">
- <complexType>
- <sequence>
- <element ref="config" minOccurs="1" 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>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="config">
- <annotation>
- <documentation>
- A config element can be used to configure a customizable Intro Part. A config element must specify an id, an introId, and a content file.
-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"/>
- </sequence>
- <attribute name="introId" type="string" use="required">
- <annotation>
- <documentation>
- 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>
- 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 (<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.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="presentation">
- <annotation>
- <documentation>
- 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.
- </documentation>
- </annotation>
- <complexType>
- <sequence>
- <element ref="implementation" minOccurs="1" maxOccurs="unbounded"/>
- </sequence>
- <attribute name="home-page-id" type="string" use="required">
- <annotation>
- <documentation>
- the id of the home (root) page, which is the first page of the introduction. This page can be used as an entry point to the other main pages that make up the intro.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="standby-page-id" type="string">
- <annotation>
- <documentation>
- 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.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="implementation">
- <annotation>
- <documentation>
- 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 presentations based on the current OS and WS. The type of the implementation can be swt or html.
- </documentation>
- </annotation>
- <complexType>
- <sequence>
- <element ref="head" minOccurs="0" maxOccurs="1"/>
- </sequence>
- <attribute name="kind" use="required">
- <annotation>
- <documentation>
- Specifies the type of this implementation. The swt kind indicates a UI Forms based implementation, and the html kind indicates an SWT Browser based implementation
- </documentation>
- </annotation>
- <simpleType>
- <restriction base="string">
- <enumeration value="swt">
- </enumeration>
- <enumeration value="html">
- </enumeration>
- </restriction>
- </simpleType>
- </attribute>
- <attribute name="style" type="string">
- <annotation>
- <documentation>
- 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>
- The optional operating system specification used when choosing the presentation's implementation. It can be any of the os designators defined by Eclipse, e.g., win32, linux, etc (see Javadoc for <code>org.eclipse.core.runtime.Platform</code>).
- </documentation>
- </annotation>
- </attribute>
- <attribute name="ws" type="string">
- <annotation>
- <documentation>
- The optional windowing system specification used when choosing the presentation's implementation. It can be any of the ws designators defined by Eclipse (see Javadoc for <code>org.eclipse.core.runtime.Platform</code>).
- </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>
- Here is a sample usage of the config extension point.
-<p>
-<pre>
-<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"
- kind="html"
- os="win32">
- </implementation>
- <implementation
- style="css/shared_swt.properties"
- kind="swt">
- </implementation>
- </presentation>
- </config>
-</extension>
-</pre>
-</p>
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="apiInfo"/>
- </appInfo>
- <documentation>
- For further details see the spec for the org.eclipse.ui.intro.config API package.
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="implementation"/>
- </appInfo>
- <documentation>
- The intro contributed by the org.eclipse.platform plugin is the only implementation within Eclipse.
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="copyright"/>
- </appInfo>
- <documentation>
- /************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Common Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/cpl-v10.html
- *
- * Contributors:
- * IBM Corporation - Initial API and implementation
- *************************************************************************/
- </documentation>
- </annotation>
-
-</schema>
+<?xml version='1.0' encoding='UTF-8'?> +<!-- Schema file written by PDE --> +<schema targetNamespace="org.eclipse.ui.intro"> +<annotation> + <appInfo> + <meta.schema plugin="org.eclipse.ui.intro" id="config" name="Intro Part Configuration"/> + </appInfo> + <documentation> + This extension point is used to register an intro configuration. This configuration provides presentation implementations and content for a given intro contribution. An intro appears when the workbench is first launched and as a choice from the "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> + </documentation> + </annotation> + + <element name="extension"> + <complexType> + <sequence> + <element ref="config" minOccurs="1" 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> + </annotation> + </attribute> + </complexType> + </element> + + <element name="config"> + <annotation> + <documentation> + A config element can be used to configure a customizable Intro Part. A config element must specify an id, an introId, and a content file. +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"/> + </sequence> + <attribute name="introId" type="string" use="required"> + <annotation> + <documentation> + 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> + 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 (<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. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="presentation"> + <annotation> + <documentation> + 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. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="implementation" minOccurs="1" maxOccurs="unbounded"/> + </sequence> + <attribute name="home-page-id" type="string" use="required"> + <annotation> + <documentation> + the id of the home (root) page, which is the first page of the introduction. This page can be used as an entry point to the other main pages that make up the intro. + </documentation> + </annotation> + </attribute> + <attribute name="standby-page-id" type="string"> + <annotation> + <documentation> + 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. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="implementation"> + <annotation> + <documentation> + 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 presentations based on the current OS and WS. The type of the implementation can be swt or html. + </documentation> + </annotation> + <complexType> + <sequence> + <element ref="head" minOccurs="0" maxOccurs="1"/> + </sequence> + <attribute name="kind" use="required"> + <annotation> + <documentation> + Specifies the type of this implementation. The swt kind indicates a UI Forms based implementation, and the html kind indicates an SWT Browser based implementation + </documentation> + </annotation> + <simpleType> + <restriction base="string"> + <enumeration value="swt"> + </enumeration> + <enumeration value="html"> + </enumeration> + </restriction> + </simpleType> + </attribute> + <attribute name="style" type="string"> + <annotation> + <documentation> + 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> + The optional operating system specification used when choosing the presentation's implementation. It can be any of the os designators defined by Eclipse, e.g., win32, linux, etc (see Javadoc for <code>org.eclipse.core.runtime.Platform</code>). + </documentation> + </annotation> + </attribute> + <attribute name="ws" type="string"> + <annotation> + <documentation> + The optional windowing system specification used when choosing the presentation's implementation. It can be any of the ws designators defined by Eclipse (see Javadoc for <code>org.eclipse.core.runtime.Platform</code>). + </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> + Here is a sample usage of the config extension point. +<p> +<pre> +<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" + kind="html" + os="win32"> + </implementation> + <implementation + style="css/shared_swt.properties" + kind="swt"> + </implementation> + </presentation> + </config> +</extension> +</pre> +</p> + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="apiInfo"/> + </appInfo> + <documentation> + For further details see the spec for the org.eclipse.ui.intro.config API package. + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="implementation"/> + </appInfo> + <documentation> + The intro contributed by the org.eclipse.platform plugin is the only implementation within Eclipse. + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="copyright"/> + </appInfo> + <documentation> + /************************************************************************ + * Copyright (c) 2004 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Common Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/cpl-v10.html + * + * Contributors: + * IBM Corporation - Initial API and implementation + *************************************************************************/ + </documentation> + </annotation> + +</schema> diff --git a/org.eclipse.ui.intro/schema/configExtension.exsd b/org.eclipse.ui.intro/schema/configExtension.exsd index 745127348..04c69fff8 100644 --- a/org.eclipse.ui.intro/schema/configExtension.exsd +++ b/org.eclipse.ui.intro/schema/configExtension.exsd @@ -1,208 +1,208 @@ -<?xml version='1.0' encoding='UTF-8'?>
-<!-- Schema file written by PDE -->
-<schema targetNamespace="org.eclipse.ui.intro">
-<annotation>
- <appInfo>
- <meta.schema plugin="org.eclipse.ui.intro" id="configExtension" name="Intro Part Configuration Extension"/>
- </appInfo>
- <documentation>
- This extension point is used to extend an existing intro configuration by providing more content, additional StandbyContentParts or additional IntroUrl actions.
- </documentation>
- </annotation>
-
- <element name="extension">
- <complexType>
- <sequence>
- <element ref="configExtension" minOccurs="1" maxOccurs="unbounded"/>
- <element ref="standbyContentPart" minOccurs="0" maxOccurs="unbounded"/>
- <element ref="action" 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>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="configExtension">
- <annotation>
- <documentation>
- Defines an extension to an intro configuration. Any page or group in an intro part configuration can be extended, if it has declared extensability by defining anchors.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="configId" type="string" use="required">
- <annotation>
- <documentation>
- the id of an intro contribution that will be extended
- </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 (<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.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="standbyContentPart">
- <annotation>
- <documentation>
- standbyContentPart registration. Once registered, standby parts can be launched through an introURL action of the following format:
-<pre>
-http://org.eclipse.ui.intro/showStandby?partId=<id of standbyContentPart>
-</pre>
- </documentation>
- </annotation>
- <complexType>
- <attribute name="id" type="string" use="required">
- <annotation>
- <documentation>
- a unique id that identifies this standbyContentPart.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="pluginId" type="string" use="required">
- <annotation>
- <documentation>
- the name of the plugin that holds the class defined in the "class" attribute.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="class" type="string" use="required">
- <annotation>
- <documentation>
- 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.
- </documentation>
- </annotation>
- </attribute>
- </complexType>
- </element>
-
- <element name="action">
- <annotation>
- <documentation>
- custom Intro URL action registration. This can be used to create new Intro URL actions or a shortCut to predefined actions.
- </documentation>
- </annotation>
- <complexType>
- <attribute name="name" type="string" use="required">
- <annotation>
- <documentation>
- a unique name that identifies this action.
- </documentation>
- </annotation>
- </attribute>
- <attribute name="replaces" type="string" use="required">
- <annotation>
- <documentation>
- the macro which replaces the action name in the Intro URL.
- </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>
- Here is an example implementation of this extension point:
-<p>
-<pre>
-<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="com.org.xyz"/>
-
- <action
- name="shortcutAction"
- replaces="http://org.eclipse.ui.intro/showStandby?partId=com.org.xyz.myStandbyPart"/>
-
- <action
- name="customAction"
- replaces="runAction?pluginId=com.org.xyz&amp;class=com.org.xyz.CustomAction&amp;param1=value1"/>
-</extension>
-</pre>
-</p>
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="apiInfo"/>
- </appInfo>
- <documentation>
- For further details see the spec for the org.eclipse.ui.intro.config API package.
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="implementation"/>
- </appInfo>
- <documentation>
- 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>
- </documentation>
- </annotation>
-
- <annotation>
- <appInfo>
- <meta.section type="copyright"/>
- </appInfo>
- <documentation>
- /************************************************************************
- * Copyright (c) 2004 IBM Corporation and others.
- * All rights reserved. This program and the accompanying materials
- * are made available under the terms of the Common Public License v1.0
- * which accompanies this distribution, and is available at
- * http://www.eclipse.org/legal/cpl-v10.html
- *
- * Contributors:
- * IBM Corporation - Initial API and implementation
- *************************************************************************/
- </documentation>
- </annotation>
-
-</schema>
+<?xml version='1.0' encoding='UTF-8'?> +<!-- Schema file written by PDE --> +<schema targetNamespace="org.eclipse.ui.intro"> +<annotation> + <appInfo> + <meta.schema plugin="org.eclipse.ui.intro" id="configExtension" name="Intro Part Configuration Extension"/> + </appInfo> + <documentation> + This extension point is used to extend an existing intro configuration by providing more content, additional StandbyContentParts or additional IntroUrl actions. + </documentation> + </annotation> + + <element name="extension"> + <complexType> + <sequence> + <element ref="configExtension" minOccurs="1" maxOccurs="unbounded"/> + <element ref="standbyContentPart" minOccurs="0" maxOccurs="unbounded"/> + <element ref="action" 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> + </annotation> + </attribute> + </complexType> + </element> + + <element name="configExtension"> + <annotation> + <documentation> + Defines an extension to an intro configuration. Any page or group in an intro part configuration can be extended, if it has declared extensability by defining anchors. + </documentation> + </annotation> + <complexType> + <attribute name="configId" type="string" use="required"> + <annotation> + <documentation> + the id of an intro contribution that will be extended + </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 (<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. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="standbyContentPart"> + <annotation> + <documentation> + standbyContentPart registration. Once registered, standby parts can be launched through an introURL action of the following format: +<pre> +http://org.eclipse.ui.intro/showStandby?partId=<id of standbyContentPart> +</pre> + </documentation> + </annotation> + <complexType> + <attribute name="id" type="string" use="required"> + <annotation> + <documentation> + a unique id that identifies this standbyContentPart. + </documentation> + </annotation> + </attribute> + <attribute name="pluginId" type="string" use="required"> + <annotation> + <documentation> + the name of the plugin that holds the class defined in the "class" attribute. + </documentation> + </annotation> + </attribute> + <attribute name="class" type="string" use="required"> + <annotation> + <documentation> + 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. + </documentation> + </annotation> + </attribute> + </complexType> + </element> + + <element name="action"> + <annotation> + <documentation> + custom Intro URL action registration. This can be used to create new Intro URL actions or a shortCut to predefined actions. + </documentation> + </annotation> + <complexType> + <attribute name="name" type="string" use="required"> + <annotation> + <documentation> + a unique name that identifies this action. + </documentation> + </annotation> + </attribute> + <attribute name="replaces" type="string" use="required"> + <annotation> + <documentation> + the macro which replaces the action name in the Intro URL. + </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> + Here is an example implementation of this extension point: +<p> +<pre> +<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="com.org.xyz"/> + + <action + name="shortcutAction" + replaces="http://org.eclipse.ui.intro/showStandby?partId=com.org.xyz.myStandbyPart"/> + + <action + name="customAction" + replaces="runAction?pluginId=com.org.xyz&amp;class=com.org.xyz.CustomAction&amp;param1=value1"/> +</extension> +</pre> +</p> + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="apiInfo"/> + </appInfo> + <documentation> + For further details see the spec for the org.eclipse.ui.intro.config API package. + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="implementation"/> + </appInfo> + <documentation> + 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> + </documentation> + </annotation> + + <annotation> + <appInfo> + <meta.section type="copyright"/> + </appInfo> + <documentation> + /************************************************************************ + * Copyright (c) 2004 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Common Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/cpl-v10.html + * + * Contributors: + * IBM Corporation - Initial API and implementation + *************************************************************************/ + </documentation> + </annotation> + +</schema> |