Composite Cheat Sheets

Identifier:

org.eclipse.ui.cheatsheets.composite_schema

Since:

3.2

Description:

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. (machine readable XML schema.

Configuration Markup:

<!ELEMENT compositeCheatsheet (taskGroup | task)>

<!ATTLIST compositeCheatsheet

name CDATA #REQUIRED>

The root element of a composite cheatsheet

name - The name of the composite cheat sheet which will be displayed in large font when the composite cheat sheet is opened.

<!ELEMENT taskGroup ((task | taskGroup)+ , intro? , onCompletion? , dependsOn*)>

<!ATTLIST taskGroup

kind (set|sequence|choice) "set"

name CDATA #REQUIRED

id CDATA #IMPLIED

skip (true | false) "false">

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 <dependsOn> 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.

kind - 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.
name - The name of this task group which will be displayed in the task explorer.
id - An id for this task group which is required if this task group is referenced by a dependsOn element.
skip - If true this group of tasks may be skipped.

<!ELEMENT task (intro? , onCompletion? , param* , dependsOn*)>

<!ATTLIST task

kind CDATA "set"

name CDATA #REQUIRED

id CDATA #IMPLIED

skip (true | false) "false">

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 <dependsOn> may occur in any order.

kind - 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.
name - The name of this task which will be displayed in the task explorer.
id - An id for this task group which is required if this task group is referenced by a dependsOn element.
skip - If true this task may be skipped.

<!ELEMENT param EMPTY>

<!ATTLIST param

name CDATA #REQUIRED

value CDATA #REQUIRED>

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.

name - The name of this parameter. A task of kind="cheatsheet" can have the following parameters:
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.

path: The URL of a cheat sheet content file. This may be an absolute URL, or relative to the content file for the composite cheat sheet. If both id and path are specified the path will be used to locate the content file and the id parameter will be ignored.

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.
value - The value of this parameter.

<!ELEMENT intro (#PCDATA)>

Contains the text which will be displayed before this task has been started. May contain form text markup.

<!ELEMENT onCompletion (#PCDATA)>

Contains the text which will be displayed in the completion panel for this task. May contain form text markup.

<!ELEMENT dependsOn EMPTY>

<!ATTLIST dependsOn

task CDATA #REQUIRED>

Creates a dependency between two tasks or subtasks.

task - The id of the task or task group which must be completed before this task can be started.

Copyright (c) 2006, 2007 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/ SPDX-License-Identifier: EPL-2.0