Java CHM格式的API帮助文档的制作详解

1.1Java CHM格式的API帮助文档的制作详解
1、*.chm格式的帮助
Visual Studio 6.0和Windows 98的帮助文件风格，和以前的版本大不一样，这种被微软称为下一代的在线帮助（next－generation online help）形式，是一种编译过的HTML文件，后缀是.CHM。

它不仅制作容易，而且支持超文本的全部语法特征，换句话说，只要是你能在主页上制作出来的效果，几乎都可以在这种形式的帮助文件中体现出来。

原来的软件大多数采用扩展名为HLP的帮助文件（WinHelp ），但随着互联网的发展，这种格式的帮助文件已经难以适应软件在线帮助的需要，以及更加人性化更加简单易于查看的需要，因此一种全新的帮助文件系统HTML Help由微软率先在Windows98中使用了。

由于它是一个经过压缩的网页集合，不但减小了文件的体积，更利于用户从INTERNET上下载，并且还支持HTML、Ac－tiveX、Java、JScript、Visual Basic Scripting 和多种图像格式(.jpeg、.gif 和.png 等)，因此很快受到广大软件作者和软件用户的欢迎。

2、Microsoft HTML Help Workshop
制作这种形式的帮助文件，需要使用Microsoft HTML Help Workshop编译你已经写好的超文本文件。

它完全安装后只有4.6M，包括两组工具集：HTML Help Workshop和HTML Help Image Editor。

后者在网页制作中常用到图形文件的编辑和修改。

要建立CHM帮助文件必须先将我们所有想要让其出现在帮助文件中的内容做成相对独立的网页文件（即HTML文件），这些工作可以在HTML Help Workshop中完成，也可以应用其他网页编辑器（如FontPage或HotDog）来制作。

3、帮助文件中所要用到的各个文件：
（1）.hhp文件：
这是最常用的一类文件，它实际上是“HTML Help project”的缩写，表示HTML帮助文件项目，它是生成CHM文件最直接用到的一类文件，只需要有一个hhp文件就可以根据它来编译相应的CHM文件。

它是“HTML Help table of contents”的缩写，表示的是HTML帮助文件的目录，通常我们在CHM文件浏览器的左边窗口中看到的目录内容就由它来提供，当然，它并不能直接被编译成CHM文件，而先要集成到某一hhp文件中才能发挥作用。

（3）.hhk文件：
它是“HTML Help Index Keyword”的缩写，为我们提供了CHM文件的关键字索引查询功能，也是一个易于查看的帮助文件不可缺少的一部分，同hhc文件一样，它也不能直接编译生成相应的CHM文件。

（4）.html文件：
帮助的内容文件
4、建立工程文件
工程文件是项目的管理文件，它用来保存你的工作环境及相关设置。

（1）新建一个工程项目文件：File New --->选择Project类型，并指定项目文件所在的文件路径。

注意：
向导的首页告诉我们，它可以用于制作老式帮助文档的文件（后缀为.RTF、.CNT等），
并且统统转换成新式的HTML Help Workshop所使用的文件格式，如果你需要这样的转换，就选中“Convert WinHelp Project”前的复选框。

否则进入下一步，指定需要制作帮助文档的工程文件的名称和位置。

（2）然后选择Browse按钮，并且指定项目文件名。

（3）按下一步按钮，并且一直按下一步按钮。

最后完成。

完成上述工作后，向导询问你是否有后缀为.hhc（HTML格式帮助文档的目录文件）、.hhk （HTML格式帮助文档的索引文件）和.htm文件需要添加进当前的工程。

作为一个新建的工程文件，这些可以统统不必理会，我们直接进下一步，完成新建工程的工作
（4）生成项目文件的内容
5、添加Topic超文本文件（各个标题所要对应的*.html文件）
在上图所示的界面中，用鼠标点“Add/Remove topic files”，将本帮助中所要涉及到的各个标题所要对应的*.html文件添加到工程文件中。

