为插件创建 .hep 文件

关于此任务

要向 IBM® Rational® Rhapsody® 提供装入插件所需的信息,必须创建 .hep 文件或添加现有 .hep 文件(如果已创建 .hep 文件)。

.hep 文件结构

关于此任务

要了解必须在 .hep 文件中包含的插件信息的类型,最好先了解可在 .hep 文件中描述的元素的类型。

.hep 文件用于描述以下项:

  • 辅助程序
  • 插件
  • 插件命令

虽然这些项彼此不同,但它们使用相同的 .hep 文件条目来向 Rational Rhapsody 提供所需的信息。

辅助程序还用于扩展产品中的功能,但它们使用与插件不同的机制。辅助程序是独立的应用程序。插件使用回调机制来响应事件。

插件命令描述 Rational Rhapsody 添加以打开特定插件的菜单项。

对于插件,.hep 文件必须包含以下信息:

  • 文件中定义的项(插件/辅助程序/插件命令)的个数
  • 插件的名称
  • 用于实现所需方法的 Java 类
  • 插件使用的 Java 类路径
  • 指示项是插件而不是辅助程序或插件命令
  • 指示是否必须将菜单项添加至“工具”菜单

描述.hep 文件所需的语法的最好方法是查看示例。

[Helpers]

所跟条目的类别

注: .hep 文件必须包含 [Helpers] 部分,因为辅助程序识别机制就是在 rhapsody.ini 文件(它还具有其他部分)中包含辅助程序定义时使用的机制。插件通常设计为供用户组使用,大多数情况下它不会在 rhapsody.ini 文件中包含插件定义信息,这些信息对于每个用户都不相同。
numberOfElements=2

文件中描述的插件/辅助程序的个数

name1=Diagram Formatter

“工具”菜单上显示的名称(如果 isVisible 设置为 1)

JavaMainClass1=JavaPlugin.PluginMainClass

包含插件代码的 Java 类

JavaClassPath1=$OMROOT\..\Samples\JavaAPI Samples\Plug-in

用于查找插件所需的 Java 类的路径。请记住,如果使用了 .jar 文件,那么类路径必须包含 .jar 文件的名称。

isPlugin1=1

指示该项为插件(相对于辅助程序(它为缺省值)或“插件命令”)

isVisible1=1

指示该名称显示在“工具”菜单中。

以下条目描述了“插件命令”

name2=Format Diagram

显示在上下文菜单中的文本

isPluginCommand2=1

指示插件命令(相对于辅助程序或插件)

command2=Diagram Formatter

此上下文菜单项打开的插件的名称

applicableTo2=ObjectModelDiagram

指示将此菜单添加至的上下文。在这种情况下,如果在浏览器中右键单击一个 OMD,那么将看到“格式化图”选项。

isVisible2=1

指示必须显示该菜单项

如果要查看其他样本 .hep 文件,请查看 <Rational Rhapsody installation path>\Samples\ExtensibilitySamples\
Simple Plug-in\SimplePluginProfile.hep
中包含的插件样本的 .hep 文件。

要将 .hep 文件连接至概要文件,请执行下列其中一项操作:
  • 将 .hep 文件命名为概要文件的名称,然后将其放在 .sbs 文件的目录中
  • 指示概要文件的 General::Profile::AdditionalHelpersFiles 属性值中 .help 文件的路径

反馈