手机站
网通分站
电信主站
密 码:
用户名:
当前位置 : 主页>网络编程>其它>列表

使用RationalSoftwareArchitect

来源:互联网 作者:西部数码 时间:2008-04-09
西部数码-全国虚拟主机10强!40余项虚拟主机管理功能,全国领先!双线多线虚拟主机南北访问畅通无阻!免费赠送企业邮局,.CN域名,自助建站480元起,免费试用7天,满意再付款! P4主机租用799元/月.月付免压金!

级别: 初级

Martha Andrews
软件工程师, IBM
2005 年 6 月 13 日

当你应用设计模式时,你需要编写关于如何应用和使用模式的文档。设计模式的作者可以通过Eclipse在线帮助提供此类的文档描述。本文描述模式作者如何为他们的模式建立文档并把它作为IBM Rational Software Architect中的标准在线帮助中的一部分来显示。

介绍
IBM Rational Software Architect允许你为创建的模式生成帮助。这篇文章说明帮助生成功能,你可以使用该功能在Rational Software Architect的在线帮助里添加关于模式的文档。除此之外,本文还概述了在不使用帮助生成功能的情况下,添加文档的步骤。

本文提供给那些使用Rational Software Architect来建立模式库的Java 开发者。如果你对Eclipse 的在线帮助系统和帮助锚非常熟悉,它将对你有益。关于Rational Software Architect中的设计模式的信息,在产品中提供的在线帮助中可以查到。关于使用帮助系统开发在线帮助插件及使用锚,你可能从《Help -- Part 1: Contributing a Little Help (Revised for 2.0)》一文中找到有用的资料,它列于本文后面的 资源 一节中。

本文提及 Reusable Asset Specification (RAS),它为模式和模式程序库提供了一个标准的结构和组织。关于 RAS 和模式的更多信息,见Rational Software Architect在线帮助。

MyPatterns 项目
为了帮助描述在线帮助中的目录结构和生成的文件,本文引用一个项目实例。该项目是一个包含二个模式:Pattern1 和 Pattern2的模式库。每个模式有一个参数。

本文把重心集中在 PatternFiles 目录树中的文件。这些文件在模式设计期间,在包浏览器视图中是可见的。列表1显示,紧随项目的建立及模式添加之后的PatternFiles 目录结构:


				
			
PatternFiles/
	Pattern1/
		Pattern1.emx
		Pattern1.rmd
	Pattern2/
		Pattern2.emx
		Pattern2.rmd
	MyPatterns.rmd
列表 1. PatternFiles 目录结构

生成帮助文件
你可以从模式库的关联菜单启动生成帮助文件命令(在Pattern Authoring View视图中点击右键),来为模式库生成帮助。这将导致如下动作:

在生成帮助之后,目录 2显示 MyPatterns 的 PatternFiles 部分的内容:


				
PatternFiles/
	Pattern1/
		Pattern1.em
		Pattern1.rmd
		PatternHelp/
			Pattern1Description.html			
            Pattern1Overview.html
            Pattern1Parameters.html
			Pattern1ToC.xml
	Pattern2/
		Pattern2.emx
		Pattern2.rmd
		PatternHelp/
			Pattern2Description.html			
            Pattern2Overview.html
            Pattern2Parameters.html
			Pattern2ToC.xml
	PatternHelp/
		MyPatterns.html
		MyPatternsToC.xml
	MyPatterns.rmd
列表 2. PatternFiles 部分

正如你所见到的,生成帮助的过程建立了三个目录和多个文件。文章接下来的部分将详细解释每一个生成的文件。

模式库帮助内容文件
模式库帮助内容文件是一个HTML 文件,它包含来自库的 RAS 声明文件的信息。在例子项目中,MyPatterns.rmd 是模式库的 RAS 声明文件。

模式库帮助内容文件包含有一些信息,例如简短说明,版本,程序库的ID及库中的模式列表。帮助内容文件存储于PatternFiles目录下的PatternHelp目录中,并与库具有相同的名字。在例子项目中,MyPatterns.html 是模式库帮助文件。

模式库内容文件表
模式库内容文件表是一个以Eclipse中的 toc 格式存储的XML文件。该文件提供三种服务:

模式库内容文件表储存在 PatternHelp 目录中,而且它以模式的名字附加上 ToC.xml 作为名字。在你的例子项目中,模式库内容文件表是 MyPatternsToC.xml 。

因为目录表如此重要,让我们更深入地探讨。列表 3显示 MyPatternsToC.xml 文件的内容:


				







列表 3. MyPatternsToC.xml 文件

生成的模式库的内容文件表规定了一个为模式库命名的主题。模工库主题指向生成的模式库帮助内容文件。在模式库主题里面,目录表定义了它自己的锚点。

文章整理:西部数码--专业提供域名注册虚拟主机服务
http://www.west263.com
以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息,谢谢!