linux 基于qt assistant制作软件帮助文档,基于Qt Assistant的软件帮助系统
Qt Assistant是Qt自带的一款可定制、可重新发行的帮助文件浏览器。Qt
Assistant支持HTML文件,用户可以利用其定制自己的功能强大的帮助文档浏览器。关于Qt Assistant定制的资料主要是Qt
Assistant自身所带的英文文档,虽然讲解比较详细,但是对于初学者来说难以快速的入手。因此结合具体实践,对Qt
Assistant定制的过程进行整理,希望对他人能有所启发。
定制过程中用到qhp,qch,qhcp,qhc四种不同格式的文件。对于这四种文件,初学者可能会经常混淆。至少我在开始用的时候,一头雾水。首先讲解一下这四种文件格式。这四种文件可以分为两组:
(1)qhp
与qch。qhp是Qt Help Project的缩写,qch是Qt Compressed
Help的缩写。qhp文件负责组织实际用到的帮助文件(通常为HTML文件,即需要在Qt
Assistant中浏览的文件),然后通过qhelpgenerator命令生成压缩的qch文件。qch文件是Qt
Assistant能够识别的文档最小单元,可以通过Qt
Assistant->编辑->首选项->文档标签页->添加/移除操作来注册或者注销一个qch文件。也可以通过命令
“assistant -register doc.qch”来注册qch文件。注册后,即可在Assistant界面中浏览帮助文档。
(2)qhcp
和qhc。qhcp是Qt Help Collection
Project的缩写,其主要作用是将qch二进制文件组织成为一个collection,定制客户化的Assistant;而qhc则是通过
qcollectiongenerator命令生成的二进制文件,启动Assistant时需要指定collection参数,即qhc文件。qhc文件
中是qch文件的集合,打开Assistant时,通过指定当前collection即可注册多个帮助文档。
从
上面文件的解释看,我们需要手动完成两个文件即qhp和qhcp文件,通过这两个文件再生成最终需要的qch和qhc文件。qhp和qhcp文件都是
XML文件,语法比较简单,这里不对语法进行详细介绍,具体可查看Qt
Assistant帮助文档。下面结合我在项目中对Assistant定制的过程进行总结,并给出了用到的qhp和qhcp文件的内容,这样更有助于从整
体上对该过程进行把握。
(1)制作HTML的帮助文件。由于原来的帮助文档是利用Word完成的,因此需要转换。转换的过程十分简单,即便对HTML不了解的用户也可以轻松完成。目前网络上有许多现成的HTML编辑器,利用这些编辑器即可轻松的进行编辑生成相应的html文件。
(2)编写qhp文件。下
面是在项目中用到qhp文件,文件比较简单,这里仅用到了基本的功能,具体语法可以查看帮助文档。这里需要注意的是通过标
签指定帮助文档目录,这里可以是多级目录,但是Qt中建议不超过四级。指定目录后,需要通过来指定所有用到的HTML文件,包括
HTML文件中用到的所有图片。这里如果不指定,生成的qch文件注册到Qt Assistant后将不能找到有效的文件进行显示。
org.mitk
doc
tutorial.htm
Tutorial_files/clip_image002.jpg
.....................................................................
Tutorial_files/clip_image072.jpg
(3)生成qch文件。qhp文件完成后,通过qhelpgenerator命令生成压缩的qch文件。打开cmd,输入" qhelpgenerator doc.qhp -o doc.qch "。这里doc.qhp为输入的qhp文件,-o表示输出,输出文件名为doc.qch。
(4)编写qhcp文件。qhcp中主要是对用到的qch文件进行组织,项目中用到的一个简单的qhcp文件如下:
doc.qch
其他的qch文件
从文件中可以看出,只需要在register标签中指定相应的qch文件名称即可。当前这里必须确保在qhcp文件目录下存在指定的qch文件。为了避免因为忘记生成qch文件而造成错误,qhcp中支持通过指定qhp文件从一次生成相应的qch和qhc文件。格式如下:
doc.qhp
doc.qch
doc.qch
从以上可以看出,在qhcp文件中多了一个标签,并指定了输入qhp文件,和输出qch文件。文件里面可以指定多个qhp和qch,只要注意好文件直接的对应关系就可以了。
(5)生成qhc文件。通
过qcollectiongenerator命令生成qhc文件,格式如下:“qcollectiongenerator doc.qhcp
-o doc.qhc "。这里doc.qhcp文件输入的qhcp文件,-o表示输出,doc.qhc为生成的qhc文件名称。
在编写qhcp文件时,建议采用(4)中的第二种方式,这样只需要一个命令即可生成qch和qhc文件,也避免了因为遗漏qch文件而造成qhc文件错误。
(6)运行Qt Assistant。可
以通过命令“qassistant -collectionfile
doc.qhc”打开qassistant,打开后即可浏览到我们自己的帮助文档了。当然如果是在程序中,可以通过QProcess来调用
assistant.exe,并给出相应的collectionfile参数即可。具体可参考:
linux 基于qt assistant制作软件帮助文档,基于Qt Assistant的软件帮助系统相关推荐
- 软件需求分析文档模板_小议管理软件需求分析
从事管理软件设计,一般都是从用户需求分析开始.从事软件工作的,大概谁都知道需求分析的重要性,可能大部分人都吃过需求分析不充分的亏.兵法云,"谋定而后动".对一个项目而言,需求分析应 ...
- 微课竞赛系统的设计与实现所需工作条件_启升微课丨从软件设计开发着手准备医疗器械软件描述文档...
启升微课--第四课! 大家好!今天是启升微课的第四课,本微课将跟大家分享的是"从软件设计开发着手准备软件描述文档". 首先,我们要清楚一个问题:有哪些医疗器械需要准备软件描述文档? ...
- linux图片相似度检测软件下载,文档相似性检测工具
文档相似性检测工具是通过比对源文档和目标文档的相似性给出相似度结果的一种信息处理系统.可以分段粘贴进去查 的确很给力哦.文档相似性检测工具和其他系统覆盖文献有80%以上不同,本系统通过混合引擎覆盖18 ...
- Docker软件安装文档
软件安装文档 文章目录 软件安装文档 虚拟机安装 系统死锁问题 JDK11安装 Docker安装 Docker-Compose安装 MySQL安装 MySQL8安装 Docker-Compose安装M ...
- 【Qt】DOM读取XML文档
00. 目录 文章目录 00. 目录 01. 概述 02. 开发环境 03. XML文档示例 04. DOM读取XML文档内容 05. 预留 06. 附录 01. 概述 DOM(Document Ob ...
- rockycapture_RockyCapture航线规划软件介绍文档
马上注册,享用更多功能,让我们一起,飞遍世界! 您需要 登录 才可以下载或查看,没有帐号?抢先注册 x RockyCapture 航线规划 RockyCapture 航线设计规划是基于大疆无人机,由珞 ...
- 内部软件技术文档怎么做?
今天,互联网被认为是一个知识库.任何人都可以使用互联网访问任何类型的信息,例如文档,查看超文本和多媒体(音频和视频)通过Web服务器数据库. 此外,对于任何组织来说,提供对公司网站的公开访问都变得必要 ...
- 局域网聊天软件 设计文档怎么写?
局域网聊天软件 设计文档怎么写?这种针对数据库记录的 局域网聊天软件 窃取,被一些攻击者称为拖库,于是有了一个自然而谐音的戏称脱裤.只是攻击者日趋不厚道,从前只是偷了人家的裤子,现在还要晾在大街上,并 ...
- android 文件编辑,文件编辑软件(在线文档编辑)
文件编辑软件(在线文档编辑)是一款文档文件编辑服务软件,在这里可以帮助用户随时新建文档或者导入文档内容,进行在线编辑处理,支持随时随地编辑文档内容,还可以进行表格制作.图片插入还有各种评论等服务,海量 ...
最新文章
- 国产首款脑机编解码集成芯片发布
- JSP控制流语句和运算符
- linux 设置代理 安装jdk mysql tomcat redis hadoop
- 在Mac下安装使用OpenCV
- python监听udp端口_python检测远程udp端口是否打开
- 博鳌论坛国际粮食安全-林裕豪:从玉农业对话丰收节贸易会
- win8计算机可用内存不足,Win8.1玩游戏提示计算机内存不足,Win8.1内存不足怎么办?...
- java 不支持fork,grails不能运行fork模式解决方法
- 基于Python+Django的失物招领平台系统设计
- TokenInsight:反映区块链行业整体表现的TI指数较昨日同期上涨1.37%
- vue-cli+webpack在生成的项目中使用bootstrap的方法
- 【BZOJ2296】随机种子(构造)
- 解决Ubuntun 12.04编译 WARNING: 'automake1.12' is missing on your system
- 华为交换机主备命令_华为交换机命令汇总
- CAD转换PDF格式,文字模糊不显示
- html生成pdf java_Java实现HTML代码生成PDF文档
- RuntimeError: mat1 dim 1 must match mat2 dim 0 报错解决
- chm打开秒退_【CHM+】CHM+下载_CHM+教程 _正版CHM+下载 -爱应用
- 【代码重构】临时字段(Temporary Field)-- 如何消除和处理代码中临时字段
- 数论讨伐!欧拉函数!
热门文章
- 使用gpu(gtx1080) cudnn 5.1下编译faster rcnn
- 中国大数据企业排行榜V6.0- 5 年后再去看看中几个大数据公司的发展状况
- 好程序员web前端技术之CSS3过渡
- mysql备份与还原-mysqldump备份、mysql与source还原
- Python 工匠:编写条件分支代码的技巧
- XXX管理平台系统——概要
- 微信 登录 Scope 参数错误或没有 Scope 权限
- solr安装笔记与定时器任务
- swift 适配的方法autolayout 和 masory===snapKit库
- selenium+ant+testng测试框架简单介绍