Variables de configuration spécifiques au format
Les variables de configuration spécifiques au format définissent le style de la documentation générée ou le contenu du pied de page ou de l'en-tête de la documentation.
Certaines valeurs de configuration ne sont pertinentes que pour le format de sortie HTML et leurs valeurs contiennent du HTML brut.
HTML.footer
La variable HTML.footer définit le contenu du pied de page de la documentation HTML générée.
Le pied de page est affiché au bas de la page de la documentation générée.
La valeur de la variable est donnée sous forme de code HTML brut entre guillemets. Notez que si la valeur s'étend sur plusieurs lignes, chaque ligne doit être placée entre guillemets.
HTML.footer = "<p /><address><hr /><div align=\"center\">\n" \
...
"</tr></table></div></address>"<FORMAT>.nosubdirs
Valeur booléenne qui, lorsque true, active le mode de sortie à répertoire unique ; tous les fichiers générés vont dans le répertoire FORMAT.outputsubdir, au lieu d'un sous-répertoire basé sur le nom du projet de documentation.
<FORMAT>.outputsubdir
Définit le sous-répertoire sous outputdir où la documentation est générée.
HTML.nosubdirs = true HTML.outputsubdir = html
Avec ce qui précède, la sortie se fait dans <outputdir>/html.
HTML.postheader
La variable HTML.postheader définit le contenu de l'en-tête de la documentation HTML générée.
L'en-tête est affiché en haut de la page de documentation générée, immédiatement après l'élément d'ouverture <body>.
La valeur de la variable est donnée sous forme de code HTML brut entre guillemets. Notez que si la valeur s'étend sur plusieurs lignes, chaque ligne doit être encadrée par des guillemets.
Après avoir rendu le contenu de HTML.postheader, QDoc produit le fil d'Ariane de la page sous la forme d'un ensemble d'éléments <li>. Par conséquent, postheader doit se terminer par un élément parent valide pour <li>, tel que <ul>. La valeur par défaut pour HTML.postheader est
HTML.postheader = "<ul class=\"breadcrumb\">\n"
Voir aussi HTML.postpostheader.
HTML.postpostheader
La variable HTML.postpostheader définit le contenu qui ferme l'en-tête du document HTML et la liste des éléments du fil d'Ariane de navigation qu'il contient. Sa valeur doit inclure la balise de fermeture correspondante pour l'élément de liste ouvert dans la variable HTML.postheader.
La valeur par défaut de la variable HTML.postpostheader est
HTML.postpostheader = "</ul>\n"
<FORMAT>.quotinginformation
Valeur booléenne qui, lorsque true, génère des références au contenu cité (par exemple, \quotefromfile et \snippet ) au lieu d'inclure le contenu directement.
Utilisé actuellement pour le format de sortie WebXML.
WebXML.quotinginformation = true
HTML.style
La variable HTML.style définit le style de la documentation HTML générée.
La valeur de la variable est donnée sous forme de code HTML brut entre guillemets. Notez que si la valeur s'étend sur plusieurs lignes, chaque ligne doit être entourée de guillemets.
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.feuilles de style
La variable HTML.stylesheets définit une liste de feuilles de style à utiliser pour la documentation HTML générée.
L'utilisation de feuilles de style distinctes pour la documentation facilite la personnalisation et l'expérimentation du style utilisé une fois que le contenu a été généré. En règle générale, il suffit de définir une seule feuille de style pour un ensemble de documents ; par exemple :
HTML.stylesheets = path/to/classic.css
QDoc s'attend à trouver des feuilles de style dans le répertoire contenant le fichier qtgui.qdocconf, et il copiera celles spécifiées dans le répertoire de sortie avec les pages HTML.
<FORMAT>.tocdepth
La variable <FORMAT>.tocdepth définit le nombre de sections du document qui sont imprimées dans la table des matières. Si la valeur de la variable tocdepth est 0, la table des matières est désactivée, tandis que si elle n'est pas définie, toutes les sections du document sont imprimées.
Actuellement, cette variable n'a d'effet que pour le format HTML :
HTML.tocdepth = 3
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. 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.
