如何创建Windows 95应用程序的帮助系统

如何创建Windows 95应用程序的帮助系统

尹章儒

对于一个成熟的应用程序系统来说，方便详尽的帮助系统是必不可少的。特别是当今流行的Windows 95 环境下的图形样式帮助系统中可以包含图形、经过格式化编排的文本、声音和动画等，为应用程序增色不少（如图一所示）。

0301135.gif (10574 bytes)

在Windows 95 环境下，利用Visual Foxpro 提供的Microsoft Help Workshop 工具，可以创建功能较为完善的应用程序帮助系统。

创建Windows 95 下的帮助系统时首先应该明确以下几个概念：

（1）帮助主题：帮助主题是指帮助窗口中的信息，它通常是以标题开始且包含某一特定任务、命令或对话框的信息。Help 由一个个“ 主题” 串接而成，每个主题可由标题、主题标识字符串、浏览顺序号来识别。

（2）标题：标题可由带空格的多个单词组成，具有描述性的文字，通常以“ 主题” 中的首行作为标题。不同的主题应有不同的标题，如果出现多个主题共同拥有一个标题，系统将会发出警告。

（3）主题标识字符串：主题标识字符串是唯一用来确定主题的字符串，它只能由字母、数字或下划线组成。

（4）关键词：在生成的Help 文件中可以根据关键词来搜索并转到相应的主题上。

（5）浏览顺序号：浏览顺序号用在制作上下文敏感的Help 文件中，它与主题标识字符串一样不能重复。

创建帮助系统的步骤如下：

（1）编辑帮助主题文件（扩展名为.RTF)。内有具体帮助信息以及所需的各种编码，可由一个或多个文件组成。

（2）编辑帮助项目文件( 扩展名名为.HPJ)。内有对主题文件进行编译所需的信息。

（3）编辑帮助目录文件( 扩展名为.CNT)。内有帮助的目录框架信息。

（4）编译生成帮助文件( 扩展名为.HLP)。内有系统所需的各种帮助信息。

（5）在应用程序( 如VB、VFP 或其他高级程序设计语言) 中编写代码调用帮助系统(WinHelp)，提供帮助信息。

一、编辑帮助主题文件

１、建立RTF 格式文件
通常用Word 来创建RTF 文件，文件中可以包含文本、位图或图元文件，甚至声音、动画等。其中应注意两点：① 一个主题结束后应插入一个分页符，作为主题间的分界；② 整个主题文件编辑完成之后，保存时，在“ 文件类型” 列表框中应选择RTF( Rich Text Format)，这时文件以.RTF 为扩展名存盘，以供帮助编译器使用。

２、设置脚注
将光标移至主题的最左边，选择菜单中的“ 插入／脚注和尾注”，选择“ 脚注”，在“ 定制脚注标记” 中输入脚注符号，然后回车，这时激活脚注窗口，输入脚注内容。不同的脚注符号代表不同的含义，常见的脚注含义及其符号如表1 所示:

表1 常见脚注含义及其说明
脚注含义符号说明
主题标识字符串＃定义一个用来识别主题的标识字符串。标识字符串要求必须定义，而且唯一，不能为汉字，可以包括字母、数字、标点符号等，不能超过256 个字符。
标题＄指明一个主题的标题名。主题名可以使用汉字。它将出现在帮助系统中的“ 查找”、“ 书签” 和“ 历史窗口” 对话框中。
关键字Ｋ为主题建立一个索引条目。每个主题可以有一个或多个关键字，关键字之间用分号隔开，关键字中不能使用分号，可使用汉字，一个关键字的最大长度255 个字符(127 个汉字)。
浏览顺序号＋指定浏览顺序号，以便用户可以通过按钮“》” 和“《” 浏览标题。浏览顺序号由数字和字母组成，编译时以ASCII 码顺序排序。使用数字时只能使用等长的数字，排序时才能得到预想的效果。如号码的最多位数为3，则5 应写成005，15 应写成015。
另外，还有其他脚注。注意：在所有的脚注中，主题标识字符串(＃) 是必须需要的，其他脚注可根据实际情况选用。

３、设置热点，建立主题之间的连接

帮助主题中另外的重要的编码是为文本指定“ 热点”，即用鼠标单击“ 热点” 可跳转到相应主题或弹出说明窗口，对“ 热点” 处的文本加以帮助。前者称为“ 跳转(Jump) 热点”，表现为绿色单下划线形式；后者称为“ 弹出(Popup) 热点”，表现为绿色单下点划线形式。

