向节点中添加帮助

通过向创建的消息流节点添加 HTML 文件来添加帮助信息。

1. 在项目中创建 help.html 文件以包含联机帮助，该帮助说明节点执行的操作以及如何使用该节点。
   如有数个文件，可以在插件项目中创建独立的 doc 子目录并将联机帮助文件存储在该目录中。

   您可以使节点的联机帮助看起来与产品提供的产品文档相集成，位于名为 "用户定义节点" 的叶节点下，您可以在 参考 > 消息流开发 > 用户定义扩展 > 用户定义节点中找到该节点。 要在该位置显示节点联机帮助：

   1. 修改 plugin.xml 文件以包含产品文档的以下扩展点:

      <extension point="org.eclipse.help.toc">
      <toc file="toc.xml"/>
      </extension>

   2. 在用户定义节点项目中创建 toc.xml 文件，并修改 link_to 属性以链接到已在信息中心内容视图中定义的 "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>

      您的帮助主题现在显示在 参考 > 消息流开发 > 用户定义的扩展 > 用户定义的节点下的内容视图中。

      与产品一起提供的样本节点演示了此选项。

      有关扩展点及其使用方法的进一步说明，请参阅 Eclipse 文档中的 PDE 指南。

2. 将上下文相关的（F1）帮助添加到节点。 单击 "集成开发" 透视图 中的节点并按 F1键时，将显示上下文相关帮助。

   创建节点时，将创建 HelpContexts.xml 文件。 此文件基于节点名指定上下文标识。 通过更改“描述”字段中的文本，修改节点的 HelpContexts.xml 文件。 在项目内，HelpContexts.xml 文件的名称必须唯一，但可以包含多个上下文条目；例如，如果在单个项目内具有多个节点，则每个节点都可以在此文件中具有上下文相关帮助。

   上下文相关帮助具有长度限制。 为用户提供更多帮助的可行方法是从 F1 帮助链接到包含更多信息的 HTML 文件；例如，链接到前面描述的节点联机帮助。 请使用以下代码实现此链接：

   <topic href"../plug-in directory/html file" label="Link title">
   

3. 将悬浮式帮助 (在 Windows 上称为 ToolTip 帮助) 添加到节点。 创建用户定义节点时，将创建 palette.properties 文件。 修改此文件以包含节点的悬浮式帮助，当选用板宽度不足，无法显示整个节点名称时，可以使用此帮助来显示节点名。