diff options
Diffstat (limited to 'org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html')
| -rw-r--r-- | org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html | 66 |
1 files changed, 33 insertions, 33 deletions
diff --git a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html index 8d542cc72..607627524 100644 --- a/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html +++ b/org.eclipse.ui.cheatsheets/schema/cheatSheetContentFileSpec.html @@ -24,22 +24,22 @@ DTD fragments (<a href="cheatSheetContentFileSpec.exsd">machine readable XML sch <p></p> <p class="ConfigMarkupElementDesc"> The root element of a cheatsheet.</p> -<br/> +<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 SchemaDtd"><!ELEMENT <a name="e.intro">intro</a> (<a href="#e.description">description</a>)></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="ConfigMarkupElementDesc"> The <intro> element is used to define the introductory text to be displayed when the cheat sheet is opened.</p> -<br/> +<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 SchemaDtd"><!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="ConfigMarkupElementDesc"> The <description> element holds the description of a cheat sheet or of @@ -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/> +<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="ConfigMarkupElementDesc"> +<div class="ConfigMarkupElementDesc"> <p>Each <item> element describes one top-level step in a cheat sheet. An <item> may contain <subitem> elements. @@ -86,8 +86,8 @@ represented as sub-items.)</p> 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/> +based on cheat sheet variables whose value are acquired in earlier steps.</p></div> +<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> @@ -95,11 +95,11 @@ based on cheat sheet variables whose value are acquired in earlier steps.</p></p <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 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> +<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="ConfigMarkupElementDesc"> +<div 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. @@ -114,8 +114,8 @@ that they have successfully completed the step.</p> 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/> +as sub-items.)</p></div> +<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 @@ -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 SchemaDtd"><!ELEMENT <a name="e.conditional-subitem">conditional-subitem</a> (<a href="#e.subitem">subitem</a>+)></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="ConfigMarkupElementDesc"> +<div 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 @@ -159,8 +159,8 @@ then the second sub-item is selected and the item expands to something equivalent to <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/> +</item></span></pre></div> +<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>}", @@ -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 SchemaDtd"><!ELEMENT <a name="e.repeated-subitem">repeated-subitem</a> (<a href="#e.subitem">subitem</a>)></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="ConfigMarkupElementDesc"> +<div class="ConfigMarkupElementDesc"> <p>Each <repeated-subitem> element describes a sub-item that expands into 0, 1, or more similar sub-steps. @@ -202,8 +202,8 @@ then the item expands to something equivalent to: <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/> +</item></span></pre></div> +<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 @@ -212,13 +212,13 @@ 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 SchemaDtd"><!ELEMENT <a name="e.action">action</a> EMPTY></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="ConfigMarkupElementDesc"> Each <action> element describes an action in a cheat sheet.</p> -<br/> +<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> @@ -256,11 +256,11 @@ Examples: <br> <code>translate = ""</code> means do not translate any parameters for this action.</li> </ul> -<br/><p class="code SchemaDtd"><!ELEMENT <a name="e.command">command</a> EMPTY></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="ConfigMarkupElementDesc"> +<div 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> @@ -269,8 +269,8 @@ stores the result in the cheat sheet variable "result".</p> <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/> +</item></span></pre></div> +<br> <ul class="ConfigMarkupAttlistDesc"> <li><b>serialization</b> - A serialized <a href="../api/org/eclipse/core/commands/ParameterizedCommand.html"> @@ -297,7 +297,7 @@ Examples: <br> <code>translate = ""</code> means do not translate any parameters for this command.</li> </ul> -<br/><p class="code SchemaDtd"><!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="ConfigMarkupElementDesc"> Contains text which will be displayed when @@ -306,12 +306,12 @@ sheet to acknowledge completion of the entire task. The description consists of <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/> +<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="ConfigMarkupElementDesc"> +<div 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 @@ -339,8 +339,8 @@ to <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/> +</span></pre></div> +<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 @@ -350,7 +350,7 @@ to <item> element (or the empty string if the variable is unbound at that time).</li> </ul> -<br/><h6 class="CaptionFigColumn SchemaHeader">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 class="Example"><span class="code SchemaTag"> @@ -409,7 +409,7 @@ demonstrates the use of commands, perform-when and conditional subitems.</p> </span></pre> <p></p> -<br/> +<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 |