指定跳转热点：跳转热点在帮助主题文件中是带双下划线的文本。首先选择字符的双下划线格式，键入跳转热点文本，清除双下划线格式，选择隐藏文本格式，键入跳转目的地处的主题标识字符串。清除隐藏文本格式后再键入其他正文。注意，在隐藏文本后换行时，一定要先清除隐藏文本格式，然后再按回车键。

指定弹出热点：弹出热点在帮助主题文件中是单下划线的文本。首先选择字符的单下划线格式，键入弹出热点文本，清除单下划线格式，选择隐藏文本格式，键入在弹出的附加说明的主题的主题标识字符串。清除隐藏文本格式后再键入其他正文。同样，在隐藏文本后换行时，一定要先清除隐藏文本格式，然后再按回车键。

以上两种热点文本均可带有格式，如字体、字号和不同的风格（黑体或斜体）在隐藏文本和带下划线（单或双）文本间不能有空格。隐藏文本在显示出来时（选择Word 工具栏上的“ 隐藏／显示” 按钮高亮时，隐藏文本可显示出来）为带点划线的正文。

除文本可作为热点外，图形也可具有以上两种热点，图形中的热点要使用专用的工具软件-- 热点编辑器（Hot Spot Editor) 才能指定。

４、建立不可滚动的标题区域

在Windows 的帮助窗口中，经常可以见到窗口上部的标题区域（有时还会有图形）是不可滚动的，这在显示一个较长的主题时，使用户总能看到本主题的题目。用Word 创建主题文件时，通过以下方法很容易实现。
在编辑每一个主题时，第一行通常是主题的标题，然后换行再输入主题中的正文。这时把光标放在第一行，从“ 格式” 菜单中选择“ 段落” 命令，Word 弹出段落格式设置对话框，在此对话框中选取“ 正文排列” 选项卡，在“ 分页” 成组框中，用鼠标点取“ 与下段同页” 复选框，关闭段落格式对话框。这样第一行经过编译后就会成为不可滚动的区域。当然不可滚动的区域可以有多行，这时只要选择多行，然后再设置“ 与下段同页” 格式即可。

５、使用图形和图像
帮助主题文件中可使用的图形和图像为点位图(BMP 格式)。可用下面两种方法之一引用点位图图形：直接在主题文件中放置点位图，由于Word 支持图文混排，可用OLE 方法从其他应用程序中引入图形或图像，或者由“ 插入” 菜单中选择“ 图片” 命令，直接插入具有BMP 格式的图形文件；使用位图索引法，可以在点位图出现的位置加入下面的语句之

一，就在主题文件中加入了一个位图索引：
{bmc 图形文件名} ：把一个点位图当作一个字符处理，行高由点位图决定。
{bml 图形文件名} ：点位图放在一行的左边，正文可在右边卷绕。
{bmr 图形文件名} ：点位图放在一行的右边，正文可在左边卷绕。
其中图形文件名应加BMP 扩展名。一个点位图可被多处索引。应该注意的是，不要给出文件的路径名。如果需要告诉编译器在编译时在非工作目录中寻找点位图文件，可以在帮助项目文件的[BITMAP] 字段中给出点位图的全路径名。

二、创建帮助项目文件

Help 帮助项目文件( 扩展名为.HPJ)，包含Microsoft Help 编译器把主题文件和其他元素合成帮助文件所需的全部信息，项目文件是一个纯文本文件，可用任何文本编辑器来建立，也可用其他工具建立。每一个项目文件由一节或多节组成。每一节有一个节名，用方括号([ ]) 括起来，定义这一节中的语句和选项的目的和格式。

[OPTIONS] 指定控制创建过程的选项。此节是可选的，若选用必须在第一节。

[FILES] 指定帮助的主题文件，扩展名为RTF。这一节是必须的，可以有一个或多个主题文件。

[MAP] 把上下文串与上下文号相连接，成为上下文关联的帮助。

[CONFIGS] 指定在创建帮助文件中使用的宏。这些宏由帮助系统调用或用于创建非标准的帮助菜单和按钮。如用于前后翻页的》《按钮，就是由此字段指定的宏创建的。

[BITMAPS] 指定主题文件中引用的点位图的文件名，包括路径。

[WINDOWS] 定义帮助系统使用的主窗口及次窗口的标题、位置、大小和使用的颜色。在帮助主题文件中，若设计为跳转主题使用次级窗口，则应包括此段。
VFP 提供的Microsoft Help Workshop 用来建立项目文件十分直观方便，选择菜单File／New，选择Help Project 出现创建帮助项目文件画面（如图二）。
0301137.gif (11749 bytes)

图二建立帮助项目文件

