Навигация по документации

Команды навигации предназначены для связывания страниц документа в осмысленной последовательности. Ниже представлена последовательность комментариев QDoc, демонстрирующая типичное использование команд навигации.

Пример

 /*!
     \page basicqt.html
     \contentspage {Basic Qt} {Contents}
     \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
    \contentspage {Basic Qt} {Contents}
    \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
    \contentspage {Basic Qt} {Contents}

    \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
*/

QDoc отображает страницу «Начало работы» в creatingdialogs.html:

[Предыдущая: Основные принципы Qt] [Содержание] [Следующая: Создание диалоговых окон]
Начало работы
В этой главе показано, как объединить базовые возможности C++ с функциональностью Qt для создания нескольких небольших графических интерфейсов (GUI) приложений.
[Предыдущая: Основные принципы Qt] [Содержание] [Следующая: Создание диалоговых окон]

Команды \indexpage и \startpage создают ссылки на страницу индекса и стартовую страницу документа. Эти ссылки могут использоваться браузерами и поисковыми системами.

Страница индекса обычно представляет собой алфавитный список заголовков и тем документа, в то время как стартовая страница — это страница, которую автор считает отправной точкой многостраничного документа.

Ссылки включаются в сгенерированный исходный код HTML, но не оказывают визуального влияния на документацию:

<head>
    ...
    <link rel="index" href="index.html" />
    <link rel="start" href="basicqt.html" />
    ...
</head>

Команды

\previouspage

Команда \previouspage связывает текущую страницу с предыдущей страницей в последовательности. Команда имеет два аргумента, каждый заключён в фигурные скобки: первый — целевой объект ссылки (заголовок предыдущей страницы), второй — текст ссылки. Если заголовок страницы эквивалентен тексту ссылки, второй аргумент можно опустить.

Команда должна стоять на отдельной строке.

\nextpage

Команда \nextpage связывает текущую страницу со следующей страницей в последовательности. Команда использует тот же синтаксис и соглашение об аргументах, что и команда \previouspage.

\startpage

Команда \startpage указывает первую страницу последовательности страниц. Команда должна стоять на отдельной строке, и ее единственным аргументом является заголовок первого документа.

QDoc сгенерирует ссылку на стартовую страницу и включит её в сгенерированный HTML-файл, но это не повлияет на визуальное представление документации. Тип сгенерированной ссылки сообщает браузерам и поисковым системам, какой документ автор считает отправной точкой коллекции.

\contentspage

Команда \contentspage связывает текущую страницу со страницей оглавления. Команда использует тот же синтаксис и соглашение об аргументах, что и команда \previouspage.

\indexpage

Команда \indexpage определяет страницу индекса для текущего документа. Команда должна стоять на отдельной строке, и её единственным аргументом является заголовок индексного документа.

QDoc сгенерирует ссылку на страницу индекса и включит её в сгенерированный HTML-файл, но это не повлияет на визуальное представление документации. Тип сгенерированной ссылки сообщает браузерам и поисковым системам, какой документ автор считает страницей индекса коллекции.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.11/15-qdoc-commands-navigation.html