看起来帮助和手册毕竟可以工作!这是我们现在正在查看的序列。如果您发现任何问题或可以改进的地方,请发表评论。
在帮助和手册中(使用版本 5.5.1 Build 1296 专业许可证测试),在项目资源管理器中,在配置部分:
转到 HTML 页面模板\默认值。在 HTML 源代码选项卡中,注释掉该部分。
转到发布选项\Web 帮助。
在布局中,选择无框架,无脚本。
在 Navigation 中,我们不需要检查任何内容 - 尽管如果有一种方法可以控制 KEYWORD_INDEX 值的格式,以便我们可以直接复制并粘贴到我们的 .qhp 中,那就太好了!我还没有找到这样做的方法,所以我们计划直接在 .qhp 中维护关键字。
同样,目录也无关紧要,除非我们可以控制格式,否则我们必须直接在 .qhp 中维护目录。
在弹出主题中,我们设置为 HTML 编码的主题。不确定这是否有必要。
这就是我们必须更改的所有设置。像往常一样在 H&M 中创建帮助内容,然后发布 Webhelp。这将为每个主题创建一个单独的 .htm 文件。
在与 .htm 相同的文件夹中,我们创建 .qhp 和 .qhcp 文件,并运行 qcollectiongenerator 以生成我们的 .qhc,然后我们使用 Qt Assistant 显示。有关此工具链的 Qt 方面的帮助,请参阅http://doc.qt.nokia.com/4.7/qthelp-framework.html。
同样,如果我们能找到一种方法来设置 H&M 以创建 .qhp 所需格式的目录和关键字,并且我们可以将它们粘贴到 .qhp 中(或者就此而言,维护 .qhp 文件),那就太好了。 qhp 也在该模板中)。另一种选择是编写一个脚本,将 H&M 为 toc 和关键字创建的内容转换为 .qhp 所需的内容。如果您这样做并且不介意分享,请发布代码!
我们发现使用 H&M 解决这个问题的一些好处:
- 多个文档器可以同时工作,并且源代码在 Subversion 中存储为文本文件,因此它是可版本化的,您可以比较更改。
- 轻松所见即所得的帮助主题创建
- 可以处理各种文本格式和链接。例如,在一个端到端的功能测试中,看看 H&M 的哪些功能可以在我们的最终产品中工作(在 Qt 助手中查看.qhc),我很惊讶地看到 Qt 助手甚至处理链接到其他图像中的热点主题/锚。
- .qhc 已集成到 Qt 中,因此您可以从 Qt 应用程序中很好地控制您的帮助。
同样,如果有人对此有更好的解决方案或改进,请发布!