特定格式的配置变量

特定格式的配置变量定义了生成的文档的风格,或者定义文档页脚或页眉的内容。

一些配置值仅适用于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文档的后页眉内容。

页眉在生成文档页面的顶部渲染。

变量的值以引号包围的原始HTML形式给出。注意,如果值占用了多行,则每行都需要用引号包围。

HTML.postheader = "<table border=\"0\"..." \
                  ...
                  "<img src=\"images/qt-logo.png\" \
                  "align=\"right\" width=\"203\" height=\"32\""\
                 "border=\"0\" />" \
                  "</td></tr>" \
                  "</table>"

qtgui.qdocconf中的完整变量条目提供了Qt GUI文档的标准页眉。

<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

© 2024 The Qt Company Ltd. 包含在此处的文档贡献是其所有者的版权。此处提供的文档根据自由软件基金会发布的GNU自由文档许可协议版本1.3的条款进行许可。Qt和相应的标志是The Qt Company Ltd在芬兰和/或世界其他国家的商标。所有其他商标均为其所有者的财产。