本文相关:利用Qt自身带有的Qt Assistant帮助文档浏览器,制作应用程序的帮助文档。
相关工具:qhelpgenerator、qcollectiongenerator、assistant。三个工具均在mingw/bin下,如我的路径是“d:/Qt/Qt5.8.0/5.8/mingw53_32/bin”下。windows下,如果使用普通CMD,需要明确工具的路径,如果“d:/Qt/Qt5.8.0/5.8/mingw53_32/bin/qhelpgenerator”;如果嫌麻烦,直接使用mingw自带的命令行工具,如“开始->Qt5.8.0->5.8->Mingw 5.3.0 (32 bit)”。
应用程序发布时,其中assistant还需同应用程序一同发布,才能正常显示,因为应用程序是利用assistant.exe显示管理帮助文档,具体步骤后续介绍。
相关文件:HTML、qhp、qch、qhcp、qhc。
其中,
HTML:网页文档文件,实际显示的目标文件,制作出什么样式、什么文字,只要解码语言正确,Qt Assistant上就显示什么。后面4个文档中解码语言选择不合适的话,可能会显示乱码。如GB2312常用于显示汉字,UTF-8常用于显示英文。
qhp:即Qt Help Project的缩写,用于组织实际帮助文档(HTML)的结构,将帮助文档按想要的格式组织排列,是xml格式的项目文件。
qch:即Qt Compressed Help的缩写,是通过qhelpgenerator命令将qhp转换生成的压缩格式文件,是二进制格式文件。
qhcp:即Qt Help Collection Project的缩写,其实更确切地,应该是Qt Compressed Help Collection Project。因为该文件是用于组织qch二进制文档的结构,将qch二进制文档按想要的格式组织排列,用于客户定制化的Assistant,是xml格式的项目文件。
qhc:即Qt Help Collection的缩写,是实际的可执行文档。是通过qcollectiongenerator命令将qhcp转换生成的二进制格式执行文件。注意与qhcp区分,qhcp是项目文档。
实际操作步骤
一、制作HTML文档
本文不具体介绍HTML文档制作过程,读者可通过word,dreamweaver等工具制作。最简单的方式,用word编辑后,另存为html文件即可,但是作者亲试这种方法时,直接用浏览器