Delphi帮助文件的制作和应用
文/陈德全
摘要:介绍用Microsoft Help Workshop制作标准帮助文件详细过程及标准帮助文件在Delphi应用程序中的应用。
关键词:帮助文件、Delphi程序、富文本
为了使您的程序专业化且便于使用,有必要制作一个帮助文件。帮助文件的实现有很多方法,Dos时代的Readme.txt已经随着Dos的淡出而销声匿迹了,Windows环境中帮助文件有了更多的实现方法,可以用authorware等多媒体软件制作精美的帮助文件,也可以用制作主页的方式制作Html格式的帮助文件,但不可否认,目前用Microsoft Help Workshop制作的标准帮助文件仍占主要地位,是目前应用软件中最常使用的。Visual Basic、Visual Foxpro、Delphi等编程环境都带了一个帮助文件制造器——hcw.exe,例如在Delphi4.0中,你可以在“安装路径/Borland/Delphi4/help/tools”下找到4.03版本的hcw.exe。下面给大家介绍帮助文件的制作和应用。
一、规划帮助文件的内容。帮助文件一般应包括目录和正文两部分内容。本例设有一页目录和两页正文,目录页上有连到正文“帮助1”、“帮助2”的两个链接,正文“帮助1”、“帮助2”均有两项内容。
二、制作帮助文件的内容页。帮助文件内容页要求以富文本(*.rtf)格式保存,所以你必须有一个能处理富文本的工具,如Windows95下的写字板或Word97,本例采用Word97。在Word97中以大纲视图的方式新建文档,保存文件为kshelp.rtf(注意:用rtf格式保存)。在文档中输入帮助文件内容页的内容,内容如下:(注意:标题应设成二号或三号字体以突出,正文则设成标准五号字体。另外,标题与正文间要回车以留下适当的空间,这样帮助文件才能美观大方。下面示例中括号黑体部分注明格式和内容及其操作,不是正文内容,请不要输入。)
目录(在格式工具栏的最左边的样式栏中设成标题1,下同;本部分是总目录页,这是总标题)
(回车)
帮助1(设成标题3;这是目录的内容的第一项)
帮助2(设成标题3;这是目录的内容的第二项)
(ctrl+回车,产生分页符,总目录页结束,设本帮助系统有帮助1和帮助2两个帮助项)
帮助1(设成标题1,本部分是“帮助1”详细内容页)
1.帮助1的第一项内容......
2.帮助1的第二项内容......
(ctrl+回车,产生分页符,“帮助1”页结束)
帮助2(设成标题1,本部分是“帮助2”详细内容页)
(回车)
1. 帮助2的第一项内容......
2. 帮助2的第二项内容......
(“帮助2”页结束;无需ctrl+回车,因整个文档到此结束。)
三、输入帮助文件代码。帮助文件代码有正文字符串和跳转(井字符#和删除线,这两个符号须结合起来才能发挥作用)、关键词和标题(美元符$和K字符K,这两个符号也须结合起来才能发挥作用)、浏览顺序(加号+)、建立标记定义等。下面介绍正文字符串和跳转两个代码的使用,对于一般的帮助文件是足够使用的,其他代码的用法请参阅其他专门的参考资料。
1、正文字符串。正文字符串是每个主题的指示符,设置主题是为了让跳转调用以及让目录文件(*.cnt)调用。每个主题都必须有一个正文字符串,例如给“总目录页”部分设置正文字符串。在“目录”左边插入脚注‘#’,并命名此处脚注为content,说明此处是“目录” 页内容。依此方法为“帮助1”部分设置正文字符串help1,为“帮助2” 部分设置正文字符串help2。结果如下:
#目录
帮助1
帮助2
#帮助1
1.帮助1的第一项内容......
2.帮助1的第二项内容......
#帮助2
1. 帮助2的第一项内容......
2. 帮助2的第二项内容......
插入脚注方法如下,把光标停在欲插入脚注的文字的左边,选择“插入”菜单的“脚注和尾注(G)...”项,跳出“脚注和尾注”框,选择插入脚注,选择编号方式为自定义标记,输入井字符#(如图1)。插入脚注后,word会自动跳到脚注内容栏,请给每个脚注命名。结果如下:
# content
# help1
# help2
2、跳转。选择“目录页”中的“帮助1”,然后给它设置删除线;在“帮助1”后面输入help1以表明这个跳转是跳到主题help1的,然后设help1为隐藏。以此方法为“帮助2”增加跳转主题help2。结果如下:(其中help1、help2应设为隐藏的,此处为了示例方便加了字符底纹)
目录
帮助1help1
帮助2help2
(注:删除和隐藏效果在“格式”的“字体”项效果栏中。)
四、最后形成一个完整的rtf文件,保存文件,退出word环境。
五、建立目录文件(*.cnt)。双击hcw.exe,启动Microsoft Help Workshop。新建help contents文件,保存为kshelp.cnt,依照图2内容输入目录文件内容。其中“目录”项为“Topic”类型,它的“Title”为“目录”,它的“Topic ID”为content;“帮助1”项为“Topic”类型,它的“Title”为“帮助1”,它的“Topic ID”为help1;“帮助2”项为“Topic”类型,它的“Title”为“帮助2”,它的“Topic ID”为help2。这里的content,help1,help2是我们上文编辑kshelp.rtf文件时用正文字符串#符号定义的三个主题。最后形成一个cnt文件,保存文件,关闭窗口。
六、建立工程文件(*.hpj)。在Microsoft Help Workshop中新建Help Project文件,保存为kshelp.hpj。按下Options...,在general页中填入对帮助文件的描述,在Files页中,设Help File为kshelp.hlp,设Rich Text Format(RTF) Filse为kshelp.rtf,设Contents File为kshelp.cnt。按下Files...,再按Add...,找到kshelp.rtf并增加再列表中。这样,形成一个完整的hpj文件。最后Save and Compile,一个简单的Windows标准帮助文件就完成了。
七、标准帮助文件生成后,可以在Visual Basic、Visual Foxpro、Delphi中调用。现以Delphi4.0为例说明其应用过程。在project|options中的Applications页中设Help File项为"kshelp.hlp"添加“帮助”菜单项,并在其下面增加“内容”和“索引”两个子菜单项。双击“内容”子菜单项,输入:“Application.HelpCommand(Help_Contents,0);”,双击“索引”子菜单项,输入:“Application.HelpCommand(Help_Finder,0);”。这样,帮助文件就会出现在您的项目中。
以上简单介绍了用Microsoft Help Workshop制作标准帮助文件详细过程及标准帮助文件在Delphi应用程序中的应用。这种制作帮助文件的方法虽然简单,但由于涉及到Microsoft Word程序、Microsoft Help Workshop程序、Borland Delphi等程序,相对于Html文件制作来说有点烦。不过,有志者事竟成!