Navigation dans les documents
Les commandes de navigation permettent de relier les pages d'un document dans un ordre significatif. Vous trouverez ci-dessous une séquence de commentaires QDoc qui illustre une utilisation typique des commandes de navigation.
Exemple
/*!
\page basicqt.html
\nextpage Getting Started
\indexpage Index
\startpage Basic Qt
\title Basic Qt
The Qt toolkit is a C++ class library and a set of tools for
building multiplatform GUI programs using a "write once,
compile anywhere approach".
Table of contents:
\list
\li \l {Getting Started}
\li \l {Creating Dialogs}
\li \l {Creating Main Windows}
\endlist
*/
/*!
\page gettingstarted.html
\previouspage Basic Qt
\nextpage Creating Dialogs
\indexpage Index
\startpage Basic Qt
\title Getting Started
This chapter shows how to combine basic C++ with the
functionality provided by Qt to create a few small graphical
interface (GUI) applications.
*/
/*!
\page creatingdialogs.html
\previouspage Getting Started
\indexpage Index
\startpage Basic Qt
\title Creating Dialogs
This chapter will teach you how to create dialog boxes using Qt.
*/
/*!
\page index.html
\indexpage Index
\startpage Basic Qt
\title Index
\list
\li \l {Basic Qt}
\li \l {Creating Dialogs}
\li \l {Getting Started}
\endlist
*/La commande \startpage crée un lien vers la page que l'auteur souhaite voir figurer en première page d'un document multipage.
Le lien est inclus dans le code source HTML généré mais n'a pas d'effet visuel sur la documentation :
<head> ... <link rel="start" href="basicqt.html" /> ... </head>
Commandes
\previouspage
La commande \previouspage permet de relier la page actuelle à la page précédente dans une séquence. La commande a deux arguments, chacun entouré d'accolades : le premier est la cible du lien (le titre de la page précédente), le second est le texte du lien. Si le titre de la page est équivalent au texte du lien, le deuxième argument peut être omis.
La commande doit être autonome sur sa propre ligne.
\nextpage
La commande \nextpage relie la page actuelle à la page suivante dans une séquence. La commande suit la même syntaxe et la même convention d'arguments que la commande \previouspage La commande suit la même syntaxe et la même convention d'arguments que la commande
\startpage
La commande \startpage spécifie la première page d'une séquence de pages. La commande doit être autonome sur sa propre ligne et son unique argument est le titre du premier document.
QDoc génère un lien vers la page d'accueil et l'inclut dans le fichier HTML généré, mais cela n'a aucun effet visuel sur la documentation. Le type de lien généré indique aux navigateurs et aux moteurs de recherche quel document est considéré par l'auteur comme le point de départ de la collection.
\toc
Les commandes \toc et \endtoc spécifient une liste de sous-sujets (pages) pour le sujet dans lequel la commande apparaît. Une hiérarchie de la table des matières (TOC) est générée pour l'ensemble du projet de documentation sur la base des entrées TOC de chaque thème.
Dans le bloc \toc.. \endtoc, utilisez les commandes \tocentry pour spécifier les sous-sujets par titre. Comme la commande \l (lien), \tocentry prend un deuxième argument facultatif pour le titre visible par l'utilisateur dans l'entrée de la table des matières générée.
/*!
\page index.html
\title Qt
...
\toc
\tocentry {Introduction to Qt} {Introduction}
\tocentry {What's new in Qt} {What's new}
\tocentry {Getting started}
\endtoc
*/\tocLes commandes (link) ne peuvent pas être imbriquées. Cependant, chaque sous-sujet peut spécifier ses propres entrées dans la table des matières. Un sujet ne peut utiliser qu'une seule commande \toc.
QDoc écrit la structure de la table des matières résultante au format XML dans un fichier <project>_toc.xml.
Remarque : le sujet racine (index ou page d'atterrissage) doit être spécifié dans la configuration du projet à l'aide de la commande navigation.landingpage ou navigation.homepage. Voir navigation pour plus d'informations.
La commande \toc a été introduite dans QDoc avec Qt XML 6.11.
Voir aussi \tocentry.
\tocentry
Spécifie un sous-sujet (page) comme entrée dans la table des matières. Ne peut être utilisée qu'à l'intérieur d'une paire de commandes \toc et \endtoc.
La commande \tocentry a été introduite dans QDoc avec Qt 6.11.
Voir aussi \toc.
© 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.
