Переменные конфигурации, специфичные для формата

Переменные конфигурации, специфичные для формата, определяют стиль сгенерированной документации, а также содержимое подвала или послезаголовка документации.

Некоторые значения конфигурации актуальны только для формата HTML, и их значения содержат исходный HTML.

HTML.footer

Переменная 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 Documentation.

<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