Eclipse提供了一种用于显示迷你型指南的内置机制,称为备忘单(cheat sheet)。备忘单可以快速而有效地指导您如何在Eclipse中执行包含多个步骤的过程,它显示在工作台的边角处,您可以轻易且快速地查看它们。
本教程演示了如何为Eclipse构造备忘单。构造完毕之后,它们还可以运行在BEA Workshop Studio、BEA Workshop for WebLogic和其他任何Eclipse系统之上,或许能对您现有的工具和插件进行补充。示例下载中提供了3个预备好的备忘单,其中一个备忘单用于说明如何构建您自己的备忘单。
简介
Eclipse为备忘单这个小而精致的功能提供了本地支持,备忘单可以为标准而又具体的任务提供快速指导。为了在Eclipse环境中显示可用的备忘单,可以单击Help > Cheat Sheets or Window > Show View > Other > Cheat Sheets > Cheat Sheets > OK。
备忘单以视图的形式出现在工作台的右侧,便于用户同时阅读和执行备忘单中的指导。下面给出了一个示例:
图 1. 备忘单视图
使用备忘单的目的是引导您完成一个过程,所以在完成备忘单中的某一个步骤之后,可以单击该步骤底部的图标,下一个步骤就会自动出现。单击 图标可以打开与备忘单中当前步骤有关的帮助页面。
您可以使用其他人提供的备忘单,也可以创建自己的。备忘单是一种理想的方式,可以让团队中的每个人了解如何进行标准但不是很频繁的操作,比如访问内部(in-house)API或连接到遗留应用程序。您在便条上记下的一系列步骤也可以作为备忘单的候选内容。备忘单保存在JAR文件中,您可以很轻易地与其他人共享它们。
正如您期望的那样,Eclipse还提供了一些简单的工具,用于将备忘单组装成插件,并将得到的JAR文件放入当前安装中。简言之,在一个插件项目中可以创建许多备忘单(每个备忘单都在它们自己的xml文件中),然后以JAR文件的形式导出它们,最后将它们放入本地eclipse/plug-ins文件夹中。
您可以在支持插件开发功能的任意Eclipse实例中创建备忘单,比如BEA Workshop for WebLogic 9.2。
编写自己的备忘单
本教程将引导您遍历在Eclipse中从头到尾创建一个备忘单的整个过程。总的说来,必须执行以下步骤:
建立一个用于创建备忘单文件的项目。
创建一个包含备忘单文本的XML文件。
定义备忘单属性。
将备忘单导出为JAR文件。
将JAR文件复制到Eclipse文件夹中。
访问备忘单。
以上步骤均十分简单。请打开您的Eclipse,让我们开始吧。
步骤 1:建立一个用于创建备忘单文件的项目
一开始,选择File > New > PRoject,并从New Project wizard展开Plug-In Development,然后选择Plug-in Project,如图2所示。使用BEA Workshop for WebLogic 9.2时,必须单击Show All Wizards选项来查看这些项目类型。
图 2. 创建一个插件项目
在下一个对话框上,指定项目名称。确保没有选中Create a java project选项,如图3所示。在创建涉及Java动作的更加复杂的备忘单时,必须选中这个选项。而对于只做启动向导这类简单工作的备忘单,则不需要创建Java项目。
图 3. 新的插件项目
在下一个对话框上,使用您或您公司的名称填写provider字段(参见图4)。单击Finish便可创建项目。
图 4. 插件内容
向导还会提示您转到Plug-in Development,您应该单击Yes。
至此,您已经创建了一个空的备忘单项目,现在可以开始给它填充内容了。
步骤 2:创建一个备忘单XML文件
您创建的每个备忘单都必须有自己的XML文件,这些文件包含备忘单的文本内容。备忘备结构十分简单:一个<intro>块后面跟着多个<item>块,每个<item>块分别对应着备忘单中的每一个步骤。格式选项被限制为<b></b>和<br />。
以下示例提供了一个由两个步骤组成的备忘单:
<?xml version="1.0" encoding="UTF-8"?>
<cheatsheet title="Demo Cheat Sheet"> <intro >
<description> This cheat sheet is a demo.
</description> </intro>
<item title="Hello, world!" > <description>
This is the <b>first</b> step in this cheat sheet.
<br /> </description> </item>
<item title="Hello, world again!" > <description>
This is the <b>second</b> step in this cheat sheet.
<br /> </description> </item></cheatsheet>