Dokument-Navigation
Die Navigationsbefehle dienen dazu, die Seiten eines Dokuments in einer sinnvollen Reihenfolge zu verknüpfen. Nachfolgend finden Sie eine Folge von QDoc-Kommentaren, die eine typische Verwendung der Navigationsbefehle zeigt.
Beispiel
/*!
\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
*/Der \startpage erstellt einen Link zu der Seite, die der Autor als erste Seite eines mehrseitigen Dokuments wünscht.
Der Link wird in den generierten HTML-Quellcode aufgenommen, hat aber keine visuelle Auswirkung auf die Dokumentation:
<head> ... <link rel="start" href="basicqt.html" /> ... </head>
Befehle
\previouspage
Der Befehl \previouspage verknüpft die aktuelle Seite mit der vorherigen Seite in einer Folge. Der Befehl hat zwei Argumente, die jeweils von geschweiften Klammern umschlossen sind: Das erste ist das Linkziel (der Titel der vorherigen Seite), das zweite ist der Linktext. Wenn der Titel der Seite mit dem Linktext übereinstimmt, kann das zweite Argument weggelassen werden.
Der Befehl muss für sich allein in einer eigenen Zeile stehen.
\nextpage
Der Befehl \nextpage verlinkt die aktuelle Seite mit der nächsten Seite in einer Sequenz. Der Befehl folgt der gleichen Syntax und Argumentkonvention wie der Befehl \previouspage Befehl.
\startpage
Der Befehl \startpage gibt die erste Seite einer Folge von Seiten an. Der Befehl muss allein in einer eigenen Zeile stehen, und sein einziges Argument ist der Titel des ersten Dokuments.
QDoc erzeugt einen Link auf die Startseite und fügt ihn in die generierte HTML-Datei ein, was aber keine visuelle Auswirkung auf die Dokumentation hat. Der generierte Link-Typ teilt Browsern und Suchmaschinen mit, welches Dokument vom Autor als Startpunkt der Sammlung angesehen wird.
\toc
Die Befehle \toc und \endtoc geben eine Liste von Unterthemen (Seiten) für das Thema an, in dem der Befehl erscheint. Auf der Grundlage der TOC-Einträge zu jedem Thema wird eine Inhaltsverzeichnis-Hierarchie (TOC) für das gesamte Dokumentationsprojekt erstellt.
Innerhalb des \toc... \endtoc Blocks, verwenden Sie \tocentry Befehle, um die Unterthemen nach Titel zu spezifizieren. Wie der Befehl \l (link) nimmt \tocentry ein optionales zweites Argument für den für den Benutzer sichtbaren Titel im generierten TOC-Eintrag.
/*!
\page index.html
\title Qt
...
\toc
\tocentry {Introduction to Qt} {Introduction}
\tocentry {What's new in Qt} {What's new}
\tocentry {Getting started}
\endtoc
*/\tocBefehle können nicht verschachtelt werden. Jedes Unterthema kann jedoch seine eigenen TOC-Einträge angeben. Ein Thema kann nur einen \toc Befehl verwenden.
QDoc schreibt die resultierende Struktur des Inhaltsverzeichnisses im XML-Format in eine Datei <project>_toc.xml.
Hinweis: Das Stammthema (Index oder Landing Page) muss in der Projektkonfiguration entweder mit navigation.landingpage oder navigation.homepage angegeben werden. navigation für weitere Informationen.
Der \toc Befehl wurde mit Qt 6.11 in QDoc eingeführt.
Siehe auch \tocentry.
\tocentry
Gibt ein Unterthema (Seite) als Eintrag im Inhaltsverzeichnis an. Kann nur innerhalb eines Paares von \toc und \endtoc Befehlen verwendet werden.
Der Befehl \tocentry wurde mit Qt 6.11 in QDoc eingeführt.
Siehe auch \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.
