| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html> |
| <head> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2006. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > |
| <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| <meta http-equiv="Content-Style-Type" content="text/css"> |
| <link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css"> |
| <script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js"></script> |
| <title>Composite cheat sheet content file XML format</title> |
| </head> |
| <body> |
| |
| <h3>Composite cheat sheet content file XML format</h3> |
| |
| <h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.ui.cheatsheets.composite_schema<p></p> |
| <h6 class=CaptionFigColumn id=header>Since: </h6>3.2 |
| <p></p> |
| |
| <h6 class=CaptionFigColumn id=header>Description: </h6><p>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>Configuration Markup:</h6> |
| <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> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| The root element of a composite cheatsheet</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <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 CDATA "set"</p><p class=code id=dtdAttlist>name CDATA #REQUIRED</p><p class=code id=dtdAttlist>id CDATA #IMPLIED</p><p class=code id=dtdAttlist>skip (true | false) "false"></p> |
| <p class=ConfigMarkup id=elementDesc> |
| 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.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <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 #REQUIRED</p><p class=code id=dtdAttlist>name CDATA #REQUIRED</p><p class=code id=dtdAttlist>id CDATA #IMPLIED</p><p class=code id=dtdAttlist>skip (true | false) "false"></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| 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.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <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><p class=code id=dtdAttlist>value CDATA #REQUIRED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| 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> |
| <li><b>name</b> - The name of this parameter.</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> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| Contains the text which will be displayed before this task has been started. May contain form text markup.</p> |
| <br><br> |
| <p class=code id=dtd><!ELEMENT <a name="e.onCompletion">onCompletion</a> (#PCDATA)></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| Contains the text which will be displayed in the completion panel for this task. May contain form text markup.</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> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| Creates a dependency between two tasks or subtasks.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>task</b> - The id of the task or task group which must be completed before this task can be started.</li> |
| </ul> |
| |
| </body> |
| </html> |
