From 263d5ff1e61c90e714028340c2a404cbbfc0a0a1 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 18 Mar 2024 16:47:02 +0100 Subject: [PATCH] Doc: Update info about automatically generating navigation links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The \nexpage and \previouspage links in the QDS Manual are now automatically generated according to the list in the "All Topics" topic. Change-Id: If93c605863269056060b1585641feac167d95f25 Reviewed-by: Esa Törmänen Reviewed-by: Mats Honkamaa --- .../src/qtcreator-documentation.qdoc | 40 ++++++++++++++----- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/doc/qtcreatordev/src/qtcreator-documentation.qdoc b/doc/qtcreatordev/src/qtcreator-documentation.qdoc index 9e567c6fd4f..8bd728fad6e 100644 --- a/doc/qtcreatordev/src/qtcreator-documentation.qdoc +++ b/doc/qtcreatordev/src/qtcreator-documentation.qdoc @@ -233,21 +233,41 @@ Save screenshots and other illustrations in \c {\qtdesignstudio\images}. If you add new topics to the \QDS Manual, add links to them to the table - of contents in \c {qtdesignstudio-toc.qdoc} and check the values of the - navigation links around them. + of contents in \c {qtdesignstudio-toc.qdoc}. \section2 Updating Next and Previous Links - QDoc automatically generates links to the previous - and next page in the \QC Manual based on the list in - \c {\qtcreator\doc\qtcreator\src\qtcreator-toc.qdoc}. So, when you add - new topics, you must either add them to the TOC or to a group of topics - (\c {\ingroup}). You can see the current groups in the \e {How To} and + QDoc automatically generates links to the previous and next page in each + manual based on the list in a topic with the title \e {All Topics}, which + is in the following files: + + \list + \li \QC: \c {\qtcreator\doc\qtcreator\src\qtcreator-toc.qdoc} + \li \QDS: \c {\qtcreator\doc\qtdesignstudio\src\qtdesignstudio-toc.qdoc} + \endlist + + The title of the topic to use for automatically generating the navigation + links is set as the value of the \c indexTitle option in the document + configuration file: + + \list + \li \QC: \c qhp.qtcreator.subprojects.manual.indexTitle in + \c {\doc\qtcreator\config\qtcreator-project.qdocconf} + \li \QDS: \c qhp.qtdesignstudio.subprojects.manual.indexTitle in + \c {\doc\qtdesignstudio\config\qtdesignstudio.qdocconf} + \endlist + + When you add new topics, you must add them either to the TOC or to a + group of topics (\c {\ingroup}) that is used to generate a list in the TOC + (\l{https://doc.qt.io/qt-6/12-0-qdoc-commands-miscellaneous.html#generatelist-command} + {\c {\generatelist}}). + + In the \QC Manual, you can see the current groups in the \e {How To} and \e {Reference} sections of the TOC. You can add new groups. - When you add new topics to the \QDS Manual, you must add links to them from - \c {\doc\qtdesignstudio\src\qtdesignstudio-toc.qdoc} and change the - navigation links of the topics around them. + \note You do not need to manually change the navigation links, but they must + be there with some initial values for QDoc to replace with the values from + the TOC when you build the docs. \section1 Adding Documentation for Independent Plugins