HTML Help workshop学习.docx

1、HTML Help workshop学习阅读目录一、前言二、使用HtmlHelp Workshop创建工程三、创建目录四、创建索引和关键字五、编译生成CHM帮助文件六、在应用程序中启动帮助七、小结前言联机帮助系统是任何一个完备的应用软件所不可缺少的重要组成部分，一个好的联机帮助系统可以使用户在软件使用过程中能够迅速掌握软件的操作、使用方法。为了使开发的软件具有专业水准，就必须考虑为软件制作一个新颖、实用的联机帮助系统。本文将要介绍的chm格式的HtmlHelp联机帮助系统即是一个不错的选择。图1 MSDN联机帮助HtmlHelp联机帮助系统在Windows 98中首次出现，这种联机帮助系统是微

2、软公司推出的下一代联机帮助系统，使用编译过的HTML文件作为联机帮助文件。该联机帮助系统不仅提供了传统的WinHelp联机帮助系统的许多特征，而且还提供了超文本连接、目录、索引以及全文检索等功能，并使用Microsoft Internet Explorer的基础组件来显示帮助内容，可以支持HTML、ActiveX、Java、脚本（Java 脚本和Microsoft Visual Basic脚本）以及HTML图像格式（.jpeg、.gif、.png）等。通过HtmlHelp联机帮助系统将可以象浏览网页一样很方便的查找到需要的信息。Visual C+使用的MSDN联机帮助（如图1所示）即是一个非常

3、典型的HtmlHelp联机帮助系统。标准的HtmlHelp帮助文件主框架窗口由位于框架上方的工具条、位于框架左侧的包含有目录、索引以及搜索等选项卡的浏览窗口和位于窗口右侧的用于显示相应主题内容的视图构成。HtmlHelp帮助文件的扩展名也由Winhelp的.hlp变为.chm，开发工具也从Help Workshop换为HtmlHelp Workshop（尽管VC仍然提供传统的Help Workshop）。在安装VC时，HtmlHelp Workshop工具并不会被一同安装，但是在安装盘中的HtlmHelp目录下可以找到该工具的软件安装包。也可以从微软官方网站得到最新版本，其网址为：在安装成功后

4、，通过HtmlHelp Workshop工具即可很方便的开发HtmlHelp帮助系统的CHM帮助文件了。HtmlHelp帮助系统是基于HTML文件及其相关图像、脚本等文件的，CHM帮助文件中包含有若干纯HTML格式的主题文件，每一个主题文件都表示帮助系统中的一个主题。由于HtmlHelp帮助系统是基于HTML格式的各主题文件的，因此在建立帮助系统工程之前需要对各部分的帮助内容进行规划，这主要包括对目录结构的设计、帮助内容的主题划分以及HTML文件的制作等。使用HtmlHelp Workshop创建工程图2 新建工程启动HtmlHelp Workshop后通过File菜单下的New菜单项将弹出图

5、2所示的对话框。列表框中给出了要建立的文件类型，分别为工程文件、文本文件、HTML文件、目录文件和索引文件。这里选取Project，以建立一个工程文件。系统将会显示如图3所示的新建工程向导，并询问是否需要转换现有的WinHelp工程。这里直接点击下一步以新建一个工程，向导将进入到图4所示的对话框以指定要建立的工程文件。建立的工程文件以hhp为后缀，用于管理组成帮助文档的所有文件，它包含了帮助系统中所有源文件的名字和位置以及其它有关帮助系统定义和选项的设置信息。图3 新建工程向导图4 创建工程文件图5 引入已存在的文件向导的下一步如图5所示，询问是否将现有的目录文件（.hhc）、索引文件（.hh

6、k）或主题文件（.htm）添加到工程。如果选中某种文件就要指出这些文件的名字及存放路径。如果不添加，也可以在建立了工程后再行添加。最后，在图6所示的对话框结束向导并创建一个新的工程。向导将自动加上必要的工程文件设置（如图7所示），这些设置都可以在项目选项对话框中修改。左侧这三个选项卡分别用来对工程文件、目录文件和索引文件进行设置和编辑，在每个选项卡的左侧均列有与之相关的工具按钮。图6 完成向导图7 项目选项对话框点击改变工程选项按钮，将弹出如图8所示的工程选项设置对话框。General选项卡将可以设置帮助系统的标题（Title编辑框）、在运行时显示的默认主题文件（Default File编辑框

