基于Qt Assistant的软件帮助文档

By in bet36体育备用网址 on 2020年1月4日

QtAssistant是Qt随附的可重新分发和可自定义的帮助文件浏览器。

QtAssistant支持HTML文件,用户可以使用它们来自定义功能强大的帮助文档查找器。

QtAssistant个性化信息主要是QtAssistant提供的英文文档。解释会更详细,但是对于初学者来说,立即开始很难。

因此,结合特定的实践,我们希望QtAssistant定制过程能够组织起来并启发其他人。

定制过程使用四种不同格式的文件:qhp,qch,qhcp和qhc。

初学者通常会对这四个文件感到困惑。

首先,我将解释这四种文件格式。

这四个文件可以分为两组:(1)qhp和qch。

qhp是QtHelpProject的缩写,而qch是QtCompressedHelp的缩写。

qhp文件组织实际的帮助文件(通常是HTML文件,即QtAssistant检查的文件),并使用qhelpgenerator命令生成压缩的qch文件。

qch文件是QtAssistant可以识别的最小文档单位。使用QtAssistant-Edit-Preferences-Documents选项卡的Add / Remove操作注册或取消qch文件注册。

您也可以使用assistant-registerdoc命令。

qch注册qch文件。

注册后,您可以在向导界面中查看帮助文档。

(2)qhcp和qhc。

qhcp是QtHelpCollectionProject的缩写,其主要功能是组织集合中的二进制qch文件并自定义自定义助手。qhc是由qcollectiongenerator命令生成的二进制文件。启动向导时,必须指定收集参数,即qhc文件。

qhc文件是qch文件的集合。向导打开后,您可以通过指定当前集合来注册多个帮助文档。

从前面的文件描述中,您必须手动完成两个文件qhp和qhcp文件,并最终从这两个文件生成所需的qch和qhc文件。

qhp和qhcp文件是XML文件,语法相对简单。我们在这里不会详细介绍语法。有关详细信息,请参见QtAssistant帮助文档。

以下是我项目中助手个性化过程的概述,并提供了所用qhp和qhcp文件的内容。这将帮助您了解整个过程。

生产步骤如下:(1)创建一个HTML帮助文件。

HTML文件是需要在许多HTML文件中表达的东西。

例如,我的图像是:image文件夹用于存储帮助文档所需的所有图像,其他html文件均为描述性内容。

(2)编写qhp文件。

以下是项目中使用的qhp文件。这个文件比较简单。此处仅使用基本功能,帮助文档中描述了特定的语法。

请注意,帮助文档目录由标签指定。您可以具有多个级别的目录,但是Qt建议使用4个级别或更少的级别。

指定目录后,必须指定将使用的所有HTML文件,包括HTML文件中使用的所有图像。

如果未在此处指定,则将生成的qch文件注册到QtAssistant后,找不到要显示的有效文件。

我的qph文件如下所示:


Comments are closed.