Docs: Organize topics in the qtdeclarative/Qt Qml project

This commit organizes the articles, so they:
- have a reasonable tree structure
- can be navigated through the topic tree in the Qt Creator help viewer

Task-number: QTBUG-126648
Change-Id: I49dc5f4d576ef8e715f871bcae1420aaac80f639
Reviewed-by: Topi Reiniö <[email protected]>

3 files changed, 111 insertions, 11 deletions

diff --git a/src/qml/doc/qtqml.qdocconf b/src/qml/doc/qtqml.qdocconf
index b3c24da1b5..59caed1b41 100644
--- a/src/qml/doc/qtqml.qdocconf
+++ b/src/qml/doc/qtqml.qdocconf
@@ -15,19 +15,20 @@ qhp.QtQml.virtualFolder       = qtqml
 qhp.QtQml.indexTitle          = Qt Qml
 qhp.QtQml.indexRoot           =
 
-qhp.QtQml.subprojects         = qmltypes classes examples
-qhp.QtQml.subprojects.classes.title = C++ Classes
-qhp.QtQml.subprojects.classes.indexTitle = Qt Qml C++ Classes
-qhp.QtQml.subprojects.classes.selectors = class headerfile
-qhp.QtQml.subprojects.classes.sortPages = true
-qhp.QtQml.subprojects.examples.title = Examples
-qhp.QtQml.subprojects.examples.indexTitle = Qt Qml Examples
-qhp.QtQml.subprojects.examples.selectors = example
+qhp.QtQml.subprojects = manual qmltypes classes
+qhp.QtQml.subprojects.manual.title = Qt Qml
+qhp.QtQml.subprojects.manual.indexTitle = Qt Qml module topics
+qhp.QtQml.subprojects.manual.type = manual
+
 qhp.QtQml.subprojects.qmltypes.title = QML Types
 qhp.QtQml.subprojects.qmltypes.indexTitle = Qt Qml QML Types
 qhp.QtQml.subprojects.qmltypes.selectors = qmlclass
 qhp.QtQml.subprojects.qmltypes.sortPages = true
 
+qhp.QtQml.subprojects.classes.title = C++ Classes
+qhp.QtQml.subprojects.classes.indexTitle = Qt Qml C++ Classes
+qhp.QtQml.subprojects.classes.selectors = class headerfile
+qhp.QtQml.subprojects.classes.sortPages = true
 
 tagfile                 = ../../../doc/qtqml/qtqml.tags
 
@@ -69,10 +70,10 @@ manifestmeta.thumbnail.names += "QtQml/Chapter 4*" \
 navigation.landingpage = "Qt Qml"
 navigation.cppclassespage = "Qt Qml C++ Classes"
 navigation.qmltypespage = "Qt Qml QML Types"
-# Auto-generate navigation linking based on the \list structures on the following:
-navigation.toctitles = "Qt Quick Compiler"
+# Autogenerate navigation linking based on the \list structures on the following:
+navigation.toctitles = "Qt Qml module topics"
+navigation.toctitles.inclusive = false
 
-navigation.toctitles.inclusive = true
 # suppress qdoc warnings for \instantiates entries
 spurious += "C\\+\\+ class .*\\\\instantiates .*"
 
