フォーマット固有の設定変数

フォーマット固有の設定変数は生成されるドキュメントのスタイルを定義したり、ドキュメントのフッターやポストヘッダーの内容を定義したりします。

いくつかの設定値はHTML出力フォーマットにのみ関連し、その値は生のHTMLを含んでいます。

HTML.footer

HTML.footer 変数は生成されるHTMLドキュメントのフッターの内容を定義します。

フッターは生成されたドキュメントページの一番下に表示されます。

変数の値は引用符で囲まれた生のHTMLコードとして与えられます。値が複数の行にまたがる場合は、各行を引用符で囲む必要があることに注意してください。

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

<フォーマット>.nosubdirs

true の場合、単一ディレクトリ出力モードを有効にします。生成されたファイルはすべて、ドキュメント・プロジェクト名に基づいたサブディレクトリではなく、FORMAT.outsubdirディレクトリに移動します。

<FORMAT>.outputsubdir

ドキュメントが生成されるoutputdirの下のサブディレクトリを定義します。

HTML.nosubdirs = true
HTML.outputsubdir = html

上記の場合、出力先は<outputdir>/html になります。

HTML.postheader

HTML.postheader 変数は、生成されるHTMLドキュメントのpostheaderの内容を定義します。

このヘッダーは生成されたドキュメントページの一番上にレンダリングされます。

変数の値は引用符で囲まれた生の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と ˶´﹀`˵コマンド)。

現在、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.スタイルシート

HTML.stylesheets変数は、生成されるHTMLドキュメントに使用するスタイルシートのリストを定義します。

ドキュメントに別々のスタイルシートを使うことで、コンテンツが生成された後に使用されるスタイルのカスタマイズや実験が容易になります。通常、ドキュメントのどのセットに対しても1つのスタイルシートだけを定義する必要があります：

HTML.stylesheets = path/to/classic.css

QDocはqtgui.qdocconfファイルを含むディレクトリでスタイルシートが見つかることを期待し、指定されたものをHTMLページと一緒に出力ディレクトリにコピーします。

<フォーマット>.tocdepth

<FORMAT>.tocdepth 変数は、目次に印刷されるドキュメントセクションの数を定義します。tocdepthを0 に設定すると目次が無効になり、未定義のままにするとすべての文書セクションが印刷されます。

現在のところ、HTMLフォーマットに対してのみ効果があります：

HTML.tocdepth = 3