手动整合在线帮助
如果你不喜欢使用自动帮助生成，你可以提供帮助文件并且链接到Patterns Help锚，这样在线帮助中将出现与自动生成文件一样的目录表部分。本节描述链接你的模式帮助到Rational Software Architect的模式在线帮助的步骤。
本节引用 MyPatterns 例子项目。为了回顾一下，列表 5显示在加入帮助前的PatternFiles 目录树：
PatternFiles/ Pattern1/ Pattern1.emx Pattern1.rmd Pattern2/ Pattern2.emx Pattern2.rmd MyPatterns.rmd列表 5. PatternFiles 目录树下面的步骤描述如何把目录和文件加入项目，以便使帮助对于 Pattern1是可用的。
应用你的模式的任何人都可以通过在模式浏览器选择特定模式并从相关菜单中选择Show Pattern Documentation来获得它的帮助。模式用户界面开启在线帮助，与在内容面板表中所选择的模式主题一起，显示关于模式的概览页面。
为了在不使用内建的帮助生成器的情况下提供这一能力，你必须提供一个以模式名附加Overview.html结尾的文件，以便应用程序界面可以显示帮助。这一文件必须在预期的目录结构中：一个以模式命名的目录，一个名为PatternHelp的子目录。为了使你的模式成为在线帮助窗囗的目录表的一部分，你必须链接到模式帮助提供的锚。
按照这些步骤嵌入帮助： 创建一个作为你的模式帮助主页的 HTML 文件。这个文件应该以模式名来命名，并附加上Overview.html。 把该页放在上面描述的目录结结构中：一个以模式名命名的目录中的PatternHelp子目录。 建立一个具有链接属性的XML toc文件指向 /com.ibm.xtools.pttrn.user.doc/applypattern_TOC.xml#morePatterns。 增加你想要包括的任何主题的主题元素到XML toc 文件。确定包括了你在第 1 步中创建的主题概览文件。 增加内容文件表的引用到你的 plugin.xml 文件。你可以通过Eclipse打开 plugin.xml 文件，单击Extensions标签，选择org.eclipse.help.toc扩展，并使用关联菜单来增加一个新的 toc 元素。
在接着为为Pattern1提供了帮助后，MyPatterns 例子项目看起来象在列表 6 中显示的那样：
PatternFiles/ Pattern1/ PatternHelp/ Pattern1Overview.html MyTableOfContents.xml Pattern1.emx Pattern1.rmd Pattern2/ Pattern2.emx Pattern2.rmd MyPatterns.rmd列表 6. MyPatterns 例子项目MyTableOfContents.xml 文件看起来应该象列表 7 这样：
列表 7. MyTableOfContents.xml 文件在Eclipse Help目录表中的 Pattern1 主题列表将与具用帮助生成功能的库列表在同一级别出现。这是因为链接属性指向由Rational Software ArchitectPatterns功能定义的锚点。如果你想要模仿生成的帮助的结构，你可以提供你的库的帮助内容文件（HTML），并命名用链接属性把它放到模式功能帮助中。然后，你可以使用标准的Eclipse帮助toc结构在你的库主题下，为你的模式定义主题。
为了测试你的帮助，运行Rational Software Architect的调试工作台。在模式浏览器视图中右键点击你的模式，并选择Show Pattern Documentation。一个Eclipse Help窗囗将与你的文件一块右边面板中打开，同时你的文件的主题将在左边面板中被选择。如果文件在右边出现，但是左边的主题并未被选择，可能是你的目录文件表存在问题。如果你见到模式没有帮助的信息，这意味模式用户界面无法找你的概览文件；检查你已经在预期的目录中建立它并且把它命名为先前第 1 步所描述的名字。
结论
本文描述了你可以如何为模式和模式库生成在线帮助，及生成的帮助是如何与标准的在线帮助相连接。然后，它显示了你如何通过定义一个类似的结构来为模式提供你自己的帮助目录。
参考资料 您可以参阅本文在 developerWorks 全球站点上的英文原文。
Help -- Part 1: Contributing a Little Help (Revised for 2.0)一文提供关于开发在线帮助插件及在帮助系统中使用锚的信息。
从Trials and betas可以获得Rational Software Architect的评价版本。
关于Rational产品的更多技术资源，请访问developerWorks 中国网站 Rational 专区。你将会找到技术文档、教程、下载、产品信息及更多的其他信息。关于Rational Software Architect的特定信息，请访问RSA 技术资源页面。
可以通过访问Rational Software Architect的产品页获得更多与产品有关的信息。
关于Eclipse 3.0 平台的细节及更多信息，请访问Eclipse 主页。
通过参与developerWorks blogs获得有关developerWorks的交流。
在the Rational Software Architect, Software Modeler, Application Developer and Web Developer forum提出与Rational Software Architect相关的问题。
在Developer Bookstore 的 Rational 部分可以买到打折的Rational书籍。
请一定细读 Rational Software Architect 中的帮助页。这些页的面提供大量的信息，包括多媒体导航和演示。
文章来源于领测软件测试网 https://www.ltesting.net/
