diff options
| author | Chris Goldthorpe | 2007-09-18 18:47:00 +0000 |
|---|---|---|
| committer | Chris Goldthorpe | 2007-09-18 18:47:00 +0000 |
| commit | 4354703aa41faffeaaff217e111e5798d83d01e1 (patch) | |
| tree | 1fdf606fbd52d23eda5bdc11acd8becb0db0b3e7 | |
| parent | a267813006c9f257a05876221266194cacc57818 (diff) | |
| download | eclipse.platform.ua-20070918.tar.gz eclipse.platform.ua-20070918.tar.xz eclipse.platform.ua-20070918.zip | |
| -rw-r--r-- | org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html | 347 | ||||
| -rw-r--r-- | org.eclipse.ui.cheatsheets/schema/compositeContentFile.html | 91 |
2 files changed, 218 insertions, 220 deletions
diff --git a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html index b445c7924..8d542cc72 100644 --- a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html +++ b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html @@ -6,42 +6,42 @@ <style>@import url("../../schema.css");</style> </HEAD> <BODY> -<H1><CENTER>Cheat Sheet Content File XML Format</CENTER></H1> +<H1 style="text-align:center">Cheat Sheet Content File XML Format</H1> <p></p> -<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.ui.cheatsheets.cheat_sheet_schema<p></p> -<h6 class=CaptionFigColumn id=header>Since: </h6>3.2 +<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.cheatsheets.cheat_sheet_schema<p></p> +<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.2 <p></p> -<p> -<h6 class=CaptionFigColumn id=header>Description: </h6><p>This document describes the cheat sheet content file structure as a series of +<h6 class="CaptionFigColumn SchemaHeader">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><!ELEMENT <a name="e.cheatsheet">cheatsheet</a> (<a href="#e.intro">intro</a> , <a href="#e.item">item</a>+)></p> -<p class=code id=dtd><!ATTLIST cheatsheet</p> -<p class=code id=dtdAttlist>title CDATA #REQUIRED></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 SchemaHeader">Configuration Markup:</h6> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="code SchemaDtd"><!ELEMENT <a name="e.cheatsheet">cheatsheet</a> (<a href="#e.intro">intro</a> , <a href="#e.item">item</a>+)></p> +<p class="code SchemaDtd"><!ATTLIST cheatsheet</p> +<p class="code SchemaDtdAttlist">title CDATA #REQUIRED></p> +<p></p> +<p class="ConfigMarkupElementDesc"> The root element of a cheatsheet.</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>title</b> - The title of this cheat sheet. The title will be displayed at the head of the cheat sheet view when the cheat sheet is opened.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.intro">intro</a> (<a href="#e.description">description</a>)></p> -<p class=code id=dtd><!ATTLIST intro</p> -<p class=code id=dtdAttlist>contextId CDATA #IMPLIED<p class=code id=dtdAttlist>href CDATA #IMPLIED></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.intro">intro</a> (<a href="#e.description">description</a>)></p> +<p class="code SchemaDtd"><!ATTLIST intro</p> +<p class="code SchemaDtdAttlist">contextId CDATA #IMPLIED<p class="code SchemaDtdAttlist">href CDATA #IMPLIED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> The <intro> element is used to define the introductory text to be displayed when the cheat sheet is opened.</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>contextId</b> - The optional help context id of the documentation for this cheat sheet. If supplied, context help for the given fully-qualified context id is shown to the user (typically in a small pop-up window) when they clicks the introduction's help link. If this attribute is supplied, the <b>href</b> attribute should not be supplied (<b>href</b> will be ignored if both are present).</li> <li><b>href</b> - The optional help document describing this cheat sheet. If supplied, this help document is shown to the user (typically in a help browser shown in a separate window) when they clicks the introduction's help link. If this attribute is supplied, the <b>contextId</b> attribute should not be supplied (<b>href</b> will be ignored if both are present).</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.description">description</a> (#PCDATA)></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.description">description</a> (#PCDATA)></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> The <description> element holds the description of a cheat sheet or of a cheat sheet item. The description consists of text interspersed with <a href="../../../org.eclipse.platform.doc.isv/guide/forms_controls_text_markup.htm">form text markup</a>. The cheat sheet automatically formats and lays out the text to make it show up reasonably in the UI. Within the text, balanced <b><b></b>...<b></b></b> @@ -57,12 +57,12 @@ separator; adjacent spaces and line breaks are treated as single unit and rendered as a single space or a line break. Whitespace immediately after the <<b>description</b>> and <<b>br/</b>> tags is ignored, as is whitespace immediately before the <<b>/description</b>> tag.</p> -<br><br> -<p class=code id=dtd><!ELEMENT <a name="e.item">item</a> (<a href="#e.description">description</a> , (<a href="#e.action">action</a> | <a href="#e.command">command</a> | <a href="#e.perform-when">perform-when</a> | (<a href="#e.subitem">subitem</a> | <a href="#e.conditional-subitem">conditional-subitem</a> | <a href="#e.repeated-subitem">repeated-subitem</a>)*) , <a href="#e.onCompletion">onCompletion</a>?)></p> -<p class=code id=dtd><!ATTLIST item</p> -<p class=code id=dtdAttlist>title CDATA #REQUIRED<p class=code id=dtdAttlist>dialog (true | false) "false"<p class=code id=dtdAttlist>skip (true | false) "false"<p class=code id=dtdAttlist>contextId CDATA #IMPLIED<p class=code id=dtdAttlist>href CDATA #IMPLIED></p> +<br/><br/> +<p class="code SchemaDtd"><!ELEMENT <a name="e.item">item</a> (<a href="#e.description">description</a> , (<a href="#e.action">action</a> | <a href="#e.command">command</a> | <a href="#e.perform-when">perform-when</a> | (<a href="#e.subitem">subitem</a> | <a href="#e.conditional-subitem">conditional-subitem</a> | <a href="#e.repeated-subitem">repeated-subitem</a>)*) , <a href="#e.onCompletion">onCompletion</a>?)></p> +<p class="code SchemaDtd"><!ATTLIST item</p> +<p class="code SchemaDtdAttlist">title CDATA #REQUIRED<p class="code SchemaDtdAttlist">dialog (true | false) "false"<p class="code SchemaDtdAttlist">skip (true | false) "false"<p class="code SchemaDtdAttlist">contextId CDATA #IMPLIED<p class="code SchemaDtdAttlist">href CDATA #IMPLIED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> <p>Each <item> element describes one top-level step in a cheat sheet. An <item> may contain <subitem> elements. @@ -87,19 +87,19 @@ presentation of a sub-step based on cheat sheet variables whose values are acquired in earlier steps. A <repeated-subitem> subelement allows a step to include a set of similar sub-steps. Again, the exact set of sub-steps may be based on cheat sheet variables whose value are acquired in earlier steps.</p></p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>title</b> - The title of this step.</li> <li><b>dialog</b> - if "true" means this step involves opening a modal dialog. This is a hint to the system that it should allow the user to continue using the cheat sheet while in the modal dialog. This attribute will only affect dialogs launched from a command or action.</li> <li><b>skip</b> - if "true" means that the whole step can be skipped; the UI generally shows a button that the user can press to indicate that they are skipping this step</li> <li><b>contextId</b> - The optional help context id of the documentation for this cheat sheet step. If supplied, context help for the given fully-qualified context id is shown to the user (typically in a small pop-up window) when they clicks the step's help link. If this attribute is supplied, the <b>href</b> attribute should not be supplied (<b>href</b> will be ignored if both are present).</li> <li><b>href</b> - The optional help document describing this cheat sheet step. If supplied, this help document is shown to the user (typically in a help browser shown in a separate window) when they clicks the step's help link. If this attribute is supplied, the <b>contextId</b> attribute should not be supplied (<b>href</b> will be ignored if both are present).</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.subitem">subitem</a> (<a href="#e.action">action</a> | <a href="#e.command">command</a> | <a href="#e.perform-when">perform-when</a>)?></p> -<p class=code id=dtd><!ATTLIST subitem</p> -<p class=code id=dtdAttlist>label CDATA #REQUIRED<p class=code id=dtdAttlist>skip (true | false) "false"<p class=code id=dtdAttlist>when CDATA #IMPLIED></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.subitem">subitem</a> (<a href="#e.action">action</a> | <a href="#e.command">command</a> | <a href="#e.perform-when">perform-when</a>)?></p> +<p class="code SchemaDtd"><!ATTLIST subitem</p> +<p class="code SchemaDtdAttlist">label CDATA #REQUIRED<p class="code SchemaDtdAttlist">skip (true | false) "false"<p class="code SchemaDtdAttlist">when CDATA #IMPLIED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> <p>Each <subitem> element describes a sub-step in a cheat sheet. A <subitem> carries a simple text label, but has neither a lengthy description nor further sub-items. @@ -115,8 +115,8 @@ given item can be performed in any order. All sub-items within an item have to be completed or skipped before progressing to the next item. (Which means actions that must be performed in a required sequence should not be represented as sub-items.)</p></p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>label</b> - The title of the cheat sheet sub-item. If the string contains substring occurrences of the form "${<i>var</i>}", they are considered references to cheat sheet variables. All such occurrences in @@ -133,11 +133,11 @@ as sub-items.)</p></p> element matches this string value. This attribute is ignored if the <subitem> element is not a child of a <conditional-subitem> element.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.conditional-subitem">conditional-subitem</a> (<a href="#e.subitem">subitem</a>+)></p> -<p class=code id=dtd><!ATTLIST conditional-subitem</p> -<p class=code id=dtdAttlist>condition CDATA #REQUIRED></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.conditional-subitem">conditional-subitem</a> (<a href="#e.subitem">subitem</a>+)></p> +<p class="code SchemaDtd"><!ATTLIST conditional-subitem</p> +<p class="code SchemaDtdAttlist">condition CDATA #REQUIRED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> <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. <p>The <b>condition</b> attribute on the <conditional-subitem> element @@ -149,19 +149,19 @@ with the matching value. It is considered an error if there is no <subitem> element with a matching value.</p> <p>For example, if the cheat sheet variable named "v1" has the value "b" when the following item is expanded</p> -<pre><p class=code id=tag><item ...></p> - <p class=code id=tag><conditional-subitem condition=<p class=code id=cstring>"${v1}"</p><p class=code id=tag>></p> - <p class=code id=tag><subitem when=<p class=code id=cstring>"a"</p><p class=code id=tag> label=<p class=code id=cstring>"Step for A."</p><p class=code id=tag> /></p> - <p class=code id=tag><subitem when=<p class=code id=cstring>"b"</p><p class=code id=tag> label=<p class=code id=cstring>"Step for B."</p><p class=code id=tag> /></p> - <p class=code id=tag></conditional-subitem></p> -<p class=code id=tag></item></p></pre> +<pre class="Example"><span class="code SchemaTag"><item ...> + <conditional-subitem condition=</span><span class="code SchemaCstring">"${v1}"</span><span class="code SchemaTag">> + <subitem when=</span><span class="code SchemaCstring">"a"</span><span class="code SchemaTag"> label=</span><span class="code SchemaCstring">"Step for A."</span><span class="code SchemaTag"> /> + <subitem when=</span><span class="code SchemaCstring">"b"</span><span class="code SchemaTag"> label=</span><span class="code SchemaCstring">"Step for B."</span><span class="code SchemaTag"> /> + </conditional-subitem> +</item></span></pre> then the second sub-item is selected and the item expands to something equivalent to -<pre><p class=code id=tag><item ...></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Step for B."</p><p class=code id=tag>/></p> -<p class=code id=tag></item></p></pre></p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<pre class="Example"><span class="code SchemaTag"><item ...> + <subitem label=</span><span class="code SchemaCstring">"Step for B."</span><span class="code SchemaTag">/> +</item></span></pre></p> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>condition</b> - Arbitrary string value used to select which child <subitem> will be used. If the attribute string has the form "${<i>var</i>}", it is considered a reference to a cheat sheet variable <i>var</i>, and value @@ -169,11 +169,11 @@ equivalent to the start of execution of the containing <item> element (or the empty string if the variable is unbound at that time).</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.repeated-subitem">repeated-subitem</a> (<a href="#e.subitem">subitem</a>)></p> -<p class=code id=dtd><!ATTLIST repeated-subitem</p> -<p class=code id=dtdAttlist>values CDATA #REQUIRED></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.repeated-subitem">repeated-subitem</a> (<a href="#e.subitem">subitem</a>)></p> +<p class="code SchemaDtd"><!ATTLIST repeated-subitem</p> +<p class="code SchemaDtdAttlist">values CDATA #REQUIRED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> <p>Each <repeated-subitem> element describes a sub-item that expands into 0, 1, or more similar sub-steps. @@ -184,27 +184,27 @@ element with occurrences of the variable "this" replaced by the corresponding string value.</p> <p>For example, if the cheat sheet variable named "v1" has the value "1,b,three" when the following item is expanded</p> -<pre><p class=code id=tag><item ...></p> - <p class=code id=tag><repeated-subitem values=<p class=code id=cstring>"${v1}"</p><p class=code id=tag>></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Step ${this}."</p><p class=code id=tag>></p> - <p class=code id=tag><action class=<p class=code id=cstring>"com.xyz.myaction"</p><p class=code id=tag> pluginId=<p class=code id=cstring>"com.xyz"</p><p class=code id=tag> param1=<p class=code id=cstring>"${this}"</p><p class=code id=tag>/></p> - <p class=code id=tag></subitem></p> - <p class=code id=tag></repeated-subitem></p> -<p class=code id=tag></item></p></pre> +<pre class="Example"><span class="code SchemaTag"><item ...> + <repeated-subitem values=</span><span class="code SchemaCstring">"${v1}"</span><span class="code SchemaTag">> + <subitem label=</span><span class="code SchemaCstring">"Step ${this}."</span><span class="code SchemaTag">> + <action class=</span><span class="code SchemaCstring">"com.xyz.myaction"</span><span class="code SchemaTag"> pluginId=</span><span class="code SchemaCstring">"com.xyz"</span><span class="code SchemaTag"> param1=</span><span class="code SchemaCstring">"${this}"</span><span class="code SchemaTag">/> + </subitem> + </repeated-subitem> +</item></span></pre> then the item expands to something equivalent to: -<pre><p class=code id=tag><item ...></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Step 1."</p><p class=code id=tag>></p> - <p class=code id=tag><action class=<p class=code id=cstring>"com.xyz.myaction"</p><p class=code id=tag> pluginId=<p class=code id=cstring>"com.xyz"</p><p class=code id=tag> param1=<p class=code id=cstring>"1"</p><p class=code id=tag>/></p> - <p class=code id=tag></subitem></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Step b."</p><p class=code id=tag>></p> - <p class=code id=tag><action class=<p class=code id=cstring>"com.xyz.myaction"</p><p class=code id=tag> pluginId=<p class=code id=cstring>"com.xyz"</p><p class=code id=tag> param1=<p class=code id=cstring>"b"</p><p class=code id=tag>/></p> - <p class=code id=tag></subitem></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Step three."</p><p class=code id=tag>></p> - <p class=code id=tag><action class=<p class=code id=cstring>"com.xyz.myaction"</p><p class=code id=tag> pluginId=<p class=code id=cstring>"com.xyz"</p><p class=code id=tag> param1=<p class=code id=cstring>"three"</p><p class=code id=tag>/></p> - <p class=code id=tag></subitem></p> -<p class=code id=tag></item></p></pre></p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<pre class="Example"><span class="code SchemaTag"><item ...> + <subitem label=</span><span class="code SchemaCstring">"Step 1."</span><span class="code SchemaTag">> + <action class=</span><span class="code SchemaCstring">"com.xyz.myaction"</span><span class="code SchemaTag"> pluginId=</span><span class="code SchemaCstring">"com.xyz"</span><span class="code SchemaTag"> param1=</span><span class="code SchemaCstring">"1"</span><span class="code SchemaTag">/> + </subitem> + <subitem label=</span><span class="code SchemaCstring">"Step b."</span><span class="code SchemaTag">> + <action class=</span><span class="code SchemaCstring">"com.xyz.myaction"</span><span class="code SchemaTag"> pluginId=</span><span class="code SchemaCstring">"com.xyz"</span><span class="code SchemaTag"> param1=</span><span class="code SchemaCstring">"b"</span><span class="code SchemaTag">/> + </subitem> + <subitem label=</span><span class="code SchemaCstring">"Step three."</span><span class="code SchemaTag">> + <action class=</span><span class="code SchemaCstring">"com.xyz.myaction"</span><span class="code SchemaTag"> pluginId=</span><span class="code SchemaCstring">"com.xyz"</span><span class="code SchemaTag"> param1=</span><span class="code SchemaCstring">"three"</span><span class="code SchemaTag">/> + </subitem> +</item></span></pre></p> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>values</b> - A string containing a comma-separated list of values. If the attribute string has the form "${<i>var</i>}", it is considered a reference to a cheat sheet variable <i>var</i>, and value of @@ -212,14 +212,14 @@ then the item expands to something equivalent to: start of execution of the containing <item> element (or the empty string if the variable is unbound at that time).</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.action">action</a> EMPTY></p> -<p class=code id=dtd><!ATTLIST action</p> -<p class=code id=dtdAttlist>class CDATA #REQUIRED<p class=code id=dtdAttlist>pluginId CDATA #REQUIRED<p class=code id=dtdAttlist>paramN CDATA #IMPLIED<p class=code id=dtdAttlist>confirm (true | false) "false"<p class=code id=dtdAttlist>when CDATA #IMPLIED<p class=code id=dtdAttlist>required (true | false) "true"<p class=code id=dtdAttlist>translate CDATA #IMPLIED></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.action">action</a> EMPTY></p> +<p class="code SchemaDtd"><!ATTLIST action</p> +<p class="code SchemaDtdAttlist">class CDATA #REQUIRED<p class="code SchemaDtdAttlist">pluginId CDATA #REQUIRED<p class="code SchemaDtdAttlist">paramN CDATA #IMPLIED<p class="code SchemaDtdAttlist">confirm (true | false) "false"<p class="code SchemaDtdAttlist">when CDATA #IMPLIED<p class="code SchemaDtdAttlist">required (true | false) "true"<p class="code SchemaDtdAttlist">translate CDATA #IMPLIED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> Each <action> element describes an action in a cheat sheet.</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>class</b> - The fully-qualified name of the Java class implementing <code>org.eclipse.jface.action.IAction</code>. If this action also implements <code>org.eclipse.ui.cheatsheets.ICheatSheetAction</code> it will be invoked via its run(String[],ICheatSheetManager) method and be @@ -256,22 +256,22 @@ Examples: <br> <code>translate = ""</code> means do not translate any parameters for this action.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.command">command</a> EMPTY></p> -<p class=code id=dtd><!ATTLIST command</p> -<p class=code id=dtdAttlist>serialization CDATA #REQUIRED<p class=code id=dtdAttlist>returns CDATA #IMPLIED<p class=code id=dtdAttlist>confirm (true | false) "false"<p class=code id=dtdAttlist>when CDATA #IMPLIED<p class=code id=dtdAttlist>required (true | false) "true"<p class=code id=dtdAttlist>translate CDATA #IMPLIED></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.command">command</a> EMPTY></p> +<p class="code SchemaDtd"><!ATTLIST command</p> +<p class="code SchemaDtdAttlist">serialization CDATA #REQUIRED<p class="code SchemaDtdAttlist">returns CDATA #IMPLIED<p class="code SchemaDtdAttlist">confirm (true | false) "false"<p class="code SchemaDtdAttlist">when CDATA #IMPLIED<p class="code SchemaDtdAttlist">required (true | false) "true"<p class="code SchemaDtdAttlist">translate CDATA #IMPLIED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> <p>Each <command> element describes an command in a cheat sheet. <p>Below is an example of an item with a command which opens a dialog box and stores the result in the cheat sheet variable "result".</p> -<pre><p class=code id=tag><item title=<p class=code id=cstring>"View Selection"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Select a view which will be opened in the next step.<p class=code id=tag></description></p> - <p class=code id=tag><command returns = <p class=code id=cstring>"result"</p><p class=code id=tag> - serialization=<p class=code id=cstring>"org.eclipse.ui.dialogs.openMessageDialog(title=Select View,buttonLabel0=Package Explorer,message=Select a view ,buttonLabel1=Search View)"</p><p class=code id=tag>/></p> - <p class=code id=tag><onCompletion></p> Selected the ${result}. <p class=code id=tag></onCompletion></p> -<p class=code id=tag></item></p></pre></p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<pre class="Example"><span class="code SchemaTag"><item title=</span><span class="code SchemaCstring">"View Selection"</span><span class="code SchemaTag">> + <description>Select a view which will be opened in the next step.</description> + <command returns = </span><span class="code SchemaCstring">"result"</span><span class="code SchemaTag"> + serialization=</span><span class="code SchemaCstring">"org.eclipse.ui.dialogs.openMessageDialog(title=Select View,buttonLabel0=Package Explorer,message=Select a view ,buttonLabel1=Search View)"</span><span class="code SchemaTag">/> + <onCompletion> Selected the ${result}. </onCompletion> +</item></span></pre></p> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>serialization</b> - A serialized <a href="../api/org/eclipse/core/commands/ParameterizedCommand.html"> ParameterizedCommand</a>, which is a string containing the command name @@ -297,21 +297,21 @@ Examples: <br> <code>translate = ""</code> means do not translate any parameters for this command.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.onCompletion">onCompletion</a> (#PCDATA)></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.onCompletion">onCompletion</a> (#PCDATA)></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> Contains text which will be displayed when an item is completed. This is particularly useful in the final step of the cheat sheet to acknowledge completion of the entire task. The description consists of text interspersed with <a href="../../../org.eclipse.platform.doc.isv/guide/forms_controls_text_markup.htm">form text markup</a> following the same rules as for a <description> element. <onCompletion> elements may also contain references to cheat sheet variables of the form "${<i>var</i>}", which will be expanded using the actual value of the cheat sheet variable <i>var</i> at the time this step was completed.</p> -<br><br> -<p class=code id=dtd><!ELEMENT <a name="e.perform-when">perform-when</a> (<a href="#e.action">action</a> | <a href="#e.command">command</a>)+></p> -<p class=code id=dtd><!ATTLIST perform-when</p> -<p class=code id=dtdAttlist>condition CDATA #REQUIRED></p> +<br/><br/> +<p class="code SchemaDtd"><!ELEMENT <a name="e.perform-when">perform-when</a> (<a href="#e.action">action</a> | <a href="#e.command">command</a>)+></p> +<p class="code SchemaDtd"><!ATTLIST perform-when</p> +<p class="code SchemaDtdAttlist">condition CDATA #REQUIRED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> <p>Each <perform-when> element describes an action in a cheat sheet. <p>The <b>condition</b> attribute on the <conditional-subitem> element provides a string value (invariably this value comes from a cheat sheet @@ -322,26 +322,26 @@ with the matching value. It is considered an error if there is no <subitem> element with a matching value.</p> <p>For example, if the cheat sheet variable named "v1" has the value "b" when the following item is expanded</p> -<pre><p class=code id=tag><item ...></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Main step"</p><p class=code id=tag>></p> - <p class=code id=tag><perform-when condition=<p class=code id=cstring>"${v1}"</p><p class=code id=tag>></p> - <p class=code id=tag><action when=<p class=code id=cstring>"a"</p><p class=code id=tag> class=<p class=code id=cstring>"com.xyz.action1"</p><p class=code id=tag> pluginId=<p class=code id=cstring>"com.xyz"</p><p class=code id=tag> /></p> - <p class=code id=tag><action when=<p class=code id=cstring>"b"</p><p class=code id=tag> class=<p class=code id=cstring>"com.xyz.action2"</p><p class=code id=tag> pluginId=<p class=code id=cstring>"com.xyz"</p><p class=code id=tag> /></p> - <p class=code id=tag><command when=<p class=code id=cstring>"c"</p><p class=code id=tag> serialization=<p class=code id=cstring>"org.eclipse.search.ui.views.SearchView"</p><p class=code id=tag>/></p> - <p class=code id=tag></perform-when></p> - <p class=code id=tag></subitem></p> -<p class=code id=tag></item></p> -</pre> +<pre class="Example"><span class="code SchemaTag"><item ...> + <subitem label=</span><span class="code SchemaCstring">"Main step"</span><span class="code SchemaTag">> + <perform-when condition=</span><span class="code SchemaCstring">"${v1}"</span><span class="code SchemaTag">> + <action when=</span><span class="code SchemaCstring">"a"</span><span class="code SchemaTag"> class=</span><span class="code SchemaCstring">"com.xyz.action1"</span><span class="code SchemaTag"> pluginId=</span><span class="code SchemaCstring">"com.xyz"</span><span class="code SchemaTag"> /> + <action when=</span><span class="code SchemaCstring">"b"</span><span class="code SchemaTag"> class=</span><span class="code SchemaCstring">"com.xyz.action2"</span><span class="code SchemaTag"> pluginId=</span><span class="code SchemaCstring">"com.xyz"</span><span class="code SchemaTag"> /> + <command when=</span><span class="code SchemaCstring">"c"</span><span class="code SchemaTag"> serialization=</span><span class="code SchemaCstring">"org.eclipse.search.ui.views.SearchView"</span><span class="code SchemaTag">/> + </perform-when> + </subitem> +</item> +</span></pre> then the second action is selected and the item expands to something equivalent to -<pre><p class=code id=tag><item ...></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Main step"</p><p class=code id=tag>></p> - <p class=code id=tag><action class=<p class=code id=cstring>"com.xyz.action2"</p><p class=code id=tag> pluginId=<p class=code id=cstring>"com.xyz"</p><p class=code id=tag> /></p> - <p class=code id=tag></subitem></p> -<p class=code id=tag></item></p> -</pre></p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<pre class="Example"><span class="code SchemaTag"><item ...> + <subitem label=</span><span class="code SchemaCstring">"Main step"</span><span class="code SchemaTag">> + <action class=</span><span class="code SchemaCstring">"com.xyz.action2"</span><span class="code SchemaTag"> pluginId=</span><span class="code SchemaCstring">"com.xyz"</span><span class="code SchemaTag"> /> + </subitem> +</item> +</span></pre></p> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>condition</b> - Arbitrary string value used to select which child <action> or <command> will be performed. If the attribute string has the form "${<i>var</i>}", it is considered a reference to a cheat sheet @@ -350,72 +350,71 @@ to <item> element (or the empty string if the variable is unbound at that time).</li> </ul> -<br><h6 class=CaptionFigColumn id=header>Examples: </h6><p>The following is an example of a simple cheat sheet content file which +<br/><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6><p>The following is an example of a simple cheat sheet content file which demonstrates the use of commands, perform-when and conditional subitems.</p> -<pre> -<p class=code id=tag><?xml version=<p class=code id=cstring>"1.0"</p><p class=code id=tag> encoding=<p class=code id=cstring>"UTF-8"</p><p class=code id=tag>?></p> -<p class=code id=tag><cheatsheet title=<p class=code id=cstring>"Sample Cheat Sheet"</p><p class=code id=tag>></p> - <p class=code id=tag><intro></p> - <p class=code id=tag><description></p>A cheat sheet which demonstrates the use of perform-when and conditional subitems<p class=code id=tag></description></p> - <p class=code id=tag></intro></p> - <p class=code id=tag><item title=<p class=code id=cstring>"View Selection"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Select a view which will be opened in the following steps.<p class=code id=tag></description></p> - <p class=code id=tag><command returns = <p class=code id=cstring>"result"</p><p class=code id=tag> - serialization=<p class=code id=cstring>"org.eclipse.ui.dialogs.openMessageDialog(title=Select View,buttonLabel0=Package Explorer,message=Select a view ,buttonLabel1=Search View)"</p><p class=code id=tag>/></p> - <p class=code id=tag><onCompletion></p> Selected the ${result}. <p class=code id=tag></onCompletion></p> - <p class=code id=tag></item></p> - <p class=code id=tag><item title=<p class=code id=cstring>"Close Views"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Close the search view and package explorer if open<p class=code id=tag></description></p> - <p class=code id=tag></item></p> - <p class=code id=tag><item title=<p class=code id=cstring>"Open the view from a perform when item"</p><p class=code id=tag> skip = <p class=code id=cstring>"true"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Uses perform when to open the view seleted previously.<p class=code id=tag></description></p> - <p class=code id=tag><perform-when condition = <p class=code id=cstring>"${result}"</p><p class=code id=tag>></p> - <p class=code id=tag><command when = <p class=code id=cstring>"Package Explorer"</p><p class=code id=tag> - serialization=<p class=code id=cstring>"org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.jdt.ui.PackageExplorer)"</p><p class=code id=tag>/></p> - <p class=code id=tag><command when = <p class=code id=cstring>"Search View"</p><p class=code id=tag> - serialization=<p class=code id=cstring>"org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.search.ui.views.SearchView)"</p><p class=code id=tag>/></p> - <p class=code id=tag></perform-when></p> - <p class=code id=tag></item></p> - <p class=code id=tag><item title=<p class=code id=cstring>"Close Views"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Close the search view and package explorer if open<p class=code id=tag></description></p> - <p class=code id=tag></item></p> - <p class=code id=tag><item title=<p class=code id=cstring>"Open the view from a perform when subitem"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Uses perform when to open the view seleted previously.<p class=code id=tag></description></p> - <p class=code id=tag><subitem label=<p class=code id=cstring>"Perform when subitem"</p><p class=code id=tag> skip = <p class=code id=cstring>"true"</p><p class=code id=tag>></p> - <p class=code id=tag><perform-when condition = <p class=code id=cstring>"${result}"</p><p class=code id=tag>></p> - <p class=code id=tag><command when = <p class=code id=cstring>"Package Explorer"</p><p class=code id=tag> - serialization=<p class=code id=cstring>"org.eclipse.jdt.ui.PackageExplorer"</p><p class=code id=tag>/></p> - <p class=code id=tag><command when = <p class=code id=cstring>"Search View"</p><p class=code id=tag> - serialization=<p class=code id=cstring>"org.eclipse.search.ui.views.SearchView"</p><p class=code id=tag>/></p> - <p class=code id=tag></perform-when></p> - <p class=code id=tag></subitem></p> - <p class=code id=tag></item></p> - <p class=code id=tag><item title=<p class=code id=cstring>"Close Views"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Close the search view and package explorer if open<p class=code id=tag></description></p> - <p class=code id=tag></item></p> - <p class=code id=tag><item title=<p class=code id=cstring>"Open the view from a conditional subitem"</p><p class=code id=tag>></p> - <p class=code id=tag><description></p>Uses perform when to open the view seleted previously.<p class=code id=tag></description></p> - <p class=code id=tag><conditional-subitem condition=<p class=code id=cstring>"${result}"</p><p class=code id=tag>></p> - <p class=code id=tag><subitem when=<p class=code id=cstring>"Package Explorer"</p><p class=code id=tag> label=<p class=code id=cstring>"Open package explorer."</p><p class=code id=tag>></p> - <p class=code id=tag><command serialization = <p class=code id=cstring>"org.eclipse.jdt.ui.PackageExplorer"</p><p class=code id=tag>/></p> - <p class=code id=tag></subitem></p> - <p class=code id=tag><subitem when=<p class=code id=cstring>"Search View"</p><p class=code id=tag> label=<p class=code id=cstring>"Open Search View"</p><p class=code id=tag>></p> - <p class=code id=tag><command serialization = <p class=code id=cstring>"org.eclipse.search.ui.views.SearchView"</p><p class=code id=tag>/></p> - <p class=code id=tag></subitem></p> - <p class=code id=tag></conditional-subitem></p> - <p class=code id=tag></item></p> -<p class=code id=tag></cheatsheet></p> -</pre> +<pre class="Example"><span class="code SchemaTag"> +<?xml version=</span><span class="code SchemaCstring">"1.0"</span><span class="code SchemaTag"> encoding=</span><span class="code SchemaCstring">"UTF-8"</span><span class="code SchemaTag">?> +<cheatsheet title=</span><span class="code SchemaCstring">"Sample Cheat Sheet"</span><span class="code SchemaTag">> + <intro> + <description>A cheat sheet which demonstrates the use of perform-when and conditional subitems</description> + </intro> + <item title=</span><span class="code SchemaCstring">"View Selection"</span><span class="code SchemaTag">> + <description>Select a view which will be opened in the following steps.</description> + <command returns = </span><span class="code SchemaCstring">"result"</span><span class="code SchemaTag"> + serialization=</span><span class="code SchemaCstring">"org.eclipse.ui.dialogs.openMessageDialog(title=Select View,buttonLabel0=Package Explorer,message=Select a view ,buttonLabel1=Search View)"</span><span class="code SchemaTag">/> + <onCompletion> Selected the ${result}. </onCompletion> + </item> + <item title=</span><span class="code SchemaCstring">"Close Views"</span><span class="code SchemaTag">> + <description>Close the search view and package explorer if open</description> + </item> + <item title=</span><span class="code SchemaCstring">"Open the view from a perform when item"</span><span class="code SchemaTag"> skip = </span><span class="code SchemaCstring">"true"</span><span class="code SchemaTag">> + <description>Uses perform when to open the view seleted previously.</description> + <perform-when condition = </span><span class="code SchemaCstring">"${result}"</span><span class="code SchemaTag">> + <command when = </span><span class="code SchemaCstring">"Package Explorer"</span><span class="code SchemaTag"> + serialization=</span><span class="code SchemaCstring">"org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.jdt.ui.PackageExplorer)"</span><span class="code SchemaTag">/> + <command when = </span><span class="code SchemaCstring">"Search View"</span><span class="code SchemaTag"> + serialization=</span><span class="code SchemaCstring">"org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=org.eclipse.search.ui.views.SearchView)"</span><span class="code SchemaTag">/> + </perform-when> + </item> + <item title=</span><span class="code SchemaCstring">"Close Views"</span><span class="code SchemaTag">> + <description>Close the search view and package explorer if open</description> + </item> + <item title=</span><span class="code SchemaCstring">"Open the view from a perform when subitem"</span><span class="code SchemaTag">> + <description>Uses perform when to open the view seleted previously.</description> + <subitem label=</span><span class="code SchemaCstring">"Perform when subitem"</span><span class="code SchemaTag"> skip = </span><span class="code SchemaCstring">"true"</span><span class="code SchemaTag">> + <perform-when condition = </span><span class="code SchemaCstring">"${result}"</span><span class="code SchemaTag">> + <command when = </span><span class="code SchemaCstring">"Package Explorer"</span><span class="code SchemaTag"> + serialization=</span><span class="code SchemaCstring">"org.eclipse.jdt.ui.PackageExplorer"</span><span class="code SchemaTag">/> + <command when = </span><span class="code SchemaCstring">"Search View"</span><span class="code SchemaTag"> + serialization=</span><span class="code SchemaCstring">"org.eclipse.search.ui.views.SearchView"</span><span class="code SchemaTag">/> + </perform-when> + </subitem> + </item> + <item title=</span><span class="code SchemaCstring">"Close Views"</span><span class="code SchemaTag">> + <description>Close the search view and package explorer if open</description> + </item> + <item title=</span><span class="code SchemaCstring">"Open the view from a conditional subitem"</span><span class="code SchemaTag">> + <description>Uses perform when to open the view seleted previously.</description> + <conditional-subitem condition=</span><span class="code SchemaCstring">"${result}"</span><span class="code SchemaTag">> + <subitem when=</span><span class="code SchemaCstring">"Package Explorer"</span><span class="code SchemaTag"> label=</span><span class="code SchemaCstring">"Open package explorer."</span><span class="code SchemaTag">> + <command serialization = </span><span class="code SchemaCstring">"org.eclipse.jdt.ui.PackageExplorer"</span><span class="code SchemaTag">/> + </subitem> + <subitem when=</span><span class="code SchemaCstring">"Search View"</span><span class="code SchemaTag"> label=</span><span class="code SchemaCstring">"Open Search View"</span><span class="code SchemaTag">> + <command serialization = </span><span class="code SchemaCstring">"org.eclipse.search.ui.views.SearchView"</span><span class="code SchemaTag">/> + </subitem> + </conditional-subitem> + </item> +</cheatsheet> +</span></pre> <p></p> -<br> -<p class=note id=copyright> +<br/> +<p class="note SchemaCopyright"> Copyright (c) 2004, 2007 IBM Corporation and others.<br> All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> -<p></p> </p> </BODY> diff --git a/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html b/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html index 3f2520542..6962736fb 100644 --- a/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html +++ b/org.eclipse.ui.cheatsheets/schema/compositeContentFile.html @@ -6,65 +6,65 @@ <style>@import url("../../schema.css");</style> </HEAD> <BODY> -<H1><CENTER>Composite Cheat Sheets</CENTER></H1> +<H1 style="text-align:center">Composite Cheat Sheets</H1> <p></p> -<h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.ui.cheatsheets.composite_schema<p></p> -<h6 class=CaptionFigColumn id=header>Since: </h6>3.2 +<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.cheatsheets.composite_schema<p></p> +<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.2 <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. +<h6 class="CaptionFigColumn SchemaHeader">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><!ELEMENT <a name="e.compositeCheatsheet">compositeCheatsheet</a> (<a href="#e.taskGroup">taskGroup</a> | <a href="#e.task">task</a>)></p> -<p class=code id=dtd><!ATTLIST compositeCheatsheet</p> -<p class=code id=dtdAttlist>name CDATA #REQUIRED></p> +(<a href="cheatSheetContentFileSpec.exsd">machine readable XML schema.</a><p></p> +<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="code SchemaDtd"><!ELEMENT <a name="e.compositeCheatsheet">compositeCheatsheet</a> (<a href="#e.taskGroup">taskGroup</a> | <a href="#e.task">task</a>)></p> +<p class="code SchemaDtd"><!ATTLIST compositeCheatsheet</p> +<p class="code SchemaDtdAttlist">name CDATA #REQUIRED></p> +<p></p> +<p class="ConfigMarkupElementDesc"> The root element of a composite cheatsheet</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>name</b> - The name of the composite cheat sheet which will be displayed in large font when the composite cheat sheet is opened.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.taskGroup">taskGroup</a> ((<a href="#e.task">task</a> | <a href="#e.taskGroup">taskGroup</a>)+ , <a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.dependency">dependency</a>*)></p> -<p class=code id=dtd><!ATTLIST taskGroup</p> -<p class=code id=dtdAttlist>kind (set|sequence|choice) "set"<p class=code id=dtdAttlist>name CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>skip (true | false) "false"></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.taskGroup">taskGroup</a> ((<a href="#e.task">task</a> | <a href="#e.taskGroup">taskGroup</a>)+ , <a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.dependency">dependency</a>*)></p> +<p class="code SchemaDtd"><!ATTLIST taskGroup</p> +<p class="code SchemaDtdAttlist">kind (set|sequence|choice) "set"<p class="code SchemaDtdAttlist">name CDATA #REQUIRED<p class="code SchemaDtdAttlist">id CDATA #IMPLIED<p class="code SchemaDtdAttlist">skip (true | false) "false"></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> A task group represents a collection of related tasks. If the kind is "choice" only one of the child tasks need to be completed. If the kind is "set" or "sequence" all children must be completed. Note that the child elements <task>, <taskGroup>, <intro>, <onCompletion> and <dependency> may occur in any order. The order of the <task> and <taskGroup> elements determines the order in which they will be displayed and in the case of a sequence the order in which they must be performed.</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>kind</b> - The kind of this task group which can be "set", "sequence" or "choice". If the kind is set or sequence this task group is complete when all of its child tasks/task groups have been completed. In addition the subtasks of a sequence must be completed in order. A choice is complete when any of its subtasks has been completed.</li> <li><b>name</b> - The name of this task group which will be displayed in the task explorer.</li> <li><b>id</b> - An id for this task group which is required if this task group is referenced by a dependency element.</li> <li><b>skip</b> - If true this group of tasks may be skipped.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.task">task</a> (<a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.param">param</a>* , <a href="#e.dependency">dependency</a>*)></p> -<p class=code id=dtd><!ATTLIST task</p> -<p class=code id=dtdAttlist>kind CDATA "set"<p class=code id=dtdAttlist>name CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #IMPLIED<p class=code id=dtdAttlist>skip (true | false) "false"></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.task">task</a> (<a href="#e.intro">intro</a>? , <a href="#e.onCompletion">onCompletion</a>? , <a href="#e.param">param</a>* , <a href="#e.dependency">dependency</a>*)></p> +<p class="code SchemaDtd"><!ATTLIST task</p> +<p class="code SchemaDtdAttlist">kind CDATA "set"<p class="code SchemaDtdAttlist">name CDATA #REQUIRED<p class="code SchemaDtdAttlist">id CDATA #IMPLIED<p class="code SchemaDtdAttlist">skip (true | false) "false"></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> A leaf task within a composite cheat sheet. A task does not have children, but it does have a task editor which shows in the lower/right hand pane of the cheat sheet view. The task kind determines which task editor will be opened, a task kind of "cheatsheet" represents a simple cheatsheet. Other task kinds may be contributed. Note that the child elements <intro>, <onCompletion>, <param> and <dependency> may occur in any order.</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>kind</b> - The task kind. A task kind of "cheatsheet" represents a simple cheatsheet, other task kinds can be contributed using the extension point org.eclipse.ui.cheatsheets.cheatSheetContent.</li> <li><b>name</b> - The name of this task which will be displayed in the task explorer.</li> <li><b>id</b> - An id for this task group which is required if this task group is referenced by a dependency element.</li> <li><b>skip</b> - If true this task may be skipped.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.param">param</a> EMPTY></p> -<p class=code id=dtd><!ATTLIST param</p> -<p class=code id=dtdAttlist>name CDATA #REQUIRED<p class=code id=dtdAttlist>value CDATA #REQUIRED></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.param">param</a> EMPTY></p> +<p class="code SchemaDtd"><!ATTLIST param</p> +<p class="code SchemaDtdAttlist">name CDATA #REQUIRED<p class="code SchemaDtdAttlist">value CDATA #REQUIRED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> A parameter to a task within a composite cheatsheet. Each parameter has a name and value, both of which are strings. A task may have any number of parameters, two parameters for a single task may not share the same name.</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>name</b> - The name of this parameter. A task of kind="cheatsheet" can have the following parameters: <p>id: The id of a cheat sheet which has been registered using the extension point org.eclipse.ui.cheatsheets.cheatSheetContent. This identifies the cheatsheet which will be associated with this task. Either the id or the path parameter (but not both) should be specified.</p> @@ -74,35 +74,34 @@ A parameter to a task within a composite cheatsheet. Each parameter has a name a <p>showIntro: A boolean parameter with default value of true. If "false" the cheat sheet when started will initially show the first step rather than the introduction.</p></li> <li><b>value</b> - The value of this parameter.</li> </ul> -<br><p class=code id=dtd><!ELEMENT <a name="e.intro">intro</a> (#PCDATA)></p> +<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.intro">intro</a> (#PCDATA)></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> Contains the text which will be displayed before this task has been started. May contain <a href="../../../org.eclipse.platform.doc.isv/guide/forms_controls_text_markup.htm">form text markup</a>.</p> -<br><br> -<p class=code id=dtd><!ELEMENT <a name="e.onCompletion">onCompletion</a> (#PCDATA)></p> +<br/><br/> +<p class="code SchemaDtd"><!ELEMENT <a name="e.onCompletion">onCompletion</a> (#PCDATA)></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> Contains the text which will be displayed in the completion panel for this task. May contain <a href="../../../org.eclipse.platform.doc.isv/guide/forms_controls_text_markup.htm">form text markup</a>.</p> -<br><br> -<p class=code id=dtd><!ELEMENT <a name="e.dependency">dependency</a> EMPTY></p> -<p class=code id=dtd><!ATTLIST dependency</p> -<p class=code id=dtdAttlist>task CDATA #REQUIRED></p> +<br/><br/> +<p class="code SchemaDtd"><!ELEMENT <a name="e.dependency">dependency</a> EMPTY></p> +<p class="code SchemaDtd"><!ATTLIST dependency</p> +<p class="code SchemaDtdAttlist">task CDATA #REQUIRED></p> <p></p> -<p class=ConfigMarkup id=elementDesc> +<p class="ConfigMarkupElementDesc"> Creates a dependency between two tasks or subtasks.</p> -<br> -<ul class=ConfigMarkup id=attlistDesc> +<br/> +<ul class="ConfigMarkupAttlistDesc"> <li><b>task</b> - The id of the task or task group which must be completed before this task can be started.</li> </ul> -<br><br> -<p class=note id=copyright> +<br/><br/> +<p class="note SchemaCopyright"> Copyright (c) 2006, 2007 IBM Corporation and others.<br> All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a> -<p></p> </p> </BODY> |