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 définissent le contenu du pied de page ou de l'en-tête de la documentation.

Certaines valeurs de configuration ne s'appliquent qu'au format de sortie HTML et contiennent du code 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 s'affiche au bas de la page de documentation générée.

La valeur de la variable est fournie 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, lorsqu'elle est définie sur « true », active le mode de sortie à répertoire unique ; tous les fichiers générés sont placés 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 de outputdir dans lequel la documentation est générée.

HTML.nosubdirs = true
HTML.outputsubdir = html

Avec la configuration ci-dessus, les fichiers de sortie sont placés 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 s'affiche 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 fournie 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.

Après avoir affiché le contenu de ` HTML.postheader`, QDoc génère 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 de ` HTML.postheader ` est

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

Voir aussi HTML.postpostheader.

HTML.postpostheader

La variable ` HTML.postpostheader ` définit le contenu qui clôt l'en-tête de publication du document HTML et la liste d'éléments de fil d'Ariane qu'il contient. Sa valeur doit inclure la balise de fermeture correspondante à l'élément de liste ouvert dans HTML.postheader.

La valeur par défaut de HTML.postpostheader est

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

<FORMAT>.quotinginformation

Une valeur booléenne qui, lorsqu’elle est définie sur true, génère des références au contenu entre guillemets (par exemple, \quotefromfile et \snippet ) au lieu d'inclure directement le contenu.

Actuellement utilisé 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 fournie 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.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

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 une fois le contenu généré. En général, il suffit de définir une seule feuille de style pour un ensemble de documentation ; par exemple :

HTML.stylesheets = path/to/classic.css

QDoc s'attend à trouver les feuilles de style dans le répertoire contenant le fichier qtgui.qdocconf, et il copiera celles qui sont spécifiées dans le répertoire de sortie, aux côtés des pages HTML.

<FORMAT>.tocdepth

La variable <FORMAT>.tocdepth définit le nombre de sections du document qui apparaissent dans la table des matières. Si vous définissez tocdepth sur 0, la table des matières est désactivée ; si vous ne définissez pas cette variable, toutes les sections du document sont affichées.

Actuellement, cela n'a d'effet que pour le format HTML :

HTML.tocdepth = 3