利用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