QT系列——帮助文档
Qt可以使用自带工具生成定制化的帮助文档。
本文主要是说明如何将html格式的帮助文件生成定制化帮助文档的过程。html格式的文件由手动写或者通过转换工具进行转换获得,这里不包含此过程的内容。
想创建帮助文档,需要了解四种文件,分别是qhp和qch、qhcp和qhc。初看这些名字很容易懵,跟随下述步骤,分别了解这四种文件。
1.创建qhp文件。
qhp:全称Qt Help Project,Qt帮助项目文件。
该文件是XML格式,用于组织HTML格式的帮助文档。
该文件需要设置命名空间,命名空间作为标识符必须唯一,用于帮助引擎能够检索到给定链接的适当文档。设置虚拟文件夹,使文档集可以共享虚拟文件夹。该文件中列出了所有html的路径,以及目录结构,建议不要嵌套过度。
qch:全称Qt Compressed Help,QT压缩帮助文件。
该文件由qhp文件通过工具qhelpgenerator生成。
该文件是二进制格式, 包含帮助项目文件中指定的所有信息以及所有压缩文档文件。。
qhp示例:
<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
<namespace>demo.help</namespace>
<virtualFolder>doc</virtualFolder>
<filterSection>
<toc>
<section title="帮助文档" ref="帮助文档.html">
<section title="概述" ref="概述.html"></section>
<section title="具体内容" ref="具体内容.html"></section>
</section>
</toc>
<files>
<file>帮助文档.html</file>
<file>概述.html</file>
<file>具体内容.html</file>
<file>image/图标.png</file>
</files>
</filterSection>
</QtHelpProject>
2.创建qhcp文件
qhcp:全称Qt Help Collection Project,Qt帮助集合项目文件。
该文件是xml格式。该文件支持标题、首页、图表等设置,用于定制化。
qhc:全称Qt Help Collection,是Qt帮助收集文件。
该文件由qhcp文件通过工具qcollectiongenerator生成。
该文件是二进制文件,包含对任意数量的压缩帮助文件的引用以及附加信息,。
qhcp示例:
<?xml version="1.0" encoding="UTF-8"?>
<QHelpCollectionProject version="1.0">
<assistant>
<title>Demo帮助文档</title>
<applicationIcon>image/图标.png</applicationIcon>
<cacheDirectory>cache/demohelp</cacheDirectory>
<homePage>qthelp://demo.help /doc/帮助文档.html</homePage>
<startPage>qthelp://demo.help /doc/帮助文档.html</startPage>
<aboutMenuText>
<text>关于</text>
</aboutMenuText>
<aboutDialog>
<file>./about.txt</file>
<icon>image/图标.png</icon>
</aboutDialog>
<enableDocumentationManager>false</enableDocumentationManager>
<enableAddressBar>false</enableAddressBar>
<enableFilterFunctionality>false</enableFilterFunctionality>
</assistant>
<docFiles>
<register>
<file>demohelp.qch</file>
</register>
</docFiles>
</QHelpCollectionProject>
3.生成qhc文件和qch文件。
使用qhelpgenerator工具可以将qhp文件生成qch文件:
qhelpgenerator demohelp.qhp –o demohelp.qch
使用qcollectiongenerator工具可以将qhcp文件生成qhc文件:
qcollectiongenerator demohelp.qhcp –o demohelp.qhc
4打开qhc文件
通过Qt Assistant工具打开qhc文件。
总结:
Qt可以使用自带工具进行定制化制作帮助文件,步骤总结如下:
- 先制作qhp文件;
- 再制作qhcp文件,
- 通过工具可以分别生成qhc文件和qch文件。
- 最后打开qch文件,就可以看见制作完成的帮助文档啦。
- 点赞
- 收藏
- 关注作者
评论(0)