模式库内容文件表
模式库内容文件表是一个以Eclipse中的 toc 格式存储的XML文件。该文件提供三种服务: 它链接库的生成帮助文件到Rational Software Architect Pattern的在线帮助 它为库描述帮助主题 它提供一个锚,以便在库中的模式可以插入帮助
模式库内容文件表储存在 PatternHelp 目录中,而且它以模式的名字附加上 ToC.xml 作为名字。在你的例子项目中,模式库内容文件表是 MyPatternsToC.xml 。
因为目录表如此重要,让我们更深入地探讨。列表 3显示 MyPatternsToC.xml 文件的内容:
列表 3. MyPatternsToC.xml 文件生成的模式库的内容文件表规定了一个为模式库命名的主题。模工库主题指向生成的模式库帮助内容文件。在模式库主题里面,目录表定义了它自己的锚点。
toc 元素包含一个链接属性。该属性在Rational Software Architect中的模式功能帮助下面显示MyPatterns 库的帮助。模式的在线帮助提供一个在标准在线帮助toc文件中称为morePatterns的锚。所有的模式库可以链接到这个锚,所以,所有的已安装的模式都在相同的在线帮助集装箱(或工作薄)中被一起显示。结果是,所有的模式信息和相关的在线帮助在相同的位置被统一起来。
模式帮助内容文件
对于每个模式,有三个内容文件被建立,它们包含来自模式的 RAS 的声明文件的信息。关于模式的 RAS 声明是在以模式命名的目录中,包含关于模式和参数的信息。在例子项目中,Pattern1.rmd 和 Pattern2.rmd 是关于 Pattern1 和 Pattern2 RAS 的声明文件。
所有的内容文件都可以在以模式命名的目录下的 PatternHelp 目录中找到。下面是关于这些文件的一个简短描述: 概览内容文件:这一文件包括关于模式的一般信息,如简短描述,版本,作者和模式所属的组列表。当模式应用者在模式浏览器或应用模式向导中触发Show Pattern Documentation命令时,概览文件被显示出来。它的文件名是在模式名后面附加 Overview.html 。在例子项目中,Pattern1Overview.html 和 Pattern2Overview.html 分别是 Pattern1 和 Pattern2 的概览文件。 描述内容文件:该文件允许你提供如何应用模式的细节描述。如果你没有使用模式作者视图中的Import Description File相关菜单引入描述,该页将只包含模式的名称。该文件的名字通过在模式名后附加 Description.html 生成。在例子项目中,Pattern1Description.html 和 Pattern2Description.html 是描述文件。 参数内容文件:该文件包含关于模式参数的信息。文件被分成几部分,每部分说明一个参数。每个部分均包含类型,可见性,多样性,ID 和参数描述。如果你没有使用Import Description File相关菜单命令来导入描述,描述区域将是空白的。该文件通过在模式名后增加 Parameters.html 命名。在例子项目中,参数内容文件是 Pattern1Parameters.html 和 Pattern2Parameters.html 。
模式内容文件表
模式内容文件表是一个XML文件,它符合Eclipse中的 toc 文件格式。该文件链接到在模式库内容文件表中定义的锚。它包含为模式命名的标题,就如在前一节中描述的三个帮助内容文件。
让我们看看 Pattern1 的目录表,你会发现主题是如何被安排的。列表 4显示 Pattern1ToC.xml 文件的内容:
列表 4. Pattern1ToC.xml 文件的内容注意,toc 元素包含一个向后链接属性,它指向在模式库目录表中定义的锚点。因此,Pattern1 的帮助是嵌在Eclipse 帮助系统的模式库预定中。
在plugin.xml 中引用内容文件表
为模式库插入的 plugin.xml 文件必须为每个模式内容文件表包含 toc 元素。每当生成内容文件表时,帮助生成过程增加 toc 元素。
文章来源于领测软件测试网 https://www.ltesting.net/