<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qdoc-manual-qdocconf.qdoc -->
<title>HTML Specific Configuration Variables | QDoc Manual 5.9</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.9</td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >HTML Specific Configuration Variables</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.9.4 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<link rel="prev" href="23-qdoc-configuration-cppvariables.html" />
<link rel="next" href="25-qdoc-configuration-derivedprojects.html" />
<p class="naviNextPrevious headerNavi">
<a class="prevPage" href="23-qdoc-configuration-cppvariables.html">C++ Specific Configuration Variables</a>
<span class="naviSeparator"> ◦ </span>
<a class="nextPage" href="25-qdoc-configuration-derivedprojects.html">Supporting Derived Projects</a>
</p><p/>
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#html-footer">HTML.footer</a></li>
<li class="level1"><a href="#html-postheader">HTML.postheader</a></li>
<li class="level1"><a href="#html-style">HTML.style</a></li>
<li class="level1"><a href="#html-stylesheets">HTML.stylesheets</a></li>
<li class="level1"><a href="#html-tocdepth">HTML.tocdepth</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">HTML Specific Configuration Variables</h1>
<span class="subtitle"></span>
<!-- $$$24-qdoc-configuration-htmlvariables.html-description -->
<div class="descr"> <a name="details"></a>
<p>The HTML specific configuration variables define the generated documentation's style, or define the contents of the documentation's footer or postheader. The format of the variable values are raw HTML.</p>
<a name="html-footer-variable"></a><a name="html-footer"></a>
<h2 id="html-footer">HTML.footer</h2>
<p>The <code>HTML.footer</code> variable defines the content of the generated HTML documentation's footer.</p>
<p>The footer is rendered at the bottom of the generated documentation page.</p>
<p>The variable's value is given as raw HTML code enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.</p>
<pre class="cpp plain">
HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
...
"</tr></table></div></address>"
</pre>
<a name="html-postheader-variable"></a><a name="html-postheader"></a>
<h2 id="html-postheader">HTML.postheader</h2>
<p>The <code>HTML.postheader</code> variable defines the content of the generated HTML documentation's postheader.</p>
<p>The header is rendered at the top of the generated documentation page.</p>
<p>The variable's value is given as raw HTML enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.</p>
<pre class="cpp plain">
HTML.postheader = "<table border=\"0\"..." \
...
"<img src=\"images/qt-logo.png\" \
"align=\"right\" width=\"203\" height=\"32\""\
"border=\"0\" />" \
"</td></tr>" \
"</table>"
</pre>
<p>The complete variable entry in <a href="21-2-qtgui-qdocconf.html">qtgui.qdocconf</a> provides the standard header of the <a href="http://doc.qt.io/qt-5/qtgui-index.html">Qt GUI Documentation</a>.</p>
<a name="html-style-variable"></a><a name="html-style"></a>
<h2 id="html-style">HTML.style</h2>
<p>The HTML.style variable defines the style for the generated HTML documentation.</p>
<p>The variable's value is given as raw HTML enclosed by quotation marks. Note that if the value spans several lines, each line needs to be enclosed by quotation marks.</p>
<pre class="cpp plain">
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; }"
</pre>
<a name="html-stylesheets-variable"></a><a name="html-stylesheets"></a>
<h2 id="html-stylesheets">HTML.stylesheets</h2>
<p>The HTML.stylesheets variable defines a list of stylesheets to use for the generated HTML documentation.</p>
<p>Using separate stylesheets for the documentation makes it easier to customize and experiment with the style used once the contents has been generated. Typically, it is only necessary to define a single stylesheet for any set of documentation; for example:</p>
<pre class="cpp plain">
HTML.stylesheets = classic.css
</pre>
<p>QDoc expects to find stylesheets in the directory containing the <a href="21-2-qtgui-qdocconf.html">qtgui.qdocconf</a> file, and it will copy those specified to the output directory alongside the HTML pages.</p>
<a name="html-tocdepth"></a><a name="html-tocdepth"></a>
<h2 id="html-tocdepth">HTML.tocdepth</h2>
<p>The HTML.tocdepth variable defines how many document sections are printed in the table of contents. Setting tocdepth to <code>0</code> disables the table of contents while not setting the variable prints all document sections.</p>
</div>
<!-- @@@24-qdoc-configuration-htmlvariables.html -->
<p class="naviNextPrevious footerNavi">
<a class="prevPage" href="23-qdoc-configuration-cppvariables.html">C++ Specific Configuration Variables</a>
<span class="naviSeparator"> ◦ </span>
<a class="nextPage" href="25-qdoc-configuration-derivedprojects.html">Supporting Derived Projects</a>
</p>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2017 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