7、）以及将要显示在哪个窗口（Default window编辑框）。Files选项卡（如图9所示）主要用来描述编译的帮助文件、目录文件和索引文件。如果在HtmlHelp Workshop中创建了目录文件和索引文件，那么这些文件将会自动添加到相应的位置。其中目录文件能够在编译时自动生成，但需要经过修改才能够使用。Compiler选项卡（如图10所示）用于设置与文件编译相关的信息，如显示编译过程、支持增强反编译等。Merge Files选项卡则只是提供了对文件合并的设置。图8工程选项设置对话框图9 文件选项卡图10 编译选项卡图11 窗口类型设置对话框点击添加/修改窗口定义按钮将弹出如图11所示的配置

8、对话框，通过该对话框提供的7个选项卡将可以定义CHM帮助文件的窗口显示风格。General选项卡定义了窗口名和窗口标题。也可以增加新的窗口或删除已有的窗口定义。Buttons选项卡负责定制将要显示在帮助文件工具条上的按钮。Position选项卡对窗口大小和位置进行定制，可以直接输入定制数值，也可以使用Autosizer按钮启动一个用来设置窗口位置和大小的对话框，并通过拖动此对话框窗口来完成上述定制。Files选项卡通过TOC、Index、Default、Home、Jump1和Jump2等项定义了帮助窗口的目录文件名、索引文件名、默认显示的文件名、主页文件名以及跳转页文件名。Navigation

9、 Pane选项卡对左侧浏览窗口的特性进行了定制，主要包括以下几个方面的设置：窗口是否包含浏览窗格、主题窗格和按钮条；浏览窗格的宽度；是否自动显示/隐藏浏览窗格；显示时默认的浏览选项卡（Default tab选项）；是否包含搜索（高级搜索）选项卡（Advanced选项）和书签选项卡（Favorites tab选项）等。 最后两个选项卡Styles和Extended Styles用于设置窗口的风格和扩展风格。在这两个选项卡中可以指定窗口是否包含最大化、最小化按钮，是否有边界，是否包含水平和垂直滚动条，是不是弹出式窗口或工具窗口等等。 总之，图11所示的配置对话框定制了帮助窗口的所有外部显示特性。图

10、12 主题文件的添加点击增加/删除主题文件按钮，将弹出如图A1-12所示的增加/删除主题文件窗口。通过该窗口上的Add按钮将可以向工程添加有关帮助实质性内容的各主题文件。在Topic files列表框中显示了当前包含的所有主题文件，也可以通过Remove按钮从中删除已有的主题文件。创建目录HtmlHelp联机帮助系统通过目录文件对其所有的主题文件进行组织管理，一个设计良好的目录结构将可以使用户能够快速检索到相关的帮助主题。在HtmlHelp Workshop左侧选项卡窗口中点击Contents选项卡，将弹出图13所示的提示对话框以询问是创建一个新的目录文件还是打开一个已经存在的目录文件：图13

11、 提示建立目录文件图14 目录属性设置在建立目录文件后，可以在Contents选项卡对目录文件进行定制。图14对该选项卡工具栏中的各按钮做了说明。点击目录属性按钮将弹出图14所示的目录属性设置对话框。HtmlHelp Workshop为帮助系统目录的显示格式提供了默认的设置，可以通过改变目录属性来定制目录的显示格式。但通常多直接使用系统的默认设置。Styles选项卡定义了目录显示的风格，可以通过Add/Remove按钮添加或删除相应的风格属性设置。可以通过该设置来指定是否在目录项左侧显示+/-方框、是否在目录项之间画线、是否自动跟踪目录项选择等。Information Types选项卡则主要是

12、在为不同层次的用户设计帮助系统时使用的。目录文件根据帮助系统的内容，按照层次关系将各主题内容以树型结构组织起来。目录文件定义的内容和组织结构将显示在帮助系统左侧的目录窗格中，共包含标题项、和主题项这两种类型的目录项。目录项可以包含子目录项和主题项，既可以与一个主题文件相关联，也可以不关联任何主题文件；而主题项则表示了某主题的具体帮助内容，必须与一个主题文件或URL地址相关联。在运行编译产生的CHM帮助文件时，点击目录选项卡中的主题项目，在右侧视图窗格将显示相应的主题帮助内容。图15 向目录添加标题项或主题项点击插入目录项或插入主题项按钮均会弹出如图15所示的目录项入口对话框。通过该对话框将可以

