创建帮助项目文件

概述

Qt 助手使用一种管理系统来管理 Qt 文档，该系统要求 QDoc 生成文件清单。

QDoc 允许使用配置变量来指定其在生成的每个文档集中使用的页面。这些变量指定为 qhp 变量的子变量，每个设置使用一个唯一的标识符作为子变量。

例如，Qt Quick 文档集的配置文件使用带有 qhp.QtQuick 前缀的子变量指定关于该集的信息

qhp.projects = QtQuick

qhp.QtQuick.file                = qtquick.qhp
qhp.QtQuick.namespace           = org.qt-project.qtquick.$QT_VERSION_TAG
qhp.QtQuick.virtualFolder       = qtquick
qhp.QtQuick.indexTitle          = Qt Quick
qhp.QtQuick.indexRoot           =

qhp.QtQuick.subprojects         = qmltypes classes examples

qhp.QtQuick.subprojects.qmltypes.title = QML Types
qhp.QtQuick.subprojects.qmltypes.indexTitle = Qt Quick QML Types
qhp.QtQuick.subprojects.qmltypes.selectors = qmlclass
qhp.QtQuick.subprojects.qmltypes.sortPages = true

qhp.QtQuick.subprojects.classes.title = Classes
qhp.QtQuick.subprojects.classes.title = C++ Classes
qhp.QtQuick.subprojects.classes.indexTitle = Qt Quick C++ Classes
qhp.QtQuick.subprojects.classes.selectors = class fake:headerfile
qhp.QtQuick.subprojects.classes.sortPages = true

qhp.QtQuick.subprojects.examples.title = Examples
qhp.QtQuick.subprojects.examples.indexTitle = Qt Quick Examples and Tutorials
qhp.QtQuick.subprojects.examples.selectors = fake:example

文档集可能包含一个或多个子项目，这些子项目将按 title 中指定的名称添加到目录表中。通过 indexTitle 指引的文档页面作为子项目的索引页面。要列在子项目下的页面类型由 selectors 指定。如果将 sortPages 设置为 true，条目将按字母顺序排序。

使用选择器

《code translate="no">selectors 属性指定在子项目目录条目下列出哪些页面类型。可以列出多个选择器，用空白符分隔。

选择器	描述
`namespace`	命名空间
`class`	类
`qmltype`	QML 类型
`qmlclass`	等同于 `qmltype`。
`module[:name]`	C++ 模块或具有指定名称的模块的成员。
`qmlmodule[:name]`	QML 模块或具有指定名称的模块的成员。
`doc[:subtype]`	具有指定 `subtype` 的文档页面。可以列出多个子类型，用逗号分隔。
`fake`	等同于 `doc`。
`group[:groupname]`	为使用 \ingroup 命令添加到指定组的成员的文档页面。可以列出多个组名，用逗号分隔。（自 QDoc 5.6 介绍）。

doc 选择器的可用子类型

子类型	描述
`example`	示例
`headerfile`	头文件
`page`	使用 \page 命令定义的文档页面。

例如，以下配置选择示例页面和包含 \ingroup tutorials 命令的页面

qhp.QtQuickControls.subprojects = examples
qhp.QtQuickControls.subprojects.examples.title = Examples and Tutorials
qhp.QtQuickControls.subprojects.examples.indexTitle = Qt Quick Controls Examples
qhp.QtQuickControls.subprojects.examples.selectors = doc:example group:tutorials
qhp.QtQuickControls.subprojects.examples.sortPages = true

添加目录

为了为手册创建目录，创建一个具有type属性的分项目，并将其设置为manual。由indexTitle属性引用的文档页面必须包含一个列表，该列表作为整个手册的目录。QDoc将使用这个列表中的信息为分项目创建目录。

例如，Qt Creator的配置文件仅为其文档定义了一个分项目，包括所有单本手册中的文档。

qhp.QtCreator.subprojects = manual
qhp.QtCreator.subprojects.manual.title = Qt Creator Manual
qhp.QtCreator.subprojects.manual.indexTitle = Qt Creator Manual
qhp.QtCreator.subprojects.manual.type = manual

在此示例中，“Qt Creator手册”标题的页面包含指向文档中页面的嵌套列表链接，这些链接在Qt Assistant的“内容”标签中重复。

通用配置变量特定格式的配置变量