三、创建目录文件
目录文件提供了帮助系统中主题的层次结构视图，利用Microsoft Help Workshop 的可视化的编辑十分方便建立。选择菜单File／New，选择Help Content，出现创建目录文件画面（如图三）。

图三创建目录文件

0302137.gif (5860 bytes)
四、编译生成帮助文件

帮助编译器有几个版本，功能也不尽相同。这里利用Microsoft Help Workshop 下的HCW 进行编译，在Microsoft Help Workshop 下选择菜单File／Compile ，即可进行编译，编译过程中出现错误时，系统会提示出错信息，以便进行修改，直到正确无误码为止。编译时，系统会提示帮助系统的有关信息，若无致命的错误，将编译生成一个扩展名为HLP 的帮助文件，这也是Windows 的帮助系统可以调用的二进制文件，可用File／Run Winhelp 即可欣赏到帮助。

五、在应用程序中编写代码调用帮助系统(WinHelp)，提供帮助信息
应用程序用户访问帮助的途径有三种：

（1）帮助菜单 - 显示在应用程序主菜单栏上的一个菜单。

（2）上下文相关帮助 - 当选定某个对象、控件或菜单选项并按F1 键时显示的帮助。

（3）“ 这是什么” 帮助 - 当用户寻求关于特定对象或控件的帮助时出现的简单弹出式提示。

下面以VFP 为例，分别说明如何在应用程序中编写代码调用帮助系统。

1、帮助菜单
要向菜单标题或菜单命令指定帮助标题，必须在与菜单标题或菜单命令相关联的过程中包含 SET TOPIC TO 命令，然后用Help 激活。

2、上下文相关性
“ 上下文相关帮助” 允许用户随时方便地访问与他们在应用程序中所做所见相关的帮助主题。例如，如果用户正在查看一个数据输入表单，“ 上下文相关帮助” 能够提供与那个数据输入表单相关的帮助主题。

一般地，通过按F1 键可以访问“ 上下文相关帮助”，可以使用ON KEY LABEL 指定任意键来激活“ 上下文相关帮助”。
在“ 表单” 上使用“ 上下文相关帮助”，必须为应用程序指定帮助，然后把特定的帮助主题与应用程序中不同的对象关联起来。添加“ 上下文相关帮助” 步骤如下：

（1）为应用程序指定一个帮助文件。
通过在代码中包含SET HELP TO file 命令( 其中 file 是帮助的名字)，可以决定应用程序能访问的帮助。例如，如果帮助名为 MYHELP.HLP，可以使用下面的命令：SET HELP TO MYHELP.HLP
这个命令一般包含在您的应用程序主程序的设置代码中。

（2）为希望提供“ 上下文相关帮助” 的对象指定一个帮助主题。

1）在“ 设计” 状态下打开想为之指定“ 上下文相关帮助” 的对象，例如一个表单、控件或工具栏。
2）查看该对象的属性。
3）把 HelpContextID 属性设置为代表帮助中特定主题的编码。
3、“ 这是什么？” 帮助
“ 这是什么？” 帮助类似于上下文相关帮助，因为它提供对当前具有焦点的特定对象或控件的帮助。但“ 这是什么？” 帮助并不激活帮助然后在默认大小的“ 帮助” 窗口中显示帮助主题，而是在一个弹出式小窗口显示帮助主题，当用户在屏幕任意位置单击时该窗口消失。
“ 这是什么？” 帮助在提供简单提示型描述或特定控件定义时很有用，因为“ 这是什么？” 帮助主题简洁、准确，窗口不会变得过大从而掩盖您正描述的特性。

要把“ 这是什么？” 帮助与特定表单、表单控件或工具栏关联起来，把它们的hatsThisHelpID 属性设置为代表帮助特定主题的编码。
使用如表2 所示的属性可实现“ 这是什么？” 帮助功能。
表2 “ 这是什么？” 帮助功能的属性及其说明
属性说明

WhatsThisHelp 设置表单的该属性为真，可以启用表单以及表单上任意控件的“ 这是什么？” 帮助。

WhatsThisButton 如果希望表单的标题栏显示一个“ 这是什么？” 按钮，设置属性为真。

WhatsThisHelpID 对一个表单、控件或工具栏，把该属性设置为对应于帮助中某个主题的 ID 编码。

WhatsThisMode 使用这个方法程序可以显示“ 这是什么？” 帮助问号鼠标指针并启动“ 这是什么” 帮助模式。单击一个对象将显示该对象

WhatsThisHelpID 属性指定的帮助主题。
若要实施“ 这是什么？” 帮助

1）在设计模式下打开想启用“ 这是什么？” 帮助的表单。