13、向目录文件添加目录项或主题项的目录项目入口。在Enttry Title编辑框中输入目录项/主题项的名称，并通过下面的Add、Edit或Remove按钮添加、编辑或删除与该入口项相关联的主题文件或URL地址。如果在添加或编辑主题项时未指定与其关联的主题文件或URL地址。系统将会弹出一个对话框以提示用户。该对话框的Advance选项卡对目录项/主题项所显示的窗口名、框架名等进行了定义，也可以通过更改Image Index的值来改变显示在目录项左侧的图标。在添加项目时该选项是禁用的，只有在用编辑按钮打开项目时才可以更改。在目录项/主题项添加到目录文件后，可以选择某一项并对其进行编辑或删除。还可以通过

14、上移、下移、左移、右移这四个按钮来可以插入的项目在目录结构中的层次及上下位置。双击目录项或点击察看HTML源文件时，与该目录项关联的主题文件的HTML源代码将显示在右侧的编辑视图，并可以对其进行编辑创建索引和关键字索引文件定义了帮助系统中所包含的关键字，通常是帮助系统中所涉及到的术语、概念以及其他一些重要词汇等。与目录文件一样，索引文件的设计好坏也极大影响了用户能否快速查找到所需要的帮助主题。在未创建索引文件时点击Index选项卡，将会弹出如图16所示的对话框，以提示用户新建一个索引文件或是打开一个已经存在的索引文件：图16 提示建立索引文件在创建了索引文件后可以通过索引选项卡提供的工具栏来定

15、制其属性或插入、编辑索引项。图17对工具栏各按钮进行了说明，这些工具用于对关键字的定义和修改，多数按钮功能与目录文件工具按钮相同。点击属性索引按钮将弹出图17所示的属性设置对话框。该对话框所提供的属性设置选项较少，只对帮助索引显示的默认框架、窗口以及显示字体等进行了设定，通常也多采用默认设置。与目录属性设置一样，这里的Information Types选项卡也是在为不同层次的用户设计帮助系统时使用的。图17 索引属性设置对话框图18 索引关键字的添加建立、编辑索引文件的过程与处理目录文件的过程非常类似。其要插入的项目只有关键字一项，定义的关键字将显示在帮助系统的索引选项卡中。每个关键字必须至少

16、与一个主题文件或URL地址相关联，并允许与多个主题文件或URL地址关联，在双击关键字时帮助系统将弹出一个显示了所有与该关键字相关联主题的对话框，可以从中选择一个主题，其主题内容将显示在右侧视图。点击插入关键字按钮将会弹出如图18所示的索引入口对话框。与目录文件中项目的添加类似，在Keyword编辑框中输入关键字的名称，并通过下面的Add、Edit和Remove按钮添加、编辑和删除与关键字相关联的主题文件或URL地址。索引关键字必须至少与一个主题文件相连接，否则系统将弹出错误提示信息。如果多个主题文件都包含相同的关键字，那么就应当把这些主题文件都加入到该关键字的连接中，建立一个关键字与多个主题文

17、件的关联。如果两个不同的关键字具有相同的意义，也可以设置从一个关键字跳到另一个关键字，而只在一个关键字建立到主题文件的关联。对于这种情况，除了用上述方法添加了要跳转到的关键字的名称外，还要在Advanced选项卡中选中Target is another keyword选项。在将关键字添加到索引文件后，可以对选项进行编辑或删除。也可以象处理目录文件一样利用上移、下移、左移或右移按钮来改变关键字在索引选项卡中的层次与上下位置。双击关键字或点击察看HTML源文件按钮，将在右侧编辑框显示与之关联的主题文件的HTML源代码，并可以对其进行编辑。编译生成CHM帮助文件前面已经创建完成了帮助系统所必须的工程

18、文件、目录文件以及索引文件的创建，并完成了相应的配置设置。但是由于在创建工程文件时目录文件与索引文件尚未创建，因此在创建完目录文件和索引文件后还要再回到工程文件进行设置，以将上述两文件添加到工程文件。在Project选项卡中，点击添加/修改窗口定义按钮，并在弹出的图19所示的对话框中选择Files选项卡。在其TOC、Index以及Default等组合框的下拉列表中选取要添加的目录文件、索引文件以及缺省显示页等文件。如果建立的帮助文档添加有主页和跳转按钮那么还要设置Home和Jump1、Jump2这几个项目相关的主题文件。在File菜单下提供了Compile、Decompile菜单项将可以编译、

