diff options
| -rw-r--r-- | org.eclipse.ui.intro/schema/IntroContent.exsd | 4 | ||||
| -rw-r--r-- | org.eclipse.ui.intro/schema/introContentFileSpec.html | 237 |
2 files changed, 2 insertions, 239 deletions
diff --git a/org.eclipse.ui.intro/schema/IntroContent.exsd b/org.eclipse.ui.intro/schema/IntroContent.exsd index c2da5e827..e0901a2b0 100644 --- a/org.eclipse.ui.intro/schema/IntroContent.exsd +++ b/org.eclipse.ui.intro/schema/IntroContent.exsd @@ -483,14 +483,14 @@ This markup is only to be used with an SWT Based intro part implementation. It i <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>
diff --git a/org.eclipse.ui.intro/schema/introContentFileSpec.html b/org.eclipse.ui.intro/schema/introContentFileSpec.html deleted file mode 100644 index 2041bbd07..000000000 --- a/org.eclipse.ui.intro/schema/introContentFileSpec.html +++ /dev/null @@ -1,237 +0,0 @@ -<!DOCTYPE html PUBLIC "-//w3c//dtd html 4.0 transitional//en"> -<html> -<head> - <meta content="text/html; charset=iso-8859-1" - http-equiv="Content-Type"> - <meta content="Microsoft FrontPage 4.0" name="GENERATOR"> - <meta content="FrontPage.Editor.Document" name="ProgId"> - <title>Intro Content File XML Format</title> -</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="contentFile.xsd">XML schema</a>).</p> -<h2><code>introContent</code></h2> -<pre><!ELEMENT introContent (page+ | div* | extensionContent*)> <br><!ATTLIST introContent <br>></pre> -<p>The <introContent> element defines the body of the intro -content -file. <intoContent> has no attributes.<br> -</p> -<h2><code>page</code></h2> -<pre><!ELEMENT page (div* | link* | text* | head? | img* | include* | html* | title?)><br><!ATTLIST page<br> id CDATA #REQUIRED <br> title CDATA #IMPLIED <br> style CDATA #IMPLIED <br> alt-style CDATA #IMPLIED <br> url CDATA #IMPLIED <br> standby-url CDATA #IMPLIED <br> standby-style CDATA #IMPLIED <br> standby-alt-style CDATA #IMPLIED<br> class-id CDATA #IMPLIED <br>></pre> -<p>The <page> element is used to describe a page to -be displayed. The <page> is either either dynamic or static. -<page> attributes are as follows:</p> -<ul> - <li><b>id</b> - A unique name that can be used to identify this page.<br> - </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.<br> - </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>url</b> - 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. </li> - <li><b>standby-url</b> - (todo - is this even used?)<br> - </li> - <li><b>standby-style</b> - (todo - is this even used?) </li> - <li><b>standby-alt-style</b> - (todo - is this even used?) </li> - <li><span style="font-weight: bold;">class-id</span> - A means to -classifiy the page into a given category so that a common style may be -applied.</li> -</ul> -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> -<br> -Dynamic pages do not have a <span style="font-weight: bold;">url</span> -defined and their contents are generated from the subelements of the -page. The <span style="font-weight: bold;">style</span> or <span - style="font-weight: bold;">alt-style</span> will be applied depending -on the presentation. The styles can be further enhanced by referencing -the <span style="font-weight: bold;">id</span> or <span - style="font-weight: bold;">class-id</span>.<br> -<br> -A <div> subelement is used to group of content and apply style -across the grouped content. A <link> 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 <text> -subelement defines textual content for the page level. A <head> -subelement is only applicable for the Web based presentation and allows -for additional html to be added to the HTML <head> section. This -is useful for adding java srcipts or extra styles sheets. An -<img> subelement defines image content for the page level. An -<include> subelement allows for reuse any element other than a -page. An <html> 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 <object> by referencing the html file. -Inclusion allows for embedding an html snippets directly from html -file. A <title> subelement defines the title of the page.<br> -<h2><code>div</code></h2> -<pre><!ELEMENT div (div* | link* | text* | img* | include* | html*)> <br><!ATTLIST div <br> id CDATA #REQUIRED<br> label CDATA #IMPLIED <br> class-id CDATA #IMPLIED<br>></pre> -<p>The <div> element is used to group related elements, either -content or presentation-wise. <div> attributes are -as -follows:</p> -<ul type="disc"> - <li><b>id</b>- A unique name that can be used to identify this div. </li> - <li><b>label</b>- The title of the div item. (todo - should this be -moved to a title element?)<br> - </li> - <li><b>class-id</b>- A means to classifiy the div into a given -category so that a common style may be applied.</li> -</ul> -A <link> 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 <text> subelement defines textual content for the page -level. An <img> subelement defines image content for the -page level. An <include> subelement allows for reuse any element -other than a page. An <html> 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 <object> by referencing the -html file. Inclusion allows for embedding an html snippets directly -from html file. -<h2><code></code>link</h2> -<code></code> -<pre><!ELEMENT link (text?)> <br><!ATTLIST link <br> url CDATA #REQUIRED<br> id CDATA #IMPLIED<br> label CDATA #IMPLIED<br> class-id CDATA #IMPLIED<br>></pre> -<p>Each <conditional-subitem> element describes a single sub-step -whose -form can differ based on a condition known at the time the item is -expanded. -<conditional-subitem> attributes are as follows:</p> -<ul type="disc"> - <li><span style="font-weight: bold;">url</span> - A valid URL to -external web site or a 'special' URL syntax will be reserved for -Eclipse actions. All URLs in the following form -http://org.eclipse.ui.intro/<command>?p1=v1&p2=v2...will be -processed as Eclipse requests. (todo - either include all the commands -here or reference the file describing the commands)<br> - </li> - <li><b>id</b> - A unique name that can be used to identify this link. - </li> - <li><b>label</b> - The title of the div item. </li> - <li><b>class-id</b> - A means to classifiy the div into a given -category so that a common style may be applied.</li> -</ul> -<h2><code>text</code></h2> -<pre><!ELEMENT text EMPTY> <br><!ATTLIST text <br> id CDATA #IMPLIED<br> class-id CDATA #IMPLIED<br>></pre> -<p>Each <text> element defines textual content. <text> -attributes -are as -follows:</p> -<ul type="disc"> - <li><b>id</b> - A unique name that can be used to identify this text.</li> - <li><b>class-id</b> - A means to classifiy the div into a given -category so that a common style may be applied.</li> -</ul> -<h2><code>head</code></h2> -<pre><!ELEMENT head EMPTY> <br><!ATTLIST head <br> src CDATA #REQUIRED<br>></pre> -<p>A <head> element is only applicable for the Web based -presentation and allows for additional html to be added to the HTML -<head> section. This is useful for adding java srcipts or extra -styles sheets. -<head> attributes are as follows:</p> -<ul type="disc"> - <li><b>src</b>- A relative URL to a file containing the HTML to -include directly into the HTML <head> section. </li> -</ul> -<h2><code>img</code></h2> -<pre><!ELEMENT img EMPTY> <br><!ATTLIST img <br> id CDATA #REQUIRED<br> src CDATA #REQUIRED<br> alt CDATA #IMPLIED<br> class-id CDATA #IMPLIED<br>></pre> -<p>Each <img> element describes an image that represents intro -content.not presentation content. -<img> attributes are as follows:</p> -<ul type="disc"> - <li><b>id</b> - A unique name that can be used to identify this img.</li> - <li><b>src</b> - A relative URL to the image file. </li> - <li><b>alt</b> - The alternative text to use when the image can not -be load or is not use by the presentation.</li> - <li><b>class-id</b> - A means to classifiy the div into a given -category so that a common style may be applied.</li> -</ul> -<h2><code>include</code></h2> -<pre><!ELEMENT include EMPTY> <br><!ATTLIST include <br> path CDATA #REQUIRED<br> configId CDATA #REQUIRED<br> merge-style ("true" | "false") "false"<br>></pre> -<p>Each <include> element expands an element targeted by the -given path and an optional configId attributes. The path should -uniquely address an element within the specified configuration. It -could point to a div defined at the configuration level, or any element -in a page.(todo - can the path reference elements within divs? I -thought it could reference any element.) -<include> attributes are as follows:</p> -<ul type="disc"> - <li><b>path</b> - The path that uniquely represents the target -element within the configuration (e.g. page/div1/div2). It may be a div -element, or any element that may be contained in a div. You can not -include a page.</li> - <li><b>configId</b> - An identifier of an intro 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. -(todo - the configId was marked as required in the schema but the -description states that it is optional. So is it optional?)</li> - <li><b>mergeStyle</b> - If true, style belonging to the page that -owns the included element will be added to list of styles of the -including page. If false, the including page is responsible for -controling properties of the included element.</li> -</ul> -<h2><code>html</code></h2> -<pre><!ELEMENT html ( [img|text] )> <br><!ATTLIST html <br> id CDATA #REQUIRED<br> src CDATA #REQUIRED<br> type ("embed" | "inline") <br> class-id CDATA #IMPLIED<br>></pre> -<p>An <html> element 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 <object> by referencing the -html file. Inclusion allows for embedding an html snippets directly -from html file. <html> attributes are as follows:</p> -<ul type="disc"> - <li><b>id</b> - A unique name that can be used to identify this html.</li> - <li><b>src</b> - A relative URL to a file containing the HTML embed -or include.</li> - <li><span style="font-weight: bold;">type</span> - 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, the html element will be -ignored by the intro configuration. </li> - <li><b>class-id</b> - A means to classifiy the div into a given -category so that a common style may be applied.<br> - </li> -</ul> -<h2><code>title</code></h2> -<pre><!ELEMENT title EMPTY> <br><!ATTLIST title <br> id CDATA #IMPLIED<br> class-id CDATA #IMPLIED<br>></pre> -<p>A <title> element defines a page's title. -<title> attributes are as follows:</p> -<ul type="disc"> - <li><b>id</b> - A unique name that can be used to identify this title.</li> - <li><b>class-id</b> - A means to classifiy the div into a given -category so that a common style may be applied.<br> - </li> -</ul> -<h2><code>extensionContent</code></h2> -<pre><!ELEMENT extensionContent( div* | link* )> <br><!ATTLIST extensionContent<br> path CDATA #REQUIRED<br> style CDATA #IMPLIED<br> alt-style CDATA #IMPLIED<br>></pre> -<p>An <extensionContent> element defines the content to be added -to the target page or div. (todo - what happen to placeholders?) -<extensionContent> attributes are as follows:</p> -<ul type="disc"> - <li><b>path</b>- The path that uniquely represents the element (e.g. -page/div1/div2) within the target configuration to be extended. It can -only be a page or a div, including shared divs at configuration level. </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.<br> - </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> -</ul> -</body> -</html> |