2）把表单的 WhatsThisHelp 属性设置为“ 真”(.T.)。

3）要在表单标题中显示一个“ 这是什么” 帮助按钮，把表单的 WhatsThisButton 属性设置为“ 真（.T.）”。

4）要把一个“ 这是什么” 帮助主题与该表单关联起来，把表单的 WhatsThisHelpID 属性设置为与帮助中主题相对应的 ID 编码。

5）要把一个“ 这是什么” 帮助主题与表单上特定控件关联在一起，选择控件然后把它的 WhatsThisHelpID 属性设置为与帮助中主题相对应的 ID 编码。

4、使用 WinHelp 函数
通过编程来使用帮助的另一个方法是调用 WinHelp 函数。WinHelp 函数是Windows 应用程序编程接口 (API) 的一部分。WinHelp 函数仅能用于 Windows 平台。
使用 WinHelp 函数步骤如下：

（1）定义您的应用程序将要传递的命令参数。
有关这些参数的说明，请参阅稍后的wCmd 参数。

（2）用 SET LIBRARY TO 设置库并定义要使用的变量，这个工作一般在应用程序主文件的初始化代码中完成。
SET LIBRARY TO SYS(2004) + “FOXTOOLS.FLL” ADDITIVE
Help = RegFn(“Help”， ”LCIC”， ”I”)
库一定要设置成 FOXTOOLS.FLL。SYS(2004) 返回安装 FOXTOOLS.FLL 的 Visual FoxPro 根目录。

