备忘单被组织成一些通常反映特定问题域的类别。例如,面向 Java 的插件可定义一个名为“Java”的类别,该类别适用于将使用任何 Java 工具来帮助用户的备忘单。一个插件定义的类别可以由其他插件使用 cheatsheet 元素的 category 属性来引用。未分类别的备忘单以及具有无效类别路径的备忘单将放在“其他”类别中。
备忘单可选择指定其主体应包含有关备忘单的简短文本的描述子元素。
<!ELEMENT extension (category | cheatsheet | taskEditor | taskExplorer)>
<!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>
cheatsheetContent 扩展点中的 category 元素将在备忘单菜单中创建新类别。可以从工作台中的帮助菜单中获得备忘单菜单。如果指定了新类别,则备忘单可能将针对该类别,并且在选择备忘单对话框中将出现在该类别下面。
<!ELEMENT cheatsheet (description?)>
<!ATTLIST cheatsheet
id CDATA #REQUIRED
name CDATA #REQUIRED
category CDATA #IMPLIED
contentFile CDATA #IMPLIED
listener CDATA #IMPLIED
composite (true | false) "false">
如果有一个备忘单要添加到工作台中,则应将 cheatsheet 元素添加到 cheatsheetContent 扩展点中。cheat sheet 元素必须指定一个标识、要出现在选择选项中的可翻译名称、用来指定此备忘单将包括在哪个类别中的类别标识以及一个内容文件。备忘单内容文件是一个 XML 文件,它描述备忘单具有的步骤和操作。
org.eclipse.ui.cheatsheets.CheatSheetListener
的子类的 Java 类的标准名称。<!ELEMENT description (#PCDATA)>
备忘单的简短描述
<!ELEMENT taskEditor EMPTY>
<!ATTLIST taskEditor
id CDATA #REQUIRED
class CDATA #REQUIRED
icon CDATA #REQUIRED>
此扩展点是临时的,它基于临时的 API 类 TaskEditor。 taskEditor 扩展点允许在组合备忘单的编辑器窗格中显示定制 UI。在组合备忘单中,对于类型与此扩展的标识相匹配的任何任务来说,它们将使用此扩展点中定义的类来创建编辑器区域。
<!ELEMENT taskExplorer EMPTY>
<!ATTLIST taskExplorer
id CDATA #REQUIRED
class CDATA #IMPLIED
icon CDATA #IMPLIED
name CDATA #REQUIRED>
此扩展点是临时的,它基于临时的 API 类 TaskExplorer。 此扩展点允许添加任务资源管理器。在打开组合备忘单时,将使用该任务资源管理器。
<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, 2006 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