利用Qt Assistant 修改帮助文档可能会出现的修改失败的问题

在使用Qt Assistant定制帮助文档时,遇到修改失败的问题,即使删除文件,旧的文档仍存在。原因是qhc文件与缓存目录中的qhc文件不同步。Qt的cacheDirectory字段用于存储索引文件和用户设置,其路径根据base属性决定。当base为collection时,路径相对于帮助文档目录,但可能造成权限问题。建议使用cacheDirectory字段,确保用户写权限,以避免用户体验问题。若出现同步失败,只需清理缓存目录即可。
摘要由CSDN通过智能技术生成

    关于利用Qt Assistant定制帮助文档,网络上已有相关教程,在使用该教程定制帮助文档时,初次创建没有问题,但是当我要修改文档结构时,会出现修改失败的情况,例如明明有些文件已经从qch中删除,但是生成qhc文件后使用assistant -collectionFile XXX.qhc打开帮助文档时被删除的一些文件仍然存在,说明qhc文件不是最新的,经过调试和查阅文档,发现了问题所在,和缓存机制有关。

    在Qt4帮助文档Using Qt Assistant as a Custom Help Viewer一章和Qt5帮助文档Customizing Qt Assistant一章中,都有Qt Help Collection Files一节,简单介绍了Qt帮助集合文件,以及重点说明了qhcp中cacheDirectory字段的意义。简单来说,qhc文件保存了用户关于帮助文档的相关设置,这就需要qhc文件具有用户写权限,但是Qt无法预测你的帮助文档是否一定会在具有用户写权限的系统上,比如当你将帮助文档置于CD上时,用户将无法修改该qhc文件,从而无法保存用户关于帮助文档的相关设置。为了解决这一问题,Qt在qhp中设置了一个cacheDirectory字段,该字段的内容即是缓存目录,用户在保存帮助文档的相关设置时,会在此目录中保存一份qhc文件,下次使用assistant -collectionFile XXX.qhc时,实际调用的是缓存目录中的qhc文件。正常情况下,帮助文档所在目录的qhc文件和缓存目录的qhc文件是同步的,但是本人在win10系统中由于未知原因,帮助文档所在目录的qhc文件和缓存目录的qhc文件未同步,缓存目录中的qhc文件一直是过去的文件,所以造成了修改帮助文件失败的情况。

 

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值