如果希望传送 K 关键字来打开一个帮助主题，用 RegFn( ) 定义一个变量，象上一示例中的 Help 变量。如果希望打开映射到一个编码的帮助主题，用 RegFn 定义一个象上面示例 Help 一样的变量，用一个编码代替 dwData 中的字符串。如果传递编码，必须在 .HPJ 文件的 [MAP] 节中把它们与唯一的用编码标记 (#) 注脚定义的上下文字符串映射起来。

（3）使用 CallFn( ) 调用函数
下列代码使用 CallFn() 打开帮助主题，该代码包含主题关键字。
#define HELP_KEY 0x0101
wCmd = HELP_KEY
cFilename = HOME() + ” Myprogram\Myhelp.hlp”
dwData = ”Add Menu Items at Run Time”
CallFn(Help， MainHWND()， cFileName， wCmd， dwData)

有关 FoxTools 函数的更详细内容，请参阅 VFP\TOOLS 目录下的 FOXTOOLS.HLP 文件。

指定 WinHelp 参数。下列参数指定了 WinHelp 函数的选项。

hWnd 参数

hWnd 参数标识请求帮助的窗口。帮助使用这个标识符跟踪哪一个应用程序请求过帮助。在 Visual FoxPro 中，1 使用包含在 FOXTOOLS.FLL 库中的 MainHWND( ) 函数传递 hWnd 参数。

lpzFileName 参数

lpzFileName 参数是一个字段串，指定包含所需主题的帮助的有效路径及文件名称。它是以值传递方式传递的。

wCmd 参数

wCmd 参数或者指定用户对特定主题定位的查找类型或者指明应用程序不再需要帮助。它可以设置为表3 中的任一值。

表3 wCmd 参数的设置及其含义

常量值意义

HELP_FINDER    0x000B    显示 “ 帮助查找器” 窗口。
HELP_CONTEXT 0x0001    显示由上下文编码标识的特定主题的帮助。
HELP_HELPONHELP    0x0004    装载 HELP.HLP 并显示“ 使用HELP 帮助” 索引主题。
HELP_INDEX    0x0003    显示“ 帮助项目” 文件 (.HPJ) 中的 [OPTIONS] 一节定义的主帮助索引主题。
HELP_KEY    0x0101    显示在关键字列表中发现的第一个与 dwData 参数指定的关键字相对应的主题。

HELP_QUIT 0x0002 通知帮助应用程序已不再需要帮助，Windows 将关闭帮助应用程序。

HELP_SETINDEX 0x0005 把特定主题设置为索引主题。

dwData 参数

dwData 参数代表应用程序需要查找的主题。它的内容和格式取决于应用程序调用 WinHelp 函数时所传递的 wCmd 值。

在大多数调用帮助时按值传递方式传递 dwData 参数，这是 Visual FoxPro 的默认设置。

根据环境设置，上一行中的 dwData 或者代表一个文本字符串，指示要查找的关键字，或者是一个数值，指示标识一个特定主题的上下文编码。

表4 中列出了 wCmd 每个值所对应 dwData 的格式。

表4 wCmd 各值及其所对应的 dwData 格式。
wCmd 值 dwData 格式

HELP_CONTEXT    包含主题上下文编码的数值。 HELP_CONTEXT 使用 -1 可以代替使用 HELP_INDEX 。
HELP_HELPONHELP    忽略。
HELP_INDEX    忽略。
HELP_KEY    指向一个字符串的长指针，字符串包含所需主题的关键字。
HELP_QUIT    忽略。
HELP_SETINDEX    包含要设置为索引主题的上下文编码的数值。

因为 WinHelp 可以指定一个上下文编码或关键字，所它可以支持“ 上下文相关帮助” 及对帮助中主题的查找。

说明：如果帮助包含两个以上的索引，应用程序必须指定其中一个为默认索引。要确保设置的是正确的索引，应用程序在调用帮助时，应该把 wCmd 设置为 HELP-SETINDEX（其中 dwData 指定相应的上下文标识）。对帮助的每次调用都要后接 HELP_CONTEXT 的命令设置。千万不要把 HELP_SETINDEX 与 HELP_INDEX 一起使用。

（5）保留 F1 键的功能。

当用户在应用程序中按 F1 键时，Visual FoxPro 会显示一个“ 上下文相关帮助” 主题。为了做到这一点，可在帮助表中为需要“ 上下文相关帮助” 的主题指定一个帮助相关 ID，并把此值赋给表单或控件的 HelpContextID 属性。当表单或控件获得焦点并且用户按 F1 键时，Visual FoxPro 就会显示该主题。

（6〕在表单中包含“ 帮助” 按钮。

如果在您的表单中添加“ 帮助” 按钮，用户可以更方便地访问帮助信息。如果您的用户是个新手，那么更应该考虑添加一个“ 帮助” 按钮。
若要设置上下文相关帮助并添加一个“ 帮助” 按钮

1）在表单的 Init 事件中，将表单中所有对象的 HelpContextID 属性都设置为该帮助主题的 ID 值。例如，如果该值为 7，可用如下命令：
THIS.SetAll(”HelpContextID”，7)

2）在表单中添加一个命令按钮。

3）把命令按钮的 Caption 属性设置为“ 帮助”。

4）在命令按钮的 Click 事件中，添加下面的命令：HELP ID THIS.HelpContextID

为了方便，可把“ 帮助” 按钮保存为一个类，这样就可以方便地把它添加到任何表单中。

（7）退出图形样式帮助。

帮助应用程序是所有 Windows 应用程序共享的资源。因为它也是一个独立的应用程序，所以用户可以象其他应用程序一样执行它。这样您的应用程序对帮助应用程序只有有限的控制能力。
尽管您的应用程序不能直接关闭帮助应用程序窗口，但它可以通知帮助应用程序它不再需要帮助。在关闭主窗口之前，您的应用程序应该把 wCmd 参数设置为 HELP_QUIT，以此通知帮助说明您的应用程序不再需要它了。

如果应用程序在执行过程的某个位置要调用帮助，那么在终止应用程序前，必须把 wCmd 参数设置为 HELP_QUIT 来调用帮助。

如果一个应用程序打开了一个以上的帮助，它必须为每一个帮助文件调用 WinHelp 函数退出其帮助应用程序。如果一个应用程序或动态链接库 (DLL) 已经打开了一个帮助但不希望帮助应用程序的相关实例保持活动，那么这个应用程序或 DLL 应该把 wCmd 参数设置为 HELP_QUIT 来调用帮助，这样可以退出帮助应用程序的那个实例。

说明：在终止之前，一个应用程序或 DLL 总是应该对任何一个打开的帮助调用帮助。使用帮助名任何一次调用帮助都会打开相应的帮助。
所有调用帮助的窗口相继把 wCmd 设置为 HELP_QUIT 调用帮助以后，帮助应用程序才退出。如果一个应用程序没有这么做，那么即使在所有请求帮助的应用程序都终止以后，帮助应用程序仍将继续运行。

以上介绍的是制作Windows 95 帮助系统的基本方法。事实上，随着当今“ 所见即所得” 设计思想的广泛应用，出现许多专门用于制作帮助系统的工具软件，如Software Interface 的Help Magician ；Blue Skies Software 的Robohelp95 ；Wextech System 的Doc_to_Help2.0 以及Fore Front 的ForeHelp2.0 等等。它们最大的特点是可视化、所见即所得、集成处理等。操作界面类似于WORD，一般加入了自已的工具条、菜单项，实现可视化设计，可以轻松地创建跳转热点、弹出热点、图形热点等等，而且还可以将帮助文件打印成册。