可选:将帮助添加到节点

  1. 为节点添加联机帮助。您可以在项目中创建 help.html 文件来包含解释节点的用途和使用方法的联机帮助。如果您有几个文件,则可能要考虑在插件项目中创建分隔的文档子目录并在那里存储联机帮助文件。您可以使节点的联机帮助与产品提供的信息集成显示。在 WebSphere Message Broker 产品信息中(在引用 > 消息流下),有一个称为“用户定义的节点”的 leaf 节点。 要在该点显示节点的联机帮助,您需要:
    1. 修改 plugin.xml 文件来包括 WebSphere Message Broker 产品文档的扩展点。
      <extension point="org.eclipse.help.toc">
      <toc file="toc.xml"/>
      </extension>
    2. 在插件节点项目中创建 toc.xml 文件,并修改 link_to 属性,将它链接到已在 WebSphere Message Broker 文档目录中定义的“UDNodes”锚点,如下所示:
      <toc label="My Plugin Node" topic="my_node.htm"
      link_to="../com.ibm.etools.mft.doc/toc.xml#UDNodes">
      <topic label="Mytopic 1" href="topic1.htm>
      </toc>
      然后您应该在目录的引用 > 消息流 > 用户定义的节点下看到帮助主题。

      与产品一起提供的样本节点演示此功能。

      有关扩展点和如何使用它们的更多说明,请参阅PDE 指南

  2. 将上下文敏感的(F1)帮助添加到节点。这是在“代理应用程序开发”透视图中单击节点并按下 F1 时所看到的帮助。

    创建节点时,创建了 HelpContexts.xml 文件。这基于节点的名称指派上下文标识。您可以通过更改“描述”字段上的文本为节点修改 HelpContexts.xml 文件。在项目内,HelpContexts.xml 文件的名称必须是唯一的,但可以包含多个上下文条目,例如,如果您在单个项目内具有几个节点,则每个节点在文件中可以具有其上下文敏感的帮助。

    上下文敏感的帮助受长度限制。为用户提供更多帮助的可行方法是从 F1 帮助链接到包含更多信息的 HTML 文件,例如,链接到在上面进行了描述的节点的联机帮助。应该按如下所示来编码链接:
    <topic href"../plugin directory/html file" label="Link title">
  3. 将悬浮式帮助(工具提示帮助)添加到节点。创建节点时,创建了 palette.properties 文件。您可以修改此文件为节点包含悬浮式帮助,它用于当选用板没有足够的宽度来显示全部节点名称时来显示它。

如果您不想添加任何可选功能,则可立即对节点进行测试。为此,您需要启动另一个工作台更新开始实例(请参阅启用 PDE 运行时功能更新结束),并选择运行 > 运行为 > 运行时工作台。 请参阅 PDE 指南,获取有关使用运行时工作台进行测试的更多信息。

相关概念
用户定义的输入节点
用户定义的消息处理节点
用户定义的输出节点
相关任务
开发用户定义的扩展
实现提供的样本
测试用户定义的节点
分发用户定义的扩展
相关参考
用户定义的扩展
声明 | 商标 | 下载 | 书库 | 支持 | 反馈
Copyright IBM Corporation 1999, 2006 最后一次更新时间:2006/08/14
as04497_