Die Spickzettel sind in Kategorien unterteilt, die für gewöhnlich eine spzielle Problemdomäne wiedergeben. Ein Java-orientiertes Plug-in könnte beispielsweise eine Kategorie namens "Java" definieren, die für Spickzettel geeignet ist, die einem Benutzer mit einem beliebigen Java-Tool helfen würden. Auf die Kategorien, die durch ein Plug-in definiert werden, können andere Plug-ins unter Verwendung des Attributs 'category' eines Spickzettel-Elementes verweisen. Nicht kategorisierte Spickzettel sowie Spickzettel mit ungültigem Kategoriepfad enden mit der Kategorie "Other".
Spickzettel können optional ein Unterelement für eine Beschreibung angeben, dessen Hauptteil einen kurzen Text über den Spickzettel enthalten sollte.
<!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>
Ein Kategorieelement in dem Erweiterungspunkt 'cheatsheetContent' erstellt eine neue Kategorie im Spickzettelmenü. Das Spickzettelmenü ist über das Hilfemenü in der Workbench zugänglich. Wenn eine neue Kategorie angegeben wird, können Spickzettel auf diese Kategorie angezielt werden und werden unter ihr in dem Spickzettelauswahldialog angezeigt.
<!ELEMENT cheatsheet (description?)>
<!ATTLIST cheatsheet
id CDATA #REQUIRED
name CDATA #REQUIRED
category CDATA #IMPLIED
contentFile CDATA #IMPLIED
listener CDATA #IMPLIED>
Ein Spickzettelelement wird im Erweiterungspunkt 'cheatsheetContent' abgelegt, wenn ein Spickzettel zu der Workbench hinzugefügt werden soll. Ein Spickzettelelement muss eine ID, einen übersetzbaren Namen, der in den Auswahloptionen erscheint, eine Kategorie-ID, die angibt, in welcher Kategorie dieser Spickzettel enthalten sein wird und eine Inhaltsdatei angeben. Die Spickzettel-Inhaltsdatei ist eine XML-Datei, die die Schritte und Aktionen beschreibt, die der Spickzettel umfasst.
org.eclipse.ui.cheatsheets.CheatSheetListener
als Unterklasse aufnehmen muss.<!ELEMENT description (#PCDATA)>
Ene kurze Beschreibung des Spickzettels
<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>
Im Folgenden wird ein Beschreibungsbit des Textes für meine Spickzettelbeschreibung dargestellt.</description>
</cheatsheet>
</extension>
Copyright (c) 2004 IBM Corporation und Andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden gemäß den Bedingungen der "Eclipse Public License v1.0" zur Verfügung gestellt, die dieser Lieferung beiliegt und unter
http://www.eclipse.org/legal/epl-v10.html abgerufen werden kann.