利用qt制作帮助文档

1.         创建文档即是一些html文件,这里可以使用qt提供的工具像是qdoc 和Doxygen生成帮助的html文档。

2.         组织文档结构用于qt assistant

a)         创建qt help project(.qhp)

i.              定义命名空间 命名空间必须是唯一的,除此之外还要设置虚拟文件夹,作为文档集合的通用文件夹。这里每个每个文档集合对应一个命名空间,而这些文档集合的相互共享是通过虚拟文件夹来实现的。

ii.              定义filter section,其中包括目录表格,每个目录项都可以有相应的属性和它相关联,可能再用户定义的filter属性中会根据属性来确定是否需要显示该文档。

iii.              定义关键字,定义的这些关键字主要是用于查找,

iv.              列出所有相关文件,这里的文件不仅要包括html文档,还要包括一些其他的图像等文件,(所有的文件)

3.         此时已经制作完成了帮助项目文件,可以在qt assistant中查看自己的帮助文档

a)         生成qt压缩帮助文件

qhelpgenerator simpletextviewer.qhp -o simpletextviewer.qch

b)        将其注册到默认的help collection of qt assitant中

assistant -register simpletextviewer.qch

自定义Qt Assistant

1.       想要实现自定义的qt assistant必须要创建自己的collection file ,这个文件是以二进制格式进行存储的,有help collection project file(.qhcp)文件生成。

2.       <?xml version="1.0" encoding="UTF-8"?>

<QHelpCollectionProject version="1.0">

<assistant>

<title>Simple Text Viewer</title>

<applicationIcon>images/handbook.png</applicationIcon>

<cacheDirectory>Trolltech/SimpleTextViewer</cacheDirectory>

cacheDirectory定义用户数据目录的子目录

3.       设置启动页面

<startPage>qthelp://com.trolltech.examples.simpletextviewer/doc/index.html</startPage>

其中包括namespace  and  virtual directory而后是最终显示的网页

4.       设置构造的帮助中的帮助相关内容

<aboutMenuText>

<text>About Simple Text Viewer</text>

</aboutMenuText>

<aboutDialog>

<file>about.txt</file>

<icon>images/icon.png</icon>

</aboutDialog>

5.       生成并注册qcp文件

<docFiles>

<generate>

<file>

<input>simpletextviewer.qhp</input>

<output>simpletextviewer.qch</output>

</file>

</generate>

<register>

<file>simpletextviewer.qch</file>

</register>

</docFiles>

6.       生成help collection project file

qcollectiongenerator simpletextviewer.qhcp -o simpletextviewer.qhc

assistant -collectionFile simpletextviewer.qhc

创建文档和自定义的qt assistant的更多相关文章

  1. javascript创建文档碎片节点

    在<javascript高级程序设计>一书的6.3.5:创建和操作节点一节中,介绍了几种动态创建html节点的方法,其中有以下几种常见方法: · crateAttribute(name): ...

  2. sharepoint 2010 如何创建文档库内容类型content type

    转:http://biancheng.dnbcw.info/linux/441643.html 这次主要是记录下,如何来创建文档内容类型,例如新建文档的时候,可以选择不同模板,有word,excel文 ...

  3. 为Github项目创建文档

    有两种编写方式: In reStructuredText In Markdown In reStructuredText  工具:  pip install sphinx sphinx-autobui ...

  4. 后台生成EXCEL文档,自定义列

    后台生成EXCEL文档,自定义列 //response输出流处理 //设置编码.类型.文件名 getResponse().reset(); getResponse().setCharacterEnco ...

  5. EBS WEBADI无法创建文档

    有些小伙伴在使用WEBADI时,下载模板之后会发现模板创建文档一直没有成功(没有报错,只是单纯的没有创建出文档),可以参考: http://blog.csdn.net/cyco008/article/ ...

  6. SharePoint Online 创建文档库

    前言 本文介绍如何在Office 365中创建文档库,以及文档库的一些基本设置. 正文 通过登录地址登录到Office 365的SharePoint Online站点中,我们可以在右上角的设置菜单中, ...

  7. 跟我学SharePoint 2013视频培训课程——怎样创建文档库并上传文档(8)

    课程简介 第8天,怎样在SharePoint 2013怎样创建文档库并上传文档. 视频 SharePoint 2013 交流群 41032413

  8. JS性能优化之创建文档碎片(document.createDocumentFragment)

    讲这个方法之前,我们应该先了解下插入节点时浏览器会做什么.         在浏览器中,我们一旦把节点添加到document.body(或者其他节点)中,页面就会更新并反映出这个变化,对于少量的更新, ...

  9. 【js基础修炼之路】--创建文档碎片document.createDocumentFragment()

          讲这个方法之前,我们应该先了解下插入节点时浏览器会做什么.         在浏览器中,我们一旦把节点添加到document.body(或者其他节点)中,页面就会更新并反映出这个变化,对于 ...

随机推荐

  1. ubuntu14.04下 Android虚拟机 genymotion 的下载和安装

    官网:https://www.genymotion.com/ Install Guide https://www.genymotion.com/#!/developers/user-guide#ins ...

  2. Servlet 小试牛刀(doGet,doPost)

    实验说明: 通过javax.servlet.http下的HttpServlet,HttpServletRequest,HttpServletResponse来完成一些常用Servlet实例 java代 ...

  3. uboot环境变量初始化

    一.环境变量概述 1.环境变量的概念 可以理解为用户对软件的全局配置信息,这部分信息应该可以从永久性存储器上读取,能被查询,能被修改. 启动过程中,应该首先把环境变量读取到合适的内存区域,然后利用环境 ...

  4. ios开发之C语言第一天

    最近在学习ios开发,先学习C语言,再学习OC和swift.正所谓"万丈高楼平地起",打好基础是很重要的,所以C语言也必须好好学习.学习中所使用的操作系统是OS X,开发工具是Xc ...

  5. 学习Swift -- 构造器(下)

    构造器(下) 可失败的构造器 如果一个类,结构体或枚举类型的对象,在构造自身的过程中有可能失败,则为其定义一个可失败构造器,是非常有必要的.这里所指的“失败”是指,如给构造器传入无效的参数值,或缺少某 ...

  6. INI解析模块的C++实现

    INI文件格式是某些平台或软件上的配置文件的非正式标准,以节(section)和键(key)构成,常用于微软Windows操作系统中. 节(section) 节用方括号括起来,单独占一行,例如: [s ...

  7. IbatisNet开发使用小结

    一.   介绍 平常做企业级应用,需求变化是经常的事,而很多基础代码重复也是很让人头疼的问题.所以很多人会使用一些ORM框架来增强项目的可维护性.可扩展性.IBatis.Net就是一个比较易用的ORM ...

  8. bzoj 3624: [Apio2008]免费道路 生成树的构造

    3624: [Apio2008]免费道路 Time Limit: 2 Sec  Memory Limit: 128 MBSec  Special JudgeSubmit: 111  Solved: 4 ...

  9. Nodejs 集成到IIS

    http://www.hanselman.com/blog/WebMatrixAndNodejsTheEasiestWayToGetStartedWithNodeOnWindows.aspx http ...

  10. 运行时改变控件的大小(点击后立刻ReleaseCapture,然后计算位移,最后发消息改变位置)——最有趣的是TPanel其实也有窗口标题,因此可发HTCAPTION消息

    //光标在控件不同位置时的样式 // 由于拐角这点手动精确实在困难 所以用范围 范围+3 这样很容易就找到这一点了 procedure CtrlMouseMove(Ctrl: TWinControl; ...