为 Lazarus 中的组件创建上下文相关帮助答案

【问题标题】：Create context-sensitive help for a component in Lazarus为 Lazarus 中的组件创建上下文相关帮助
【发布时间】：2016-01-29 07:30:33
【问题描述】：

我们想为 Lazarus 中的一些新组件制作文档。 Chm 文档文件已经可用，我们只需要以某种方式将它们与 Lazarus 集成。

这个帮助系统应该是上下文相关的，即在定义组件的一个元素（函数、属性等）上按下F1键后，chm文件中的相应帮助出现在Lhelp（Lazarus帮助程序）。

那么，我们应该怎么做才能提供这样一个上下文相关的帮助呢？

提前致谢

【问题讨论】：

我不确定 Lazarus 是否接受第三方 chms atm。但是您可以检查当前的加载和解析方式。
在这个example 中，一个chm 文件被集成到一个表单中，并通过按F1 键在文本编辑上运行（pascal 文件开头的cmets 解释）。我试过了，它有效。但它是表单上的一个示例，在 TEdit 中定义了属性（HelpType 和 HelpKeyword）的值，并且在表单中添加了两个组件（TCHMHelpDatabase 和 TLHelpConnector）。我的目的是定义新组件的帮助；也就是说，在元素（函数、属性等）上按 F1 会显示 lhelp。
@Masood：据我了解，您不想要应用程序帮助（上下文相关），而是需要 Lazarus IDE 代码编辑器中选定单词（例如属性）的 F1 帮助以用于集成组件？跨度>
@help-info.de：是的，这是真的。当使用我们的组件时，我们希望在源代码编辑器上获得上下文相关的帮助。

【解决方案1】：

你可以使用fpdoc top创建文档，编译成chm，lazarus/lhelp应该根据http://bugs.freepascal.org/view.php?id=15334打开document/目录下的所有CHM

CHM 的索引部分是 iirc 用于查找的。p>

【讨论】：

【解决方案2】：

在 Lazarus/FreePascal wiki 中有一个关于它的 wiki 页面： http://wiki.lazarus.freepascal.org/Add_Help_to_Your_Application

据我所知，Lazarus 默认将帮助文件作为 HTML 文件提供，无论如何也支持 CHM 文件。

在你的 Lazarus 安装中有一个示例程序：

${lazarusdir}/components/chmhelp/democontrol/.

此演示展示了如何设置上下文相关的帮助按钮（通常为 F1）。

请务必查看有关 lhelp 的文档，它也是默认的 Lazarus CHM 查看器，如下所述：

【讨论】：