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

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

設定値の中には、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 ドキュメントのポストヘッダーの内容を定義します。

このヘッダーは、生成されたドキュメントページの上部、<body> 要素の開始タグの直後に表示されます。

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

HTML.postheader のコンテンツをレンダリングした後、QDoc はページのブレッドクラムナビゲーションを<li> 要素のセットとして出力します。したがって、postheader は、<ul> など、<li> の有効な親要素で終わっている必要があります。HTML.postheader のデフォルト値は

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

関連項目 HTML.postpostheader。

HTML.postpostheader

HTML.postpostheader 変数は、HTMLドキュメントのポストヘッダーおよびそこに含まれるナビゲーション用ブレッドクラム項目のリストを閉じるコンテンツを定義します。その値には、 HTML.postheaderで開始されたリスト要素に対応する終了タグを含んでいる必要があります。

HTML.postpostheader のデフォルト値は

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

<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 ドキュメントで使用するスタイルシートのリストを定義します。

ドキュメント用に個別のスタイルシートを使用することで、コンテンツが生成された後に、スタイルのカスタマイズや試行錯誤が容易になります。通常、1 組のドキュメントに対して定義する必要があるスタイルシートは 1 つだけです。例えば、次のようなものです：

HTML.stylesheets = path/to/classic.css

QDoc は、qtgui.qdocconfファイルが含まれるディレクトリ内にスタイルシートが存在することを想定しており、指定されたスタイルシートを HTML ページと同じ出力ディレクトリにコピーします。

<FORMAT>.tocdepth

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

現在、この設定はHTML形式でのみ有効です：

HTML.tocdepth = 3