JR 在线源代码生成器

－－Java研究组织开源子项目

本文件将详细讲解如何运用本软件。包括如下内容：

下载
安装
运行
自定义模版

需要特别说明的是本软件是针对JDK1.4设计和开发的，因此需要使用符合JDK1.4及以上版本的JDK或者JRE。

本软件有两种版本的包可供下载：
二进制版本：已经包含了软件运行所需要的全部内容，所需要的类已经打包完毕。
源代码版本：包含了生成二进制版本所需的全部内容，需要用户使用ant工具编译生成二进制版本，也可以供研究源代码之用或者进行扩展。
要下载本软件的发布包，请到如下网址下载最新的版本：
https://gro.clinux.org/project/showfiles.php?group_id=318

安装

对于二进制版本：
将下载得到的二进制发布包解压缩以后就安装完毕了。

对于源代码版本：
需要使用ant工具进行编译。将下载得到的包解压缩以后进入解压后的主目录下，在命令行方式下（DOS或者Shell）里面输入ant即可（需要配置好ant的运行环境），正常情况下会生成java2html.jar运行包和本软件的API文档。

运行

要运行本软件生成在线源代码，请进入安装的主目录下在命令行方式下（DOS或者Shell）里面输入如下的命令：

java -jar [-Djava2html.code=code] [-Djava2html.debugable=false/true] java2html.jar sourceDir destDir [userPropertiesFile] [templatePath]

选项说明：

-Djava2html.code=code：可选参数，指定生成的HTML页面的编码方式，如果不指定则为gb2312。
-Djava2html.debugable=false/true：可选参数，指定是否输出调试信息，缺省为输出。
sourceDir：必须参数，指定源代码所在的目录。
destDir：必须参数，指定生成的HTML文件所在的目录。
userPropertiesFile：可选参数，指定用户自定义的模版属性的文件名。
templatePath：可选参数，指定用户自定义的模版的存放的路径。

自定义模版

对于有特殊需求的用户，也可以定制自己的模版，在模版中增加必要的内容，方法如下：
参考所带的templates目录里面文件，文件中具有##UPPCASE_STRING@@的内容就是动态变化的内容，已有的模版的内容不建议进行修改，只建议在原有模版的基础上增加内容。
需要注意的是一下的关键字是系统保留的：

时戳关键字：JTHSYSTEMTIMESTAMP
循环开始标记（必须独占一行）：
循环结束标记（必须独占一行）：
循环名称关键字：JTHLOOP$，请注意‘$’应该是一个数字，从0开始
循环次数关键字：JTHLOOPSIZE
以上内容都不得作为子定义模版的属性关键字。
在根据以上规则添加完自己的内容或者属性关键字以后可以设置这些动态内容的值，方法如下：
参照samples目录下的内容生成自定义的properties文件，形式是key=value。
假设想修改模版，那么将目录templates的文件拷贝到目录my_templates目录下，修改模版文件class.html中增加了一个属性：##COMPANY@@，如果这个值不是动态的，那么他可以直接修改模版文件，假设他想动态的设置，那么他需要生成一个properties文件，假设他想赋值为：某某公司，他可以生成一个文件：user_zh.txt，里面的内容为：
COMPANY=某某公司
由于是中文内容，需要先使用native2ascii工具转换为java可以识别的unicode码的转义序列：
native2ascii user_zh.txt user_zh.properties
然后可以进行软件的主目录运行如下命令使用模版和属性文件(my_templates目录和user_zh.properties都位于软件的主目录中)：

java -jar java2html.jar c:\projects\samples\src c:\projects\samples\html user_zh.properties my_templates