Erstellen von Hilfeprojektdateien , die abgeleitete Projekte unterstützen

Formatspezifische Konfigurationsvariablen

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

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

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

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

Der Wert der Variablen wird als roher HTML-Code angegeben, der in Anführungszeichen gesetzt wird. Wenn sich der Wert über mehrere Zeilen erstreckt, muss jede Zeile in Anführungszeichen gesetzt werden.

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

<FORMAT>.nosubdirs

Ein boolescher Wert, der, wenn er true lautet, den Ausgabemodus mit nur einem Verzeichnis aktiviert; alle erzeugten Dateien werden im Verzeichnis FORMAT.outputsubdir abgelegt, anstatt in einem Unterverzeichnis, das auf dem Namen des Dokumentationsprojekts basiert.

<FORMAT>.outputsubdir

Legt das Unterverzeichnis unter outputdir fest, in dem die Dokumentation erzeugt wird.

HTML.nosubdirs = true
HTML.outputsubdir = html

Bei der obigen Option wird die Ausgabe in <outputdir>/html gespeichert.

HTML.postheader

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

Die Kopfzeile wird am Anfang der generierten Dokumentationsseite angezeigt.

Der Wert der Variablen wird als rohes HTML angegeben und in Anführungszeichen gesetzt. Wenn sich der Wert über mehrere Zeilen erstreckt, muss jede Zeile in Anführungszeichen gesetzt werden.

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

Der vollständige Variableneintrag in qtgui.qdocconf liefert den Standardkopf der Qt GUI Dokumentation.

<FORMAT>.Anführungszeicheninformation

Ein boolescher Wert, der bei true Verweise auf zitierte Inhalte erzeugt (z.B. \quotefromfile und \snippet-Befehle ), anstatt den Inhalt direkt einzuschließen.

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 rohes HTML angegeben, das in Anführungszeichen gesetzt wird. Wenn sich der Wert über mehrere Zeilen erstreckt, muss jede Zeile in Anführungszeichen gesetzt werden.

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 die Anpassung und das Experimentieren mit dem verwendeten Stil, sobald der Inhalt generiert wurde. In der Regel ist es nur notwendig, ein einziges Stylesheet für die gesamte Dokumentation zu definieren, z.B:

HTML.stylesheets = path/to/classic.css

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

<FORMAT>.tocdepth

Die Variable <FORMAT>.tocdepth legt fest, wie viele Abschnitte des Dokuments im Inhaltsverzeichnis gedruckt werden. Wenn Sie tocdepth auf 0 setzen, wird das Inhaltsverzeichnis deaktiviert, und wenn Sie es undefiniert lassen, werden alle Abschnitte des Dokuments gedruckt.

Dies hat derzeit nur Auswirkungen auf das HTML-Format:

HTML.tocdepth = 3