特定格式的配置变量

格式特定配置变量用于定义生成的文档样式，或定义文档页脚或页眉的内容。

部分配置值仅适用于 HTML 输出格式，且其值包含原始 HTML 代码。

HTML.footer 变量用于定义生成的HTML文档页脚的内容。

页脚将显示在生成的文档页面的底部。

该变量的值应为用引号括起的原始 HTML 代码。请注意，如果该值跨多行，则每行都需要用引号括起。

HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
              ...
              "</tr></table></div></address>"

<FORMAT>.nosubdirs

一个布尔值，当其值为true 时，将启用单目录输出模式；所有生成的文件都将存放在FORMAT.outputsubdir目录下，而不是基于文档项目名称的子目录中。

<FORMAT>.outputsubdir

定义outputdir下的子目录，文档将生成在此目录中。

HTML.nosubdirs = true
HTML.outputsubdir = html

根据上述设置，输出文件将位于<outputdir>/html 目录下。

HTML.postheader

HTML.postheader 变量定义了生成的 HTML 文档的页眉内容。

该页眉将显示在生成的文档页面顶部，紧接在<body> 起始标签之后。

该变量的值应以引号括起的原始 HTML 形式给出。请注意，如果值跨越多行，则每行都需要用引号括起来。

在渲染完 `HTML.postheader` 的内容后，QDoc 会将页面的面包屑导航作为一组 `<li> ` 元素输出。因此，`postheader` 必须以 `<li>` 的有效父元素结尾，例如 `<ul>`。`HTML.postheader ` 的默认值为

HTML.postheader = "<ul class=\"breadcrumb\">\n"

另请参阅 HTML.postpostheader。

HTML.postpostheader

HTML.postpostheader 变量定义了用于结束HTML文档的postheader及其所包含的导航面包屑列表项的内容。其值必须包含与在 HTML.postheader中打开的列表元素的匹配结束标签。

HTML.postpostheader 的默认值为

HTML.postpostheader = "</ul>\n"

<FORMAT>.quotinginformation

一个布尔值，当true 时，会生成对带引号内容的引用（例如， \quotefromfile 和 \snippet 命令），而不是直接包含内容。

目前用于WebXML 输出格式。

WebXML.quotinginformation = true

HTML.style

HTML.style 变量用于定义生成的 HTML 文档的样式。

该变量的值应以引号括起的原始 HTML 代码形式给出。请注意，如果值跨越多行，则每行都需要用引号括起来。

HTML.style = "h3.fn,span.fn" \
             "{ margin-left: 1cm; text-indent: -1cm; }\n" \
             "a:link { color: #004faf; text-decoration: none }\n" \
             "a:visited" \
             "{ color: #672967; text-decoration: none }\n" \
             "td.postheader { font-family: sans-serif }\n" \
             "tr.address { font-family: sans-serif }\n" \
             "body { background: #ffffff; color: black; }"

HTML.stylesheets

HTML.stylesheets 变量定义了一组样式表，用于生成 HTML 文档。

为文档使用独立的样式表，可以更方便地在内容生成后对样式进行自定义和调整。通常，对于任何一组文档，只需定义一个样式表即可；例如：

HTML.stylesheets = path/to/classic.css

QDoc 会预期在包含 `qtgui.qdocconf` 文件的目录中查找样式表，并将指定样式表复制到输出目录中，与 HTML 页面放在一起。

<FORMAT>.tocdepth

<FORMAT>.tocdepth 变量用于定义目录中应显示多少个文档章节。将tocdepth设置为0 将禁用目录，而未定义该变量时则会显示所有文档章节。

目前仅对 HTML 格式有效：

HTML.tocdepth = 3

创建帮助项目文件支持派生项目

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.