The cheat sheets are organized into categories which usually reflect a particular problem domain. For instance, a Java oriented plug-in may define a category called "Java" which is appropriate for cheat sheets that would aid a user with any of the Java tools. The categories defined by one plug-in can be referenced by other plug-ins using the category attribute of a cheatsheet element. Uncategorized cheat sheets, as well as cheat sheets with invalid category paths, will end up in an "Other" category.
Cheat sheets may optionally specify a description subelement whose body should contain short text about the cheat sheet.
<!ELEMENT extension (category | cheatsheet)*>
<!ATTLIST extension
point CDATA #REQUIRED
id CDATA #IMPLIED
name CDATA #IMPLIED>
<!ELEMENT category EMPTY>
<!ATTLIST category
id CDATA #REQUIRED
name CDATA #REQUIRED
parentCategory CDATA #IMPLIED>
A category element in the cheatsheetContent extension point creates a new category in the cheat sheet menu. The cheat sheet menu is available from the help menu in the workbench. If a new category is specified, cheat sheets may be targeted to that category and will appear under it in the cheat sheet selection dialog.
<!ELEMENT cheatsheet (description?)>
<!ATTLIST cheatsheet
id CDATA #REQUIRED
name CDATA #REQUIRED
category CDATA #IMPLIED
contentFile CDATA #IMPLIED
listener CDATA #IMPLIED>
A cheatsheet element is put into the cheatsheetContent extension point if there is a cheat sheet to be contributed to the workbench. A cheat sheet element must specify an id, a translatable name to appear in the selection options, a category id to specify which category this cheat sheet will be included in, and a content file. The cheat sheet content file is an XML file that describes the steps and actions that the cheat sheet has.
org.eclipse.ui.cheatsheets.CheatSheetListener
.<!ELEMENT description (#PCDATA)>
a short description of the cheat sheet
<extension point=
"org.eclipse.ui.cheatsheets.cheatSheetContent"
>
<category name=
"Example category"
id=
"com.example.category"
>
</category>
<cheatsheet name=
"Example cheat sheet"
category=
"com.example.category"
id=
"com.example.cheatSheet"
contentFile=
"ExampleCheatSheet.xml"
>
<description>
This is a descriptive bit of text for my cheat sheet description.</description>
</cheatsheet>
</extension>
Copyright (c) 2004 IBM Corporation and others.
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
http://www.eclipse.org/legal/epl-v10.html