diff --git a/doc/global/tools-doc-front-page/README.md b/doc/global/tools-doc-front-page/README.md new file mode 100644 index 00000000000..d7a87913994 --- /dev/null +++ b/doc/global/tools-doc-front-page/README.md @@ -0,0 +1,38 @@ +# Qt Tool Documentation Front Page + +The `tool-name.qdoc` file is a template for creating a front page for the +documentation of a Qt tool, such as Qt Creator or Qt Design Studio. + +The purpose of the template is to make it easier for technical writers to create +documentation with a consistent look and feel. It was designed by the Qt UX team. +For this to work, you cannot move the sections around. You can and must change +the text within the angle brackets and check the links. + +## To use the template + +1. Copy the file to the `doc/src` folder in your documentation project. +1. Copy the images that you need from the `images` folder to the `images` folder + in your documentation project. +1. Change the text within angle brackets to fit your tool. + +## Top level table + +The top level table should always have the same three columns: + +- INSTALLATION +- GETTING STARTED +- TUTORIALS + +For best-looking results, try to keep the length of the text in each cell about +the same. + +If you don't have tutorials, you can list some other type of topics here, such as +REFERENCE topics. + +## ALL TOPICS section + +The name and contents of this section depend on your project. For a small doc +set, you can list all topics. For a big doc set, you can group topics. + +In the [Qt Creator Documentation](https://doc.qt.io/qtcreator/index.html), this +section is called `HOW TO`. diff --git a/doc/global/tools-doc-front-page/images/api-reference.png b/doc/global/tools-doc-front-page/images/api-reference.png new file mode 100644 index 00000000000..543d7d1fa3e Binary files /dev/null and b/doc/global/tools-doc-front-page/images/api-reference.png differ diff --git a/doc/global/tools-doc-front-page/images/app-development.png b/doc/global/tools-doc-front-page/images/app-development.png new file mode 100644 index 00000000000..b3333b87c18 Binary files /dev/null and b/doc/global/tools-doc-front-page/images/app-development.png differ diff --git a/doc/global/tools-doc-front-page/images/build-32x32.png b/doc/global/tools-doc-front-page/images/build-32x32.png new file mode 100644 index 00000000000..d6e045b7765 Binary files /dev/null and b/doc/global/tools-doc-front-page/images/build-32x32.png differ diff --git a/doc/global/tools-doc-front-page/images/demo-32x32.png b/doc/global/tools-doc-front-page/images/demo-32x32.png new file mode 100644 index 00000000000..5c42b6f6c3a Binary files /dev/null and b/doc/global/tools-doc-front-page/images/demo-32x32.png differ diff --git a/doc/global/tools-doc-front-page/images/getting-started.png b/doc/global/tools-doc-front-page/images/getting-started.png new file mode 100644 index 00000000000..36b37d47404 Binary files /dev/null and b/doc/global/tools-doc-front-page/images/getting-started.png differ diff --git a/doc/global/tools-doc-front-page/images/ide.png b/doc/global/tools-doc-front-page/images/ide.png new file mode 100644 index 00000000000..dbdb0ef7e0e Binary files /dev/null and b/doc/global/tools-doc-front-page/images/ide.png differ diff --git a/doc/global/tools-doc-front-page/images/installation.png b/doc/global/tools-doc-front-page/images/installation.png new file mode 100644 index 00000000000..6dc6a8e697b Binary files /dev/null and b/doc/global/tools-doc-front-page/images/installation.png differ diff --git a/doc/global/tools-doc-front-page/images/platform-and-toolchain.png b/doc/global/tools-doc-front-page/images/platform-and-toolchain.png new file mode 100644 index 00000000000..7f8a6be7f22 Binary files /dev/null and b/doc/global/tools-doc-front-page/images/platform-and-toolchain.png differ diff --git a/doc/global/tools-doc-front-page/images/settings-32x32.png b/doc/global/tools-doc-front-page/images/settings-32x32.png new file mode 100644 index 00000000000..5c7202a30a6 Binary files /dev/null and b/doc/global/tools-doc-front-page/images/settings-32x32.png differ diff --git a/doc/global/tools-doc-front-page/images/tutorials.png b/doc/global/tools-doc-front-page/images/tutorials.png new file mode 100644 index 00000000000..7044a2625a1 Binary files /dev/null and b/doc/global/tools-doc-front-page/images/tutorials.png differ diff --git a/doc/global/tools-doc-front-page/tool-name.qdoc b/doc/global/tools-doc-front-page/tool-name.qdoc new file mode 100644 index 00000000000..ec628eb216d --- /dev/null +++ b/doc/global/tools-doc-front-page/tool-name.qdoc @@ -0,0 +1,78 @@ +// Copyright (C) 2024 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \page index.html + \nextpage creator-how-to-install.html + + \title Documentation + + \raw HTML + + \endraw + + \div {class="main-navigation"} + \table borderless 100% + \row + \li \inlineimage icons/installation.png + \li \inlineimage icons/getting-started.png + \li \inlineimage icons/tutorials.png + \row + \li \b {INSTALLATION} + + + + \l {Installation} + \li \b {GETTING STARTED} + + + + \l{Getting Started} + \li \b {TUTORIALS} + + + + \l{Tutorials} + \endtable + \enddiv + + \section1 About + + + + \b {ALL TOPICS} + + \raw HTML + + \endraw + + \div {class="link-list"} + \table 100% + \row + \li \inlineimage icons/demo-32x32.png + \li \inlineimage icons/build-32x32.png + \li \inlineimage icons/settings-32x32.png + \row + \li + \list + \li + \li + \endlist + \li + \li + \li + \endlist + \li + \list + \li + \li + \endlist + \endtable + \enddiv +*/