Formatspezifische Konfigurationsvariablen

Die formatspezifischen Konfigurationsvariablen legen den Stil der generierten Dokumentation fest oder definieren den Inhalt der Fußzeile bzw. der Kopfzeile der Dokumentation.

Einige der Konfigurationswerte sind nur für das HTML-Ausgabeformat relevant, und ihre Werte enthalten reines HTML.

HTML.footer

Die Variable „ HTML.footer “ definiert den Inhalt der Fußzeile der generierten HTML-Dokumentation.

Die Fußzeile wird am Ende der generierten Dokumentationsseite angezeigt.

Der Wert der Variable wird als reiner HTML-Code angegeben, der in Anführungszeichen eingeschlossen ist. Beachten Sie, dass bei mehrzeiligem Wert jede Zeile in Anführungszeichen gesetzt werden muss.

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

<FORMAT>.nosubdirs

Ein boolescher Wert, der bei der Einstellung „ true “ den Ausgabemodus mit einem einzigen Verzeichnis aktiviert; alle generierten Dateien werden in das Verzeichnis „FORMAT.outputsubdir“ gespeichert, anstatt in ein Unterverzeichnis, das auf dem Namen des Dokumentationsprojekts basiert.

<FORMAT>.outputsubdir

Definiert das Unterverzeichnis unter „outputdir“, in dem die Dokumentation generiert wird.

HTML.nosubdirs = true
HTML.outputsubdir = html

In diesem Fall wird die Ausgabe unter „ <outputdir>/html “ abgelegt.

HTML.postheader

Die Variable „ HTML.postheader “ definiert den Inhalt des Postheaders der generierten HTML-Dokumentation.

Der Header wird oben auf der generierten Dokumentationsseite direkt nach dem öffnenden <body> -Element angezeigt.

Der Wert der Variablen wird als reines HTML zwischen Anführungszeichen angegeben. Beachten Sie, dass bei einem mehrzeiligen Wert jede Zeile durch Anführungszeichen umschlossen werden muss.

Nach der Darstellung des Inhalts von ` HTML.postheader` gibt QDoc die Breadcrumb-Navigation der Seite als eine Reihe von ` <li> `-Elementen aus. Daher muss `postheader` mit einem gültigen übergeordneten Element für ` <li>` enden, beispielsweise ` <ul>`. Der Standardwert für ` HTML.postheader ` lautet

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

Siehe auch HTML.postpostheader.

HTML.postpostheader

Die Variable „ HTML.postpostheader “ definiert den Inhalt, der den Postheader des HTML-Dokuments und die darin enthaltene Liste der Breadcrumb-Navigationselemente abschließt. Ihr Wert muss das entsprechende schließende Tag für das Listenelement enthalten, das in HTML.postheader.

Der Standardwert für ` HTML.postpostheader ` lautet

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

<FORMAT>.quotinginformation

Ein boolescher Wert, der bei „ true “ Verweise auf in Anführungszeichen gesetzten Inhalt generiert (zum Beispiel \quotefromfile und \snippet Befehle) anstelle einer direkten Einbindung des Inhalts.

Wird derzeit für das Ausgabeformat „ WebXML “ verwendet.

WebXML.quotinginformation = true

HTML.style

Die Variable „HTML.style“ definiert den Stil für die generierte HTML-Dokumentation.

Der Wert der Variablen wird als reines HTML angegeben, das in Anführungszeichen eingeschlossen ist. Beachten Sie, dass bei mehrzeiligem Wert jede Zeile durch Anführungszeichen eingeschlossen werden muss.

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

Die Variable „HTML.stylesheets“ definiert eine Liste von Stylesheets, die für die generierte HTML-Dokumentation verwendet werden sollen.

Die Verwendung separater Stylesheets für die Dokumentation erleichtert es, den Stil anzupassen und damit zu experimentieren, sobald der Inhalt generiert wurde. In der Regel ist es ausreichend, für einen Dokumentationssatz nur ein einziges Stylesheet zu definieren; zum Beispiel:

HTML.stylesheets = path/to/classic.css

QDoc erwartet, dass sich die Stylesheets in dem Verzeichnis befinden, das die Datei „qtgui.qdocconf“ enthält, und kopiert die dort angegebenen Stylesheets zusammen mit den HTML-Seiten in das Ausgabeverzeichnis.

<FORMAT>.tocdepth

Die Variable „ <FORMAT>.tocdepth “ legt fest, wie viele Dokumentabschnitte im Inhaltsverzeichnis aufgeführt werden. Wenn „tocdepth“ auf „ 0 “ gesetzt wird, wird das Inhaltsverzeichnis deaktiviert; wird der Wert nicht festgelegt, werden alle Dokumentabschnitte aufgeführt.

Derzeit wirkt sich diese Einstellung nur auf das HTML-Format aus:

HTML.tocdepth = 3