设置Delphi应用程序的帮助

Question

为Delphi应用程序设置帮助(特别是HTML帮助)的最佳方法是什么？我可以看到几个选项,所有选项都有缺点.特别:

我可以在表单设计器中的任何地方设置HelpContext,但后来我不得不跟踪数字而不是符号常量.
我可以通过编程方式设置HelpContext.然后我可以使用符号常量,但我有更多的代码可以跟上,我无法轻松检查文本DFM以查看哪些表单仍然需要帮助.
我可以设置HelpKeyword,但由于这样做了关键字查找(比如Application.HelpKeyword)而不是主题跳转(比如Application.HelpJump),我必须确保每个帮助页面都有一个独特的,不变的,顶级关键字; 这似乎是额外的工作.(也有HelpKeyword相关VCL蝽象这个和这个.)
我可以设置HelpKeyword,设置Application.OnHelp处理程序,将HelpKeyword请求转换为HelpJump请求,这样我就可以按主题ID而不是关键字查找来分配帮助,并添加代码,例如我自己的帮助查看器(基于HelpScribble的代码),修复了VCL错误,让HelpJump与锚点一起工作.不过,到目前为止,我觉得我正在与VCL而不是VCL合作.

您为自己的应用选择了哪种方法？

Answer 1

lke*_*ler 6

几年前我第一次开始研究如何做到这一点时,我首先得到了"Borland Delphi中的All About帮助文件"教程:http://www.ec-software.com/support_tutorials.html

在该文档中,"为上下文相关帮助准备帮助文件"一节(在我的文档版本中,从第28页开始).它描述了一个很好的编号方案,您可以使用它来将您的数字组织成各个部分,例如,从主表单开始使用100000,并为每个辅助表单继续使用101000或110000等.

但后来我想在我的帮助主题中使用描述性字符串ID而不是数字.我开始使用THelpRouter,它是EC Software免费帮助套件的一部分:http://www.ec-software.com/downloads_delphi.html

但后来我找到了一个直接支持字符串ID的帮助工具(我使用Dr. Explain:http://www.drexplain.com/)所以现在我只使用HelpJump,例如:

Application.HelpJump( 'UGQuickStart');

我希望有所帮助.

Answer 2

我创建帮助文件，该文件获取帮助主题 ID，然后遍历表单并将其 HelpContext 值设置为它们。由于所需的维护级别非常低 - 除非发生重大事件，否则表单不太可能更改帮助文件上下文 - 这工作得很好。