备忘单内容

org.eclipse.ui.cheatsheets.cheatSheetContent

3.0

此扩展点用来注册备忘单内容添加项。备忘单作为“帮助”菜单或备忘单视图中的选项出现,备忘单通常用来帮助用户完成一系列复杂任务以实现总体目标。

备忘单被组织成一些通常反映特定问题域的类别。例如,面向 Java 的插件可定义一个名为“Java”的类别,该类别适用于将使用任何 Java 工具来帮助用户的备忘单。一个插件定义的类别可以由其它插件使用 cheatsheet 元素的 category 属性来引用。未分类别的备忘单以及具有无效类别路径的备忘单将放在“其它”类别中。

备忘单可选择指定其主体应包含有关备忘单的简短文本的描述子元素。

<!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>

cheatsheetContent 扩展点中的 category 元素将在备忘单菜单中创建新类别。可以从工作台中的帮助菜单中获得备忘单菜单。如果指定了新类别,则备忘单可能将针对该类别,并且在选择备忘单对话框中将出现在该类别下面。



<!ELEMENT cheatsheet (description?)>

<!ATTLIST cheatsheet

id          CDATA #REQUIRED

name        CDATA #REQUIRED

category    CDATA #IMPLIED

contentFile CDATA #IMPLIED

listener    CDATA #IMPLIED>

如果有一个备忘单要添加到工作台中,则应将 cheatsheet 元素添加到 cheatsheetContent 扩展点中。cheat sheet 元素必须指定一个标识、要出现在选择选项中的可翻译名称、用来指定此备忘单将包括在哪个类别中的类别标识以及一个内容文件。备忘单内容文件是一个 XML 文件,它描述备忘单具有的步骤和操作。



<!ELEMENT description (#PCDATA)>

备忘单的简短描述



以下是 cheatSheetContent 扩展点的样本用法:

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

有关进一步的详细信息,请参阅 org.eclipse.ui.cheatsheets API 包的细节。

没有内置备忘单。