19、反编译CHM帮助文件，并可以通过View菜单下的Compiled Help File菜单项查看编译产生的CHM帮助文件。通过HtmlHelp Workshop提供的反编译功能还可以将编译过的CHM帮助文件还原为原来组成帮助系统的各部分源文件如HTML文件、图像文件、目录文件和索引文件等。图20给出了编译后的CHM帮助文件的窗口界面。其中，搜索和书签选项卡用户只需在设置属性时指定即可而不需要象目录文件和索引文件一样对其进行设计。图19 为工程文件指定目录文件与索引文件图20 编译产生的CHM帮助文件在应用程序中启动帮助如果当前系统安装了HtmlHelp阅读器Hh.exe，就可以直接运行HtmlH

20、elp Workshop制作的CHM帮助文件了（通常，Windows系统就已经安装有Hh.exe）。在资源管理器中，双击编译过的CHM文件就可以运行此帮助文件。这里将要介绍如何在应用程序中启动CHM文件。在应用程序中对CHM帮助文件的调用由HtmlHelp API函数HtmlHelp（）来完成，由HtmlHelp.dll动态链接库提供。为了能够在程序中使用该函数，需要将htmlhelp.lib、htmlhelp.h等文件加入到工程。可在VC的Project菜单下的Setting菜单项所启动的设置对话框中对其进行配置。图21 设置HtmlHelp.h文件的路径首先，在C/C+选项页中设置要包含的

21、HtmlHelp.h头文件的存放路径。在Category中选取Preprocessor选项后，将出现如图21所示的参数设置界面，在Additional include directories编辑框中输入HtmlHelp.h头文件的存放路径。然后再到Link选项页中对要包含的Lib库进行设置。先在Category中选取Input，将出现如图22所示的参数设置界面。在其Additional library path编辑框中输入要包含的HtmlHelp.lib库文件的存放路径。在完成上述两步路径设置后就可以添加HtmlHelp.h头文件和HtmlHelp.lib库文件到工程了。HtmlHelp.h头

22、文件的添加非常简单，只需在工程的stdafx.h最后一个#include语句后面添加一条#include htmlhelp.h即可。对于HtmlHelp.lib库文件的添加，仍是在Link选项卡中进行，将Category该回到General，并在图23所示的界面中，在Object/libraries module编辑框中添加HtmlHelp.lib即可。完成上述设置的对话框将可以直接使用HtmlHelp（）函数。该函数原形为：HWND HtmlHelp(HWND hwndCaller, LPCSTR pszFile, UINT uCommand, DWORD dwData);参数hwndCal

23、ler为调用HtmlHelp（）的窗口句柄，pszFile为文件、URL或是经过编译的HTML文件的路径，uCommand指定了要执行的动作，dwData为uCommand所需要的参数。图22 设置HtmlHelp.lib库的路径图23 加入HtmlHelp.lib库文件对于CHM帮助文件的启动，应将uCommand参数设置为HH_DISPLAY_TOPIC，这时dwData可以为0或是一个指向CHM帮助文件的指针。如果需要在启动CHM帮助文件时显示特定的帮助页面，可以在pszFile所指向的CHM帮助文件存放路径后添加带有:前缀的页面名称。例如，下面这段代码将在程序中启动编译过的CHM帮助文

24、件，并显示其中的a.htm页面：/ 得到可CHM文件的路径char exeFullPathMAX_PATH;CString strPath;GetModuleFileName(NULL, exeFullPath, MAX_PATH);strPath = CString(exeFullPath);strPath = strPath.Left(strPath.ReverseFind();strPath += Sample72.chm;/ 设置显示的初始页面strPath += :a.htm;char cCommandLineMAX_PATH;:strcpy(cCommandLine, strPath);/ 显示CHM帮助文件HtmlHelp(GetSafeHwnd(), cCommandLine, HH_DISPLAY_TOPIC, 0);小结本文较为全面的对HtmlHelp联机帮助系统的制作、编译以及在应用程序中的调用做了介绍。通过本文所述方法将能够制作出一个初具专业水准的帮助系统。HtmlHelp Workshop工具除了可以制作软件的帮助系统外，还可以用其来制作.chm格式的电子图书。与制作帮助系统一样，其关键仍是对内容的组织与编排。