diff --git a/src/qml/doc/src/qtqml-toc.qdoc b/src/qml/doc/src/qtqml-toc.qdoc
new file mode 100644
index 0000000000..38e37689d9
--- /dev/null
+++ b/src/qml/doc/src/qtqml-toc.qdoc
@@ -0,0 +1,96 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+    \page qtqml-toc.html
+    \title Qt Qml module topics
+
+    The following list has links to all the individual topics (HTML files)
+    in the Qt Qml module.
+
+    \list
+    \li \l{The QML Reference}
+        \list
+            \li \l{QML Syntax Basics}
+            \li \l{Import Statements}
+            \li \l{Importing QML Document Directories}
+            \li \l{QML Object Attributes}
+            \li \l{Property Binding}
+            \li \l{Signal and Handler Event System}
+            \li \l{The QML Type System}
+                \list
+                \li \l{QML Value Types}
+                \li \l{QML Object Types}
+                \li \l{QML Sequence Types}
+                \li \l{QML Namespaces}
+                \endlist
+            \li \l{QML Modules}
+                \list
+                    \li \l{Module Definition qmldir Files}{Specifying a QML module}
+                    \li \l{Identified Modules}
+                    \li \l{Legacy Modules}
+                    \li \l{Creating C++ Plugins for QML}
+                \endlist
+            \li \l{QML Documents}
+                \list
+                    \li \l{Structure of a QML Document}
+                    \li \l{Defining Object Types through QML Documents}{Defining Object Types in QML}
+                    \li \l{Resource Loading and Network Transparency}
+                    \li \l{Scope and Naming Resolution}
+                \endlist
+        \endlist
+    \li \l{Singletons in QML}
+    \li \l{The QML Disk Cache}
+    \li \l{Overview - QML and C++ Integration}{QML and C++ Integration}
+        \list
+            \li \l{Exposing Attributes of C++ Types to QML}
+            \li \l{Defining QML Types from C++}
+            \li \l{Embedding C++ Objects into QML with Context Properties}
+            \li \l{Data Type Conversion Between QML and C++}
+            \li \l{Exposing Attributes of C++ Types to QML}
+            \li \l{Exposing State from C++ to QML}
+            \li \l{Interacting with QML Objects from C++}
+            \li \l{Integrating with JavaScript values from C++}
+            \li \l{Important C++ Classes Provided By The Qt QML Module}{Important C++ Classes}
+            \li \l{Writing QML Extensions with C++}
+            \li \l{Writing advanced QML Extensions with C++}
+        \endlist
+    \li \l{Integrating QML and JavaScript}{QML and JavaScript Integration}
+        \list
+            \li \l{Making Applications Scriptable}
+            \li \l{JavaScript Expressions in QML Documents}{JavaScript Expressions}
+            \li \l{Dynamic QML Object Creation from JavaScript}
+            \li \l{Defining JavaScript Resources in QML}{Defining JavaScript Resources}
+            \li \l{Importing JavaScript Resources in QML}{Importing JavaScript Resources}
+            \li \l{JavaScript Host Environment}
+            \li \l{Memory Management in the JavaScript Engine}
+            \li \l{Configuring the JavaScript Engine}
+            \li \l{QML Global Object}
+            \li \l{List of JavaScript Objects and Functions}
+        \endlist
+    \li \l{Writing QML Modules}
+    \li \l{Qt Qml Tooling}
+        \list
+            \li \l{qmllint Reference}{qmllint}
+            \li \l{qmlformat}
+            \li \l{\QMLLS Reference}{qmlls}
+\omit reason: empty topic           \li \l{qmlprofiler} \endomit
+            \li \l{qml}
+            \li \l{qmlpreview}
+            \li \l{Qt Quick Compiler}
+            \li \l{QML type compiler}
+            \li \l{QML script compiler}
+            \li \l{qmltyperegistrar}
+            \li \l{qmlimportscanner}
+            \li \l{svgtoqml}
+            \li \l{qmlcachegen}
+        \endlist
+    \li \l{Changes to Qt QML}{Upgrade from Qt 5}
+    \li \l{QML Lint Warning and Errors}
+    \li \l{CMake Global Properties in Qt6 Qml}{CMake Global Properties}
+    \li \l{CMake Source File Properties in Qt6 Qml}{CMake Source File Properties}
+    \li \l{CMake Global Variables in Qt6 Qml}{CMake Global Variables}
+    \li \l{Qt Quick I18N}{Example - Qt Quick i18n}
+    \endlist
+
+*/
diff --git a/src/qml/doc/src/tools/qtqml-tooling-qmltyperegistrar.qdoc b/src/qml/doc/src/tools/qtqml-tooling-qmltyperegistrar.qdoc
index 1f2103d1b1..99ae619884 100644
--- a/src/qml/doc/src/tools/qtqml-tooling-qmltyperegistrar.qdoc
+++ b/src/qml/doc/src/tools/qtqml-tooling-qmltyperegistrar.qdoc
@@ -7,4 +7,7 @@
 \brief Overview of the qmltyperegistrar utility.
 \ingroup qtqml-tooling
 
+\c qmltyperegistrar is an internal tool shipped with Qt Qml. It is meant to be
+invoked by the build system only, you don't need to execute it directly.
+
 */