Delphi 使用HLP文件制作系统的帮助文档

1、基础知识简介

        使用帮助提示窗口或状态栏只能提供简单、单一的帮助，无法对某一模块或应用程序整体提供系统的帮助，因此运行Windows应用程序，需要帮助时一般都可以通过执行帮助菜单获得整个应用程序的帮助，也可以运行某一部分时单击帮助按钮或按“F1”键获得相关的帮助。Delphi应用程序能够方便地应用帮助系统。下面介绍应用程序动态地运行帮助系统的方法。

 

2、HLP文件的结构：

        HLP（Microsoft Help Workshop）是微软的一种帮助文件格式，HLP格式已经逐渐被CHM格式所替代，Microsoft Help Workshop（以下简称为HW）是一款专业的制作HLP文件的软件。HW与HTML Help Workshop均是微软开发的制作帮助文件的软件。由于HLP格式出现较早，目前大部分的基于Web的技术都不可以使用。但是由于 HLP文件的界面整洁、对文件的压缩比率较高等特点，目前还广泛应用在很多领域当中。

 

3、应用程序和帮助文件的关联

        有了相应的帮助文件还要为应用程序定义帮助文件，以便在用户需要帮助时应用程序能打开相应的帮助文件。定义应用程序的帮助文件有两种方法：

第一种方法:

        在Delphi集成开发环境中选择“Options | Project”菜单项，系统弹出工程选择对话框，再选择Application页面，然后在辅助文件HelpFile中输入帮助文件名。

 

第二种方法：

        在主窗体的OnCreate事件中直接为应用程序（Application）的HelpFile特性赋值。HelpFile特性的声明如下：property HelpFile: string; 这个特性记载帮助文件的名字，可以在运行期间设置，也可以在设计期间设置。

 

4、通过功能键F1调用帮助文件

        Windows应用程序经常通过功能键F1提供帮助，当程序运行到某一部分需要帮助时，只要按F1键就会弹出跟当前输入焦点控件相关主题的帮助文件。Delphi开发的应用程序若要提供这种功能只需要设置HelpContext特性。HelpContext特性的声明如下：
property HelpContext: THelpContext;//type THelpContext = -MaxLongInt..MaxLongInt;

说明：这个特性用于设置帮助文件中用于识别主题的上下文编号，若该参数为0则不调用帮助文件。

 

5、通过菜单调用帮助文件（应用程序控件的三个函数）

         除了功能键F1以外windows应用程序还可以通过菜单、工具栏、按钮等调用帮助文件，delphi开发的应用程序提供这类功能时可以调用应用程序控件（Application）的三个函数来实现，下面是调用帮助文件的三个函数的声明以及使用方法。

1>、HelpContext函数

function HelpContext(Context: THelpContext): Boolean;//type THelpContext = -MaxLongInt..MaxLongInt;

该函数调用Windows的WinHelp函数，Context参数是帮助文件的上下文编号。如果HelpFile（应用程序的帮助文档）特性是空字符，这个函数返回假值，其它情况均返回真值。

 

2>、HelpJump函数

function HelpJump(const JumpID: string): Boolean;

该函数调用Windows的WinHelp函数，JumpID参数是帮助文件中唯一辨识帮助主题的字符串。如果HelpFile特性是空字符，这个函数返回假值，其它情况均返回真值。说明：以上两个函数一般可用于响应工具栏或按钮的OnClick事件，显示相关主题内容。

 

3>、HelpCommand函数
function HelpCommand(Command: Word; Data: Longint): Boolean;

该函数调用Windows的WinHelp函数，Command参数指定命令的种类，Data参数跟Command参数有关。如果HelpFile特性是空字符，这个函数返回假值，其它情况均返回真值。

 

关于Command参数指定的命令种类请参考Windows的WinHelp函数，下面仅列出常用的命令。

HELP_FINDER： 显示帮助的主题，索引窗口。  Data：忽略，一般是0

HELP_CONTEXT：显示指定主题的帮助内容。 Data：无符号的长整形，帮助文件的上下文编号。

HELP_HELPONHELP：显示Windows系统的介绍帮助文件使用方法的帮助。 Data：忽略，一般是0

HELP_QUIT：关闭帮助文件。 Data：忽略，一般是0

HELP_PARTIALKEY：显示指定关键字的帮助内容。 Data：关键字的地址。

说明： HelpCommand函数主要用于响应菜单、工具栏、按钮的OnClick事件，它可以完成HelpContext和HelpJump函数的所有功能。另外调用这三个函数时触发应用程序控件（Application）的OnHelp事件。

 

6、通用对话框中使用帮助文档

         Delphi提供的通用对话框（OpenDialog等）中都能显示一个帮助按钮。如果程序显示了对话框中的帮助按钮，应该确保应用程序的帮助文件中有相应的主题。

在通用对话框中使用帮助系统，需要以下三个步骤：

1>、把对话框的属性Option|ShowHelp特性设置成True，这样在程序运行时将出现帮助按钮。

（ShowHelp与其控件的名字相关，例如字体对话框ShowHelp特性称为fdShowHelp，打开对话框为ofShowHelp。

2>、为对话框控件的HelpContext特性设置帮助文件的上下文编号。

3>、定义应用程序的帮助文件名。