Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Goldthorpe2007-01-18 13:03:51 -0500
committerChris Goldthorpe2007-01-18 13:03:51 -0500
commit27e2d6dfd4fbae07178bb566b97fcede2a9b72d0 (patch)
tree7b103dee7b21af946701358993c03e14037c9385 /org.eclipse.ui.cheatsheets
parent80029f0ed1393dc8f18897939b40c905de745fdc (diff)
downloadeclipse.platform.ua-27e2d6dfd4fbae07178bb566b97fcede2a9b72d0.tar.gz
eclipse.platform.ua-27e2d6dfd4fbae07178bb566b97fcede2a9b72d0.tar.xz
eclipse.platform.ua-27e2d6dfd4fbae07178bb566b97fcede2a9b72d0.zip
Updated schema docs for cheat sheets and composite cheat sheets
Diffstat (limited to 'org.eclipse.ui.cheatsheets')
-rw-r--r--org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.exsd2
-rw-r--r--org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html17
-rw-r--r--org.eclipse.ui.cheatsheets/schema/compositeContentFile.exsd2
-rw-r--r--org.eclipse.ui.cheatsheets/schema/compositeContentFile.html8
-rw-r--r--org.eclipse.ui.cheatsheets/schema/contentFile.xsd148
5 files changed, 19 insertions, 158 deletions
diff --git a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.exsd b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.exsd
index 562e3dc2b..2c90f654d 100644
--- a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.exsd
+++ b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.exsd
@@ -558,7 +558,7 @@ to
demonstrates the use of commands, perform-when and conditional subitems.</p>
<pre>
-<?xml version="1.0" encoding="UTF-8"?/>
+<?xml version="1.0" encoding="UTF-8"?>
<cheatsheet title="Sample Cheat Sheet">
<intro>
<description>A cheat sheet which demonstrates the use of perform-when and conditional subitems</description>
diff --git a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html
index 6d6859a73..5aa2243d9 100644
--- a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html
+++ b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html
@@ -2,8 +2,8 @@
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Cheat Sheet Content File XML Format</title>
-<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-I20061214-0010-win32/eclipse/plugins/org.eclipse.sdk_3.3.0.v20061211/book.css");</style>
-<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-I20061214-0010-win32/eclipse/configuration/org.eclipse.osgi/bundles/74/1/.cp/schema.css");</style>
+<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-N20070118-0010-win32/eclipse/plugins/org.eclipse.sdk_3.3.0.N20070118-0010/book.css");</style>
+<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-N20070118-0010-win32/eclipse/configuration/org.eclipse.osgi/bundles/76/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>Cheat Sheet Content File XML Format</CENTER></H1>
@@ -13,7 +13,10 @@
<p></p>
<p>
-<h6 class=CaptionFigColumn id=header>Description: </h6>The schema definition for a cheat sheet content file. A cheat sheet consists of a series of items (steps) which must be completed in order. Items can be divided into subitems and can launch commands or actions which will perform some of the steps for the user.</p>
+<h6 class=CaptionFigColumn id=header>Description: </h6><p>This document describes the cheat sheet content file structure as a series of
+DTD fragments (<a href="cheatSheetContentFileSpec.exsd">machine readable XML schema</a>).</p>
+
+<p>A cheat sheet consists of a series of items (steps) which must be completed in order. Items can be divided into subitems and can launch commands or actions which will perform some of the steps for the user.</p></p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.cheatsheet">cheatsheet</a> (<a href="#e.intro">intro</a> , <a href="#e.item">item</a>+)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST cheatsheet</p>
@@ -211,7 +214,7 @@ then the item expands to something equivalent to:
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.action">action</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST action</p>
-<p class=code id=dtdAttlist>class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>pluginId&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>paramN&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>confirm&nbsp;&nbsp;(true | false) "false"<p class=code id=dtdAttlist>when&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
+<p class=code id=dtdAttlist>class&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>pluginId&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>paramN&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>confirm&nbsp;&nbsp;(true | false) "false"<p class=code id=dtdAttlist>when&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>required&nbsp;(true | false) "true"&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
Each &lt;action&gt; element describes an action in a cheat sheet.</p>
@@ -244,10 +247,11 @@ Each &lt;action&gt; element describes an action in a cheat sheet.</p>
of the condition attribute of the containing &lt;perform-when&gt; element
matches this string value. This attribute is ignored if the &lt;action&gt;
element is not a child of&nbsp; a &lt;perform-when&gt; element.</li>
+<li><b>required</b> - if "true" this item or subitem can only be completed by performing this action (it may still be skipped if skip="true"). If "false" two buttons will be created, one to perform the task and one to mark it as complete, either will complete this step or substep.</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.command">command</a> EMPTY&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST command</p>
-<p class=code id=dtdAttlist>serialization&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>returns&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>confirm&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "false"<p class=code id=dtdAttlist>when&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
+<p class=code id=dtdAttlist>serialization&nbsp;CDATA #REQUIRED<p class=code id=dtdAttlist>returns&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>confirm&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "false"<p class=code id=dtdAttlist>when&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class=code id=dtdAttlist>required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "true"&gt;</p>
<p></p>
<p class=ConfigMarkup id=elementDesc>
<p>Each &lt;command&gt; element describes an command in a cheat sheet.
@@ -277,6 +281,7 @@ stores the result in the cheat sheet variable &quot;result&quot;.</p>
of the condition attribute of the containing &lt;perform-when&gt; element
matches this string value. This attribute is ignored if the &lt;command&gt;
element is not a child of&nbsp; a &lt;perform-when&gt; element.</li>
+<li><b>required</b> - if "true" this item or subitem can only be completed by performing this command (it may still be skipped if skip="true"). If "false" two buttons will be created, one to perform the task and one to mark it as complete, either will complete this step or substep.</li>
</ul>
<br><p class=code id=dtd>&lt;!ELEMENT <a name="e.onCompletion">onCompletion</a> (#PCDATA)&gt;</p>
<p></p>
@@ -335,7 +340,7 @@ to
demonstrates the use of commands, perform-when and conditional subitems.</p>
<pre>
-<p class=code id=tag>&lt;?xml version=<p class=code id=cstring>&quot;1.0&quot;</p><p class=code id=tag> encoding=<p class=code id=cstring>&quot;UTF-8&quot;</p><p class=code id=tag>?/&gt;</p>
+<p class=code id=tag>&lt;?xml version=<p class=code id=cstring>&quot;1.0&quot;</p><p class=code id=tag> encoding=<p class=code id=cstring>&quot;UTF-8&quot;</p><p class=code id=tag>?&gt;</p>
<p class=code id=tag>&lt;cheatsheet title=<p class=code id=cstring>&quot;Sample Cheat Sheet&quot;</p><p class=code id=tag>&gt;</p>
<p class=code id=tag>&lt;intro&gt;</p>
<p class=code id=tag>&lt;description&gt;</p>A cheat sheet which demonstrates the use of perform-when and conditional subitems<p class=code id=tag>&lt;/description&gt;</p>
diff --git a/org.eclipse.ui.cheatsheets/schema/compositeContentFile.exsd b/org.eclipse.ui.cheatsheets/schema/compositeContentFile.exsd
index 49fe08f43..ecf961700 100644
--- a/org.eclipse.ui.cheatsheets/schema/compositeContentFile.exsd
+++ b/org.eclipse.ui.cheatsheets/schema/compositeContentFile.exsd
@@ -7,6 +7,8 @@
</appInfo>
<documentation>
The schema definition for a composite cheat sheet content file. A composite cheat sheet consists of a set of tasks organized into task groups. Each task can be a simple cheat sheet or a user contributed task kind.
+
+(&lt;a href=&quot;cheatSheetContentFileSpec.exsd&quot;&gt;machine readable XML schema.&lt;/a&gt;
</documentation>
</annotation>
diff --git a/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html b/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html
index 48dd46de4..c6e77b40a 100644
--- a/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html
+++ b/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html
@@ -2,8 +2,8 @@
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Composite Cheat Sheets</title>
-<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-I20061213-0800-win32/eclipse/plugins/org.eclipse.sdk_3.3.0.v20061211/book.css");</style>
-<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-I20061213-0800-win32/eclipse/configuration/org.eclipse.osgi/bundles/74/1/.cp/schema.css");</style>
+<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-N20070118-0010-win32/eclipse/plugins/org.eclipse.sdk_3.3.0.N20070118-0010/book.css");</style>
+<style>@import url("file:/E:/EclipseBuilds/eclipse-SDK-N20070118-0010-win32/eclipse/configuration/org.eclipse.osgi/bundles/76/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1><CENTER>Composite Cheat Sheets</CENTER></H1>
@@ -13,7 +13,9 @@
<p></p>
<p>
-<h6 class=CaptionFigColumn id=header>Description: </h6>The schema definition for a composite cheat sheet content file. A composite cheat sheet consists of a set of tasks organized into task groups. Each task can be a simple cheat sheet or a user contributed task kind.</p>
+<h6 class=CaptionFigColumn id=header>Description: </h6>The schema definition for a composite cheat sheet content file. A composite cheat sheet consists of a set of tasks organized into task groups. Each task can be a simple cheat sheet or a user contributed task kind.
+
+(<a href="cheatSheetContentFileSpec.exsd">machine readable XML schema.</a></p>
<p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p>
<p class=code id=dtd>&lt;!ELEMENT <a name="e.compositeCheatsheet">compositeCheatsheet</a> (<a href="#e.taskGroup">taskGroup</a> | <a href="#e.task">task</a>)&gt;</p>
<p class=code id=dtd>&lt;!ATTLIST compositeCheatsheet</p>
diff --git a/org.eclipse.ui.cheatsheets/schema/contentFile.xsd b/org.eclipse.ui.cheatsheets/schema/contentFile.xsd
deleted file mode 100644
index 699ac580f..000000000
--- a/org.eclipse.ui.cheatsheets/schema/contentFile.xsd
+++ /dev/null
@@ -1,148 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema">
-
- <xsd:annotation>
- <xsd:documentation xml:lang="en">
- Schema for cheat sheet content file.
- Copyright (c) 2004, 2005 IBM Corporation and others.&lt;br&gt;
- All rights reserved. This program and the accompanying materials are made
- available under the terms of the Eclipse Public License v1.0 which
- accompanies this distribution, and is available at
- &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
- </xsd:documentation>
- </xsd:annotation>
-
- <xsd:element name="cheatsheet">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element maxOccurs="1" minOccurs="1" ref="intro"/>
- <xsd:element maxOccurs="unbounded" minOccurs="1" ref="item"/>
- </xsd:sequence>
- <xsd:attribute name="title" type="xsd:string" use="required"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="intro">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="description" minOccurs="1" maxOccurs="1"/>
- </xsd:sequence>
- <xsd:attribute name="contextId" type="xsd:string" use="optional"/>
- <xsd:attribute name="href" type="xsd:string" use="optional"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="description">
- <xsd:complexType>
- <xsd:simpleContent>
- <xsd:extension base="string"/>
- </xsd:simpleContent>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="onCompletion">
- <xsd:complexType>
- <xsd:simpleContent>
- <xsd:extension base="string"/>
- </xsd:simpleContent>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="item">
- <xsd:complexType mixed="true">
- <xsd:choice maxOccurs="1" minOccurs="1">
- <xsd:sequence>
- <xsd:element ref="description"/>
- <xsd:choice minOccurs="0" maxOccurs="1">
- <xsd:element ref="action"/>
- <xsd:element ref="command"/>
- <xsd:element ref="perform-when"/>
- </xsd:choice>
- <xsd:element minOccurs="0" maxOccurs="1" ref="onCompletion"/>
- </xsd:sequence>
- <xsd:choice maxOccurs="unbounded" minOccurs="0">
- <xsd:element ref="subitem"/>
- <xsd:element ref="conditional-subitem"/>
- <xsd:element ref="repeated-subitem"/>
- </xsd:choice>
- </xsd:choice>
- <xsd:attribute name="title" type="xsd:string" use="required"/>
- <xsd:attribute name="dialog" type="xsd:boolean" use="optional" default="false"/>
- <xsd:attribute name="skip" type="xsd:boolean" use="optional" default="false"/>
- <xsd:attribute name="contextId" type="xsd:string" use="optional"/>
- <xsd:attribute name="href" type="xsd:string" use="optional"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="subitem">
- <xsd:complexType>
- <xsd:choice minOccurs="0" maxOccurs="1">
- <xsd:element ref="action"/>
- <xsd:element ref="command"/>
- <xsd:element ref="perform-when"/>
- </xsd:choice>
- <xsd:attribute name="label" type="xsd:string" use="required"/>
- <xsd:attribute name="kind" type="ActionKind" use="required"/>
- <xsd:attribute name="skip" type="xsd:boolean" use="optional" default="false"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="conditional-subitem">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="subitem" minOccurs="1" maxOccurs="unbounded"/>
- </xsd:sequence>
- <xsd:attribute name="condition" type="xsd:string" use="required"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="repeated-subitem">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="subitem" minOccurs="1" maxOccurs="1"/>
- </xsd:sequence>
- <xsd:attribute name="values" type="xsd:string" use="required"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="action">
- <xsd:complexType>
- <xsd:attribute name="when" type="xsd:string" use="required"/>
- <xsd:attribute name="confirm" type="xsd:boolean" use="optional" default="false"/>
- <xsd:attribute name="class" type="xsd:string" use="optional"/>
- <xsd:attribute name="pluginId" type="xsd:string" use="optional"/>
- <xsd:attribute name="param1" type="xsd:string" use="optional"/>
- <xsd:attribute name="param2" type="xsd:string" use="optional"/>
- <xsd:attribute name="param3" type="xsd:string" use="optional"/>
- <xsd:attribute name="param4" type="xsd:string" use="optional"/>
- <xsd:attribute name="param5" type="xsd:string" use="optional"/>
- <xsd:attribute name="param6" type="xsd:string" use="optional"/>
- <xsd:attribute name="param7" type="xsd:string" use="optional"/>
- <xsd:attribute name="param8" type="xsd:string" use="optional"/>
- <xsd:attribute name="param9" type="xsd:string" use="optional"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="command">
- <xsd:complexType>
- <xsd:attribute name="when" type="xsd:string" use="required"/>
- <xsd:attribute name="confirm" type="xsd:boolean" use="optional" default="false"/>
- <xsd:attribute name="serialization" type="xsd:string" use="optional"/>
- <xsd:attribute name="returns" type="xsd:string" use="optional"/>
- </xsd:complexType>
- </xsd:element>
-
- <xsd:element name="perform-when">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:choice minOccurs="1" maxOccurs="unbounded">
- <xsd:element ref="action" />
- <xsd:element ref="command"/>
- </xsd:choice>
- </xsd:sequence>
- <xsd:attribute name="condition" type="xsd:string" use="required"/>
- </xsd:complexType>
- </xsd:element>
-
-</xsd:schema>
-

Back to the top