帮助文档的创建及调用

黄伟兵+麻小梅

摘要：一个完整的管理系统，必须有一个科学易用的帮助系统。如何创建软件系统的帮助文档？在程序中如何调用帮助文档呢？

关键词：帮助文档；创建；调用

一个完整的管理系统在开发完成后，需要创建帮助文档，让用户快速上手熟悉使用该系统，或通过帮助文档解决使用过程中碰到问题。高中信息技术学业水平考试系统的开发是我们承担南宁市教科所“十三五”的课题，下面结合课题的研究，说一说系统的帮助文档的创建及调用方法。

一、截图

要想做好帮助文档，首先是把使用软件系统过程的步骤记录下来，并把使用软件的窗口通过截图软件截图下来，通过文字和图片进行说明。截图软件有很多好工具，比如Faststone Capture、QQ截图等等，我们使用Faststone Capture，该工具只有6.6M，小巧易用，运行后界面如图，图中各按钮（从左到右）的作用：捕获活动窗口、捕获窗口/对象、捕获矩形区域、捕获手绘区域、捕获全屏、捕获滚动窗口、屏幕录像机、输出→到编辑器、设置。指向工具按钮稍停一会，就显示其快捷键，使用快捷键更方便。把截好的图片按系统的功能模块有规律的命名，方便以后创建帮助文档使用。还可以根据功能模块，建立对应的文件夹来存放截图。

二、设计网页文件

EasyCHM帮助文档制作软件支持两种文件类型，一个是文本文件，另一个是网页文件，文本文件不能存放图片，直观性差。因此我们使用网页文件的格式来制作帮助文件的源文件。根据系统的功能模块来规划帮助文件，创建对应网页文件。高中信息技术学业水平考试系统的帮助文档分三个大的模块，分别是安装SQL Server 2005、配置SQL Server2005及附加数据库、高中信息技术学业水平考试系统的使用。后者还细分为注册控件、考生管理等12个功能模块。创建网页文件使用的软件有很多，大家可以根据个人熟悉、爱好来选择。使用Word或WPS就可以创建网页文件，不需要花时间去学习新的软件，节省了大量的时间。只需要利用文字处理软件根据各功能模块及使用的步骤输入文字、插入图片及符号，保存文件的时候文件类型选择“单个网面文件（*.mht）”。

三、创建帮助文件

助文件制作工具有 WinCHM、Easy CHM等等，以EasyCHM为例说明本系统创建帮助文件的方法。

1.下载安装EasyCHM Easy CHM版本很多，目前最新版3.93，我们使用的版本是3.84，软件小巧玲珑，简单易用。下载好后，直接在安装包里双击安装文件，根据向导操作即可完成安装。

2.创建帮助文件

运行Easy CHM，点击“新建”按钮或点击“文件”菜单再点击“新建”，选择“工程目录”，再点击“确定”。选择的工程目录就是前面建立的“系统帮助”文件夹。见下图：

从图中可以知道目录顺序不对，可以使用左侧的工具调整，利用“”把高中信息技术学考管理系统的使用调到最后。对应的就是上移了。这两工具是左移、右移，相當于word中的目录大纲中的升级和降级。是添加目录项，如果事先没有按照帮助文档的功能模块建立文件夹并分类存放网页文件，可以利用添加目录项工具添加帮助文档的第一级目录项，点击此按钮后，输入目录名称就可以了。然后右击此目录项，指向“导入”，单击“导入文件”，找到要导入的文件并选择，单击“打开”，即可导入网页文件。在编辑过程中注意点击“保存”按钮保存工程文件，预防意外。编辑好目录项后，就可以编译生成CHM帮助文件了。点击“编译”按钮，弹出对话框，根据实际情况可以修改调整，也可以使用默认值，最后点击“生成CHM”按钮，稍等片刻即可生成CHM帮助文件。

四、在软件中调用帮助文件

我们采用的编程语言是VB，在VB调用CHM文件步骤如下：

1.为应用程序设置帮助文件：在“工程属性”对话框中添加帮助文件名。帮助文件最好放在工程所在的文件夹。

2.在调用帮助文件的窗体的通用过程中加入如下代码：

Private Declare Function HtmlHelpA Lib "hhctrl.ocx" （ByVal hwndCaller As Long， ByVal pszFile As String， ByVal uCommand As Long， ByVal dwData As Long） As Long

Const HH_DISPLAY_TOPIC = &H0：Const HH_DISPLAY_INDEX = &H2

Const HH_HELP_CONTEXT = &HF

Const HH_DISPLAY_SEARCH = &H3

Const HH_DISPLAY_TEXT_POPUP = &HE

3.添加一个“命令按钮”，caption属性设置为“帮助文件”，命令按钮的代码如下：

HtmlHelpA Form1.hWnd， App.Path & "＼系统帮助.CHM"， 0， 0

系统帮助.CHM为CHM文件名，请根据自己的帮助文件名自行修改。

制作系统的帮助文件不是难事，简单概括如下：截图→创建网页文件→创建CHM文件→在VB中调用CHM文件。要制作一个科学易懂的帮助文件，需要科学规划和耐心细致的工作。

（作者单位：广西横县横州中学 530300）