Qt帮助文档框架

Qt帮助文档框架

1. 概述

Qt自身支持帮助文档，所在的模块是qt help,因此想要在自己的程序中嵌入帮助文档是比较方便的（仅仅不用引入第三方包）。
但是如同新手到了战场，无从下手，加之Qt自身的鸟语帮助文档，看不懂哦。网上对于Qt的开发资料相对匮乏，加之整个环境比较闭源，写出来的博文不是免费看的。尽管如此，我还是找了一些博文，感谢：
https://blog.csdn.net/bmseven/category_12336678.html
https://www.walletfox.com/course/qhelpengineexample.php
至于QT的官方文档，我是看不懂。而且第一个代码段就是错的。

重点

Qt帮助项目收集生成压缩帮助文件所需的所有数据。除了诸如目录，索引关键字和帮助文档之类的实际帮助数据外，它还包含一些其他信息，例如用于标识帮助文件的名称空间。一个帮助项目代表一个文档集。

2. 代码如何用Qt的帮助框架

• 使用Assistant（笑了，自己玩玩吧，如果打包给别人，也要对方的电脑安装Qt嘛？）qt的官方文档是使用这个方法的。
  

• 使用QHelpEngine类，参考别人的文档自己写了一个小例子，点击按钮弹出帮助文档。详情见代码。https://gitee.com/xiaolixi/introduction_qt/tree/master/projects/qthelp
  

3. 概念

概念一张图，如下图，懂的自然懂，不懂还是不懂。

帮助文档的制作步骤：

1. 制作html文件，该前端的还是前端，目前和qt完全无关
2. 自定义一个.qhp的描述文件，用qt自带的工具生成.qch文件，qhelpgenerator bmhelp.qhp -o bmhelp.qch
3. 自定义一个.qhcp的描述文件，文件会用到.qch文件，用qt自带的工具生成.qhc文件，qhelpgenerator bmhelp.qhcp -o bmhelp.qhc，至此帮助文件制作完成
4. 代码中引用.qch文件和.qhc文件。代码主要用到的类QHelpEngine，当前才和qt相关。

4. assistant助手

在qt的安装目录下的一个可执行程序。

双击后的助手文档：查看页面介绍博文

5. 代码小案例