用HTML Help Workshop制作CHM帮助文档
一.准备工作
由于chm帮助文件是基于HTML文件特征的,所以前期编写HTML文件的准备工作很重要,本人使用的是微软的SharePoint Designer 2007编写HTML文件,在这过程中可以参考下(http://www.w3school.com.cn/)。
HTML Help Workshop的角色就像一个总管,以一个项目控制整个项目中的各类型文件,然后将各类型文件编译成独立的chm文件。它的每一个主题就是一个HTML文件,它的结构有点类似平常我们所见到的目录树,但是它的主题包括目录及文件。
二.制作chm文件
1.编写HTML文件。
2.创建项目文件
(1)打开HTML Help Workshop,选择File(文件)菜单下的New(新建)命令。弹出一个对话框,选择新建Project(方案)文件。
(2)在弹出的对话框中,直接点击“下一步”
(3)为新方案设计一个文件名。点击 Browse(浏览)按钮,设置希望保存的文件位置和文件名,注意扩展名是 .hhp。建议和那些网页文件保存在同一个文件夹中。
(4)接下来选择该帮助文件需要哪些素材。其中 HTML Files(网页文件)这一项必选。如果你希望给帮助文件建立一个目录表,那么可以选中 HTML Help table of contents(目录表)这一项。
(5)这里要你提供你已经有的目录表。因为我们尚未制作,所以直接点击“下一步”
(6)下面要提供该帮助文件所涵盖的所有网页文件。请单击 Add(添加)按钮,指定到刚才创建的目录下,选中所有的 HTML 网页文件添加进去。如果中间有误添加的项目,请选中该项目,然后单击 Remove(删除)即可。
(7)接下来我们可以看到该方案的内容了。左侧栏里有里面的详细内容。Options 栏中涵盖有该软件版本、编译成的帮助文件名、帮助文件的首页显示哪个网页、是否编译成功、语言等信息。Files 栏中含有该帮助文件所涵盖的所有网页文件。
在“Project”卷标的左侧按钮,它们的功能名称自上而下分别是:
“Change project options(改变项目选项)”
“Add/Remove topic files(添加/删除主题文件)”
“Add/Modify window definitions(添加/修改窗口定义)”
“HtmlHelp API information(HTML帮助API信息)”
“View HTML source(校验HTML源文件)”
“Save Project Contents and Index files(保存项目、目录和索引文件)”
“Save all file and Compile(保存全部文件并编译)”
(8)点击“Project”编辑窗口下方的“Change Project Options”按钮后,会弹出一个“Options”对话框。在这个对话框的“General”卷标的“Title”中输入标题,编译后这个标题将出现在chm文件窗口的标题栏中。在“File”卷标中选上“Automatically create contents file(.hhc) when compiling”。
chm文件的“Search(搜索)”选项允许用户在所有主题文件中搜索字、词或短语,将它们的标题显示出来,而且用醒目的方式显示在主题中。在“Compiler”卷标中选上“Compiler full-text search information”,即可支持全文检索功能。
3.创建目录文件
(1)编辑目录文件是制作chm文件的关键工作,点击HTML Help Workshop工作窗口的“Contents”卷标,这时系统弹出一个对话框,提示你“项目”还没有关联目录文件(.hhc),选择“Create a new contents file”,点击“OK”按钮后将创建一个新的目录文件。
(2)请指定一个新目录文件名和存放路径,点击“保存”后出现目录编辑窗口。
在“Content”卷标的左侧按钮,它们的功能名称自上而下分别是:
“Contents Properties(目录属性)”
“Insert a heading(插入大标题)”
“Insert a page(插入页面)”
“Edit selection(编辑页面或大标题)”
“Delete selection(删除页面或大标题)”
“Move selection up(上移页面或大标题)”
“Move selection down(下移页面或大标题)”
“Move selection right(右移页面或大标题,右移一级则表示下级)”
“Move selection left(左移页面或大标题,左移一级则表示上级)”
(3)根据需要插入标题(类似资源管理器中的目录)或页面(类似资源管理器中某目录下的文件),按下“Insert a heading(插入标题)”或“Insert a page(插入页面)”按钮,都会弹出“Table of Contents Entry”对话框,在“Entry title”输入框中输入条目的标题,并根据情况选定对应的主题文件,单击“Entry title”下的“Add”按钮,在弹出的对话框下面的“File or URL”输入框中输入文件名或URL地址并确定。
标题可以分为多级,要按照制作的内容统一考虑。如果觉得不满意,可以用左侧的箭头进行调整,也可以选定该条目,单击鼠标右键,不但可以调整,还可以插入标题、主题或目录文件。
4.创建索引文件
索引文件(.hhk)也是一个HTML文件,它包含若干个关键词,当用户打开chm文件后,单击索引标签并输入一个关键词后,chm文件将显示与这个关键词有关的主题的列表,使大家非常方便地找到相关主题。
(1)点击HTML Help Workshop工作窗口的“Index”卷标,这时系统弹出一个对话框,提示你“项目”还没有关联索引文件(.hhk),选择“Create a new contents file”,点击“OK”按钮后将创建一个新的索引文件。
(2)请指定一个新索引文件名和存放路径,点击“保存”后出现索引编辑窗口。
(3)单击“Insert a keyWord”按钮,出现“Index Entry”对话框,在“General”选项的“KeyWord”输入框中输入关键词,再单击“Add”按钮添加与该关键词相关联的主题文件。
5.编译生成chm帮助文件:File->Compile...。