diff options
| author | lparsons | 2004-06-18 21:48:12 +0000 |
|---|---|---|
| committer | lparsons | 2004-06-18 21:48:12 +0000 |
| commit | 5f44ae9f3c6fdd92783d560d3c598b94097bf0bb (patch) | |
| tree | 631d5753331b0840989e85d3f4bc72a1b285444a /org.eclipse.ui.intro | |
| parent | 33696e777729e32a850f544214d5447ff4edbbb5 (diff) | |
| download | eclipse.platform.ua-5f44ae9f3c6fdd92783d560d3c598b94097bf0bb.tar.gz eclipse.platform.ua-5f44ae9f3c6fdd92783d560d3c598b94097bf0bb.tar.xz eclipse.platform.ua-5f44ae9f3c6fdd92783d560d3c598b94097bf0bb.zip | |
Fix for Bug 67739v20040618a
Diffstat (limited to 'org.eclipse.ui.intro')
| -rw-r--r-- | org.eclipse.ui.intro/schema/IntroContent.exsd | 146 | ||||
| -rw-r--r-- | org.eclipse.ui.intro/schema/introContentFileSpec.html | 433 |
2 files changed, 548 insertions, 31 deletions
diff --git a/org.eclipse.ui.intro/schema/IntroContent.exsd b/org.eclipse.ui.intro/schema/IntroContent.exsd index 3350ae0c3..798621ee2 100644 --- a/org.eclipse.ui.intro/schema/IntroContent.exsd +++ b/org.eclipse.ui.intro/schema/IntroContent.exsd @@ -6,11 +6,16 @@ <meta.schema plugin="org.eclipse.ui.intro" id="null" name=""/>
</appInfo>
<documentation>
- [Enter description of this extension point.]
+
</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"/>
@@ -23,13 +28,18 @@ <element name="page">
<annotation>
<documentation>
- This element is used to describe a page to be displayed. A page can be either either dynamic or static.<br/> + 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/> -Static pages allow for reuse of existing HTML documents within ones introduction. When a static page is used, none of the subelements are utilized. Also note when the SWT presentation is used and a static page is to be displayed an external brower is launched and the current page remains visible.<br/> +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/> -Dynamic pages do not have a url defined and their contents are generated from the subelements of the page. 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/> -A <b>group</b> subelement is used to group of content and apply style across the grouped content. A <b>link</b> subelement defines a link which can be used to link to a page and run an intro action/command. A link is normally defined at the page level to navigate between main pages verses links within a page. A <b>text</b> subelement defines textual content for 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 srcipts or extra styles sheets. An <b>img</b> subelement defines image content for the page level. An <b>include</b> subelement allows for reuse 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 embedding an html snippets directly from html file. A <b>title</b> subelement defines the title of the page.
+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>
@@ -47,7 +57,7 @@ A <b>group</b> subelement is used to group of content and apply styl <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 displayed instead of any content defined for this page.
+ 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>
@@ -75,7 +85,7 @@ A <b>group</b> subelement is used to group of content and apply styl <attribute name="filteredFrom">
<annotation>
<documentation>
- an optional attribute that allows for filtering a given element out of a specific presentation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt presentation.
+ 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>
@@ -90,8 +100,8 @@ A <b>group</b> subelement is used to group of content and apply styl <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 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 files pointed to by the content file. When resolving to the content of this file, the page with a matching is to the id defined in this page is chosen. -This seperation out of pages can be used when performance is an issue, as the content of a page is now loaded more lazily.
+ 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>
@@ -106,6 +116,11 @@ This seperation out of pages can be used when performance is an issue, as the co </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"/>
@@ -119,14 +134,14 @@ This seperation out of pages can be used when performance is an issue, as the co <attribute name="id" type="string" use="required">
<annotation>
<documentation>
- unique identifier of the division
+ 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>
@@ -140,7 +155,7 @@ This seperation out of pages can be used when performance is an issue, as the co <attribute name="filteredFrom">
<annotation>
<documentation>
- an optional attribute that allows for filtering a given element out of a specific presentation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt presentation.
+ 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>
@@ -156,6 +171,11 @@ This seperation out of pages can be used when performance is an issue, as the co </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"/>
@@ -171,14 +191,75 @@ This seperation out of pages can be used when performance is an issue, as the co <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 external web site or an Intro URL that represents an Intro actions. All intro URLs have the following form: http://org.eclipse.ui.intro/&lt;command&gt>&amp;p1=v1&amp;p2=v2... and will be processed as Eclipse requests.
+ 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>
@@ -192,7 +273,7 @@ This seperation out of pages can be used when performance is an issue, as the co <attribute name="filteredFrom">
<annotation>
<documentation>
- an optional attribute that allows for filtering a given element out of a specific presentation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt presentation.
+ 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>
@@ -211,7 +292,10 @@ This seperation out of pages can be used when performance is an issue, as the co <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. -Embedding allows for a fully defined html file to be embeded within an HTML object by referencing the html file. Inclusion allows for embedding an html snippets directly from html file.
+<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>
@@ -258,7 +342,7 @@ Embedding allows for a fully defined html file to be embeded within an HTML obje <attribute name="filteredFrom">
<annotation>
<documentation>
- an optional attribute that allows for filtering a given element out of a specific presentation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt presentation.
+ 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>
@@ -276,7 +360,7 @@ Embedding allows for a fully defined html file to be embeded within an HTML obje <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 maximun of one Title element.
+ 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>
@@ -290,14 +374,14 @@ Embedding allows for a fully defined html file to be embeded within an HTML obje <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 presentation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt presentation.
+ 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>
@@ -330,14 +414,14 @@ If multiple paragraphs are needed, then the text can be divided into multiple se <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 presentation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt presentation.
+ 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>
@@ -355,7 +439,7 @@ If multiple paragraphs are needed, then the text can be divided into multiple se <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.
+ 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>
@@ -376,7 +460,7 @@ If multiple paragraphs are needed, then the text can be divided into multiple se <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 controling properties of the included element.
+ 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>
@@ -387,7 +471,7 @@ If multiple paragraphs are needed, then the text can be divided into multiple se <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 SWT Based intro part implementation. It is simply ignored in the case of a UI Forms implementation. A page can have more than one head element. An implementation can have one and only one head element (since it is a shared head content, it makes sense to just define it in one file).
+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>
@@ -404,7 +488,7 @@ This markup is only to be used with an SWT Based intro part implementation. It i <element name="img">
<annotation>
<documentation>
- An image that represents intro content and not presentation. (as opposed to decoration images defined in styles).
+ An image that represents intro content and not presentation (as opposed to decoration images defined in styles).
</documentation>
</annotation>
<complexType>
@@ -439,7 +523,7 @@ This markup is only to be used with an SWT Based intro part implementation. It i <attribute name="filteredFrom">
<annotation>
<documentation>
- an optional attribute that allows for filtering a given element out of a specific presentation. For example, if a group has filteredFrom = swt, it means that this group will not appear as content in the swt presentation.
+ 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>
@@ -514,7 +598,7 @@ This markup is only to be used with an SWT Based intro part implementation. It i <meta.section type="since"/>
</appInfo>
<documentation>
- [Enter the first release in which this extension point appears.]
+
</documentation>
</annotation>
@@ -523,7 +607,7 @@ This markup is only to be used with an SWT Based intro part implementation. It i <meta.section type="examples"/>
</appInfo>
<documentation>
- [Enter extension point usage example here.]
+
</documentation>
</annotation>
@@ -532,7 +616,7 @@ This markup is only to be used with an SWT Based intro part implementation. It i <meta.section type="apiInfo"/>
</appInfo>
<documentation>
- [Enter API information here.]
+
</documentation>
</annotation>
@@ -541,7 +625,7 @@ This markup is only to be used with an SWT Based intro part implementation. It i <meta.section type="implementation"/>
</appInfo>
<documentation>
- [Enter information about supplied implementation of this extension point.]
+
</documentation>
</annotation>
diff --git a/org.eclipse.ui.intro/schema/introContentFileSpec.html b/org.eclipse.ui.intro/schema/introContentFileSpec.html new file mode 100644 index 000000000..953336d44 --- /dev/null +++ b/org.eclipse.ui.intro/schema/introContentFileSpec.html @@ -0,0 +1,433 @@ +<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> + +<head> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +<meta name="GENERATOR" content="Microsoft FrontPage 4.0"> +<meta name="ProgId" content="FrontPage.Editor.Document"> +<title>Intro Content File XML Format</title> +<style> +P.Code { + display: block; + text-align: left; + text-indent: 0.00pt; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 15pt; + font-size: 10.000000pt; + font-weight: medium; + font-style: Regular; + color: #4444CC; + text-decoration: none; + vertical-align: baseline; + text-transform: none; + font-family: "Courier New"; +} +H6.CaptionFigColumn { + display: block; + text-align: left; + text-indent: 0.000000pt; + margin-top: 3.000000pt; + margin-bottom: 11.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; + font-size: 9.000000pt; + font-weight: medium; + font-style: Italic; + color: #000000; + text-decoration: none; + vertical-align: baseline; + text-transform: none; + font-family: "Arial"; +} +P.Note { + display: block; + text-align: left; + text-indent: 0pt; + margin-top: 19.500000pt; + margin-bottom: 19.500000pt; + margin-right: 0.000000pt; + margin-left: 30pt; + font-size: 11.000000pt; + font-weight: medium; + font-style: Italic; + color: #000000; + text-decoration: none; + vertical-align: baseline; + text-transform: none; + font-family: "Arial"; +} +EM.UILabel { + font-weight: Bold; + font-style: Regular; + text-decoration: none; + vertical-align: baseline; + text-transform: none; +} +EM.CodeName { + font-weight: Bold; + font-style: Regular; + text-decoration: none; + vertical-align: baseline; + text-transform: none; + font-family:"Courier New"; +} + + + + +/* following font face declarations need to be removed for DBCS */ + +body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, Helvetica, sans-serif; color: #000000} +pre { font-family: Courier, monospace} + +/* end font face declarations */ + +/* following font size declarations should be OK for DBCS */ +body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 10pt; } +pre { font-size: 10pt} + +/* end font size declarations */ + +body { background: #FFFFFF} +h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 } +h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 } +h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 } +h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic } +p { margin-top: 10px; margin-bottom: 10px } +pre { margin-left: 6; font-size: 9pt } +a:link { color: #0000FF } +a:hover { color: #000080 } +a:visited { text-decoration: underline } +ul { margin-top: 0; margin-bottom: 10 } +li { margin-top: 0; margin-bottom: 0 } +li p { margin-top: 0; margin-bottom: 0 } +ol { margin-top: 0; margin-bottom: 10 } +dl { margin-top: 0; margin-bottom: 10 } +dt { margin-top: 0; margin-bottom: 0; font-weight: bold } +dd { margin-top: 0; margin-bottom: 0 } +strong { font-weight: bold} +em { font-style: italic} +var { font-style: italic} +div.revision { border-left-style: solid; border-left-width: thin; + border-left-color: #7B68EE; padding-left:5 } +th { font-weight: bold } + +H6.CaptionFigColumn#header { + font-size:16px; + display:inline +} + +P.Note#copyright { + font-size: smaller; + font-style: normal; + color: #336699; + display:inline; + margin-top: 3.000000pt; + margin-bottom: 11.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; +} + +P.Code#dtd { + color: #800000; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 10.000000pt; +} + +P.Code#dtdAttlist { + color: #800000; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 20.000000pt; +} + +P.Code#tag { + color: #000080; + display:inline; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; +} + +P.Code#cstring { + color: #008000; + display:inline; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 0.000000pt; +} + +.ConfigMarkup#elementDesc { + color: black; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 10.000000pt; +} + +.ConfigMarkup#attlistDesc { + color: black; + margin-top: 0.000000pt; + margin-bottom: 0.000000pt; + margin-right: 0.000000pt; + margin-left: 32.000000pt; +} + +</style> +</head> + +<body> + +<h1>Intro Content File XML Format</h1> +<p>Version 3.0</p> +<p>This document describes the intro content file structure as a series of +DTD fragments (machine readable <a href="IntroContent.exsd">XML schema</a>).</p> +<h2><code>introContent</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.introContent">introContent</a> (<a href="#e.page">page</a>+ , <a href="#e.group">group</a>* , <a href="#e.extensionContent">extensionContent</a>*)></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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.</p> +<br><br> +<h2><code>page</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.page">page</a> (<a href="#e.group">group</a>* | <a href="#e.link">link</a>* | <a href="#e.text">text</a>* | <a href="#e.head">head</a>* | <a href="#e.img">img</a>* | <a href="#e.include">include</a>* | <a href="#e.html">html</a>* | <a href="#e.title">title</a>? | <a href="#e.anchor">anchor</a>*)></p> +<p class=code id=dtd><!ATTLIST page</p> +<p class=code id=dtdAttlist>url CDATA #IMPLIED<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>style CDATA #IMPLIED<p class=code id=dtdAttlist>alt-style CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) <p class=code id=dtdAttlist>content CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>url</b> - 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.</li> +<li><b>id</b> - A unique name that can be used to identify this page.</li> +<li><b>style</b> - A relative path to a CSS file which is applied to the page only when using the Web based presentation.</li> +<li><b>alt-style</b> - A relative path to a SWT presentation properies file which is applied to the page only when using the SWT based presentation.</li> +<li><b>filteredFrom</b> - 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.</li> +<li><b>content</b> - 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.</li> +<li><b>style-id</b> - A means to classifiy the page into a given category so that a common style may be applied.</li> +</ul> +<h2><code>group</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.group">group</a> (<a href="#e.group">group</a>* | <a href="#e.link">link</a>* | <a href="#e.text">text</a>* | <a href="#e.img">img</a>* | <a href="#e.include">include</a>* | <a href="#e.html">html</a>* | <a href="#e.anchor">anchor</a>*)></p> +<p class=code id=dtd><!ATTLIST group</p> +<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>label CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) ></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +Used to group related content, content that should have similar style applied, or content that will be included together in other pages.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>id</b> - unique identifier of the group</li> +<li><b>label</b> - a label or heading for this group</li> +<li><b>style-id</b> - A means to classifiy this group into a given category so that a common style may be applied.</li> +<li><b>filteredFrom</b> - 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.</li> +</ul> +<h2><code>link</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.link">link</a> (<a href="#e.text">text</a>? , <a href="#e.img">img</a>?)></p> +<p class=code id=dtd><!ATTLIST link</p> +<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>label CDATA #IMPLIED<p class=code id=dtdAttlist>url CDATA #REQUIRED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) ></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +Can link to a static HTML file, an external web site, or can run an Intro URL action.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>id</b> - A unique id that can be used to identify this link</li> +<li><b>label</b> - The text name of this link</li> +<li><b>url</b> - 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¶m2=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></li> +<li><b>style-id</b> - A means to classifiy this link into a given category so that a common style may be applied.</li> +<li><b>filteredFrom</b> - 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.</li> +</ul> +<h2><code>html</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.html">html</a> (<a href="#e.img">img</a> | <a href="#e.text">text</a>)></p> +<p class=code id=dtd><!ATTLIST html</p> +<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>src CDATA #REQUIRED<p class=code id=dtdAttlist>type (inline|embed) <p class=code id=dtdAttlist>style-id CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) ></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>id</b> - unique identifier of this HTML element</li> +<li><b>src</b> - relative or absolute URL to a file containing HTML</li> +<li><b>type</b> - 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).</li> +<li><b>style-id</b> - A means to classifiy this HTML element into a given category so that a common style may be applied.</li> +<li><b>filteredFrom</b> - 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.</li> +</ul> +<h2><code>title</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.title">title</a> EMPTY></p> +<p class=code id=dtd><!ATTLIST title</p> +<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) ></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>id</b> - unique identifier of this title.</li> +<li><b>style-id</b> - A means to classifiy this element into a given category so that a common style may be applied</li> +<li><b>filteredFrom</b> - 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.</li> +</ul> +<h2><code>text</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.text">text</a> EMPTY></p> +<p class=code id=dtd><!ATTLIST text</p> +<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) ></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>id</b> - unique identifier of this text.</li> +<li><b>style-id</b> - A means to classifiy this element into a given category so that a common style may be applied</li> +<li><b>filteredFrom</b> - 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.</li> +</ul> +<h2><code>include</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.include">include</a> EMPTY></p> +<p class=code id=dtd><!ATTLIST include</p> +<p class=code id=dtdAttlist>configId CDATA #IMPLIED<p class=code id=dtdAttlist>path CDATA #REQUIRED<p class=code id=dtdAttlist>merge-style (true | false) ></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>configId</b> - 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.</li> +<li><b>path</b> - 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.</li> +<li><b>merge-style</b> - 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.</li> +</ul> +<h2><code>head</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.head">head</a> EMPTY></p> +<p class=code id=dtd><!ATTLIST head</p> +<p class=code id=dtdAttlist>src CDATA #REQUIRED></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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).</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>src</b> - relative or absolute URL to a file containing HTML to include directly into the HTML head section.</li> +</ul> +<h2><code>img</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.img">img</a> EMPTY></p> +<p class=code id=dtd><!ATTLIST img</p> +<p class=code id=dtdAttlist>id CDATA #REQUIRED<p class=code id=dtdAttlist>src CDATA #REQUIRED<p class=code id=dtdAttlist>alt CDATA #IMPLIED<p class=code id=dtdAttlist>style-id CDATA #IMPLIED<p class=code id=dtdAttlist>filteredFrom (swt|html) ></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +An image that represents intro content and not presentation (as opposed to decoration images defined in styles).</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>id</b> - unique identifier of this image</li> +<li><b>src</b> - the file to load the image from</li> +<li><b>alt</b> - the alternative text to use when the image can not be loaded and as tooltip text for the image.</li> +<li><b>style-id</b> - A means to classifiy this image into a given category so that a common style may be applied.</li> +<li><b>filteredFrom</b> - 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.</li> +</ul> +<h2><code>extensionContent</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.extensionContent">extensionContent</a> (<a href="#e.text">text</a> | <a href="#e.group">group</a> | <a href="#e.link">link</a> | <a href="#e.html">html</a> | <a href="#e.include">include</a>)></p> +<p class=code id=dtd><!ATTLIST extensionContent</p> +<p class=code id=dtdAttlist>style CDATA #IMPLIED<p class=code id=dtdAttlist>alt-style CDATA #IMPLIED<p class=code id=dtdAttlist>path CDATA #REQUIRED></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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.</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>style</b> - A relative path to a CSS file which is applied to the page only when using the Web based presentation.</li> +<li><b>alt-style</b> - A relative path to a SWT presentation properies file which is applied to the page only when using the SWT based presentation.</li> +<li><b>path</b> - 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</li> +</ul> +<h2><code>anchor</code></h2> +<br><p class=code id=dtd><!ELEMENT <a name="e.anchor">anchor</a> EMPTY></p> +<p class=code id=dtd><!ATTLIST anchor</p> +<p class=code id=dtdAttlist>id CDATA #IMPLIED></p> +<p></p> +<p class=ConfigMarkup id=elementDesc> +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</p> +<br> +<ul class=ConfigMarkup id=attlistDesc> +<li><b>id</b> - unique id to identify this anchor.</li> +</ul> +<br><br> +<p class=note id=copyright> +</p> + +</body> + +</html> |