1)用“Add”向当前的工程中添加已经编辑好的HTML文件；
2)“Remove”将不需要的HTML文件从当前工程中删除。

3)若是用鼠标点击上图中的“Save all project files and compile”按钮对当前工程保存并进
行编译的话，即可生成一个后缀是.CHM的帮助文件，此时，可以通过工具条上的“View complied file”查看文件编译后的效果。

4)尽管已加入的HTML文件能看到了，但令人遗憾的是这个帮助文件既没有目录，也
没有索引，是个丑小鸭。

6、制作帮助文件的目录
注意：
（1）在上图所示界面的选项卡中，切换到“Content”，在随即弹出的对话框中选“Create a new contents file”，然后指定一个文件名，或者选择一个现有的目录文件名（比如为TableContents.hhc），将目录管理文件保存。

然后出现下图，添加各个目录条目。

（2）如果未制作出目录文件，可以采用如下的步骤来插入一个目录项目（单击insert a heading按钮），并给出该目录标题项目文字及对应该目录项目的*.html文件名。

（3）再在该目录标题项目下，插入其下的帮助条目（选择insert a Page按钮），并给出该帮
助条目文字及对应该帮助条目的*.html文件名。

（4）最后露出下图所示界面：
注意：
1)在左侧的工具条中，点“Insert a heading”，向当前的工程中插入一个主题，给它起上
一个恰当的名字后，就可以将属于这个主题的HTML文件，用“Insert a page”依次插入到当前的主题下。

2)用工具条上的“↑”、“↓”两个按钮可以调整各个页面在主题下出现的次序，“←”、“→”
两个按钮可以调整目录的层次结构。

7、制作帮助文件的索引
使用索引的目的是通过关键词迅速定位到需要的文章。

在前面的图中所示界面的选项卡中，切换到“Index”，在随即弹出的对话框中选“Create a new index file”，然后指定一个文件名，或者选择一个现有的Index文件名（比如为
TableContents.hhk），将索引管理文件保存。

如果未制作出Index文件，可以采用如下的步骤：
在左侧的工具条上用“Insert a keyword”插入事先选定的关键词，并且要指定在帮助的工程文件中包含它的HTML文件名称，以便将来用户能通过该关键词迅速定位到这个文件，找他所需要的内容。

关键词可以一个一个地插入，也可以一组一组地插入。

制作索引文件的工作界面与“制作帮助文件的目录”基本一致，工具条按钮也大致对应相同，但是多了对关键词排序和察看超文本的源文件这两项功能。

8、制作帮助文件的搜索
这里的搜索是指按字符串的匹配形式，在工程中已包含的HTML文件中查找出相等的值，
并突出显示出来。

让帮助文件具有搜索功能，需要切换回“Project”项（前面上图），点左侧工具条上的“Change project options”，在随即弹出的“Options”对话框的“Compiler”项下，选中“Compile full－text
search information”前的复选框。

9、修改并设置项目文件的属性
（1）在Project标签页内，选择“change project option”按钮，弹出如下的对话框。

（2）在Title栏中输入项目的标题文字及Default File（帮助的初始内容default.html）、Default Window（如：）
（3）在Project标签页内，选择“Add/Modify Window Definitions”按钮，弹出如下的对话框。

并输入窗口的名称。

（4）在窗口的类型对话框内，对将要生成的帮助窗口的属性进行设置。

先设置General页的内容。

再选择Buttons页面，选择您的帮助窗口内的各个按钮控件的类型，为达到如下的效果：
应该进行如下的设置
在Files页面中，选择您的帮助窗口内的各个文件（注意：在Home栏中可以输入网站的URL 地址）
然后在Navigation Pane页面中，为达到如下的效果：
应该设置如下的项目
然后在Styles页面中，为达到如下的效果，选择您的帮助窗口的风格。

然后在Extended Styles页面中，选择您的帮助窗口的扩充风格（全部不选中）。

10、编译Help
选择“文件”菜单中的“Compile”，进行编译。

在当前的帮助文件所在的磁盘目录下，将自动出现一个*.chm的文件。