Doc: Add a template for a tool documentation front page
Change-Id: I4f8c1731dd8ab7a5f32e5580e45ea1fafdc08960 Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Inkamari Harjula <inkamari.harjula@qt.io> Reviewed-by: Esa Törmänen <esa.tormanen@qt.io> Reviewed-by: Teea Põldsam <teea.poldsam@qt.io> Reviewed-by: Safiyyah Moosa <safiyyah.moosa@qt.io>
38
doc/global/tools-doc-front-page/README.md
Normal file
@ -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`.
|
BIN
doc/global/tools-doc-front-page/images/api-reference.png
Normal file
After Width: | Height: | Size: 5.7 KiB |
BIN
doc/global/tools-doc-front-page/images/app-development.png
Normal file
After Width: | Height: | Size: 6.2 KiB |
BIN
doc/global/tools-doc-front-page/images/build-32x32.png
Normal file
After Width: | Height: | Size: 1.7 KiB |
BIN
doc/global/tools-doc-front-page/images/demo-32x32.png
Normal file
After Width: | Height: | Size: 978 B |
BIN
doc/global/tools-doc-front-page/images/getting-started.png
Normal file
After Width: | Height: | Size: 4.6 KiB |
BIN
doc/global/tools-doc-front-page/images/ide.png
Normal file
After Width: | Height: | Size: 5.3 KiB |
BIN
doc/global/tools-doc-front-page/images/installation.png
Normal file
After Width: | Height: | Size: 4.3 KiB |
After Width: | Height: | Size: 4.9 KiB |
BIN
doc/global/tools-doc-front-page/images/settings-32x32.png
Normal file
After Width: | Height: | Size: 2.1 KiB |
BIN
doc/global/tools-doc-front-page/images/tutorials.png
Normal file
After Width: | Height: | Size: 4.0 KiB |
78
doc/global/tools-doc-front-page/tool-name.qdoc
Normal file
@ -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 <Qt Tool> Documentation
|
||||
|
||||
\raw HTML
|
||||
<style>
|
||||
.main-navigation table { table-layout: fixed; }
|
||||
.main-navigation table tr:first-child { text-align: center; background: none; }
|
||||
</style>
|
||||
\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}
|
||||
|
||||
<Short description of how to install the tool>
|
||||
|
||||
\l {Installation}
|
||||
\li \b {GETTING STARTED}
|
||||
|
||||
<Short description of the topics in the GS section>
|
||||
|
||||
\l{Getting Started}
|
||||
\li \b {TUTORIALS}
|
||||
|
||||
<Short description of the tutorials>
|
||||
|
||||
\l{Tutorials}
|
||||
\endtable
|
||||
\enddiv
|
||||
|
||||
\section1 About
|
||||
|
||||
<Short description of the tool>
|
||||
|
||||
\b {ALL TOPICS}
|
||||
|
||||
\raw HTML
|
||||
<style>
|
||||
.link-list table { table-layout: fixed; }
|
||||
.link-list table, .link-list table tr:first-child { background: none; border: none; }
|
||||
</style>
|
||||
\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 <Topic category 1>
|
||||
\list
|
||||
\li <link to a topic>
|
||||
\li <link to a topic>
|
||||
\endlist
|
||||
\li <Topic category 2>
|
||||
\li <link to a topic>
|
||||
\li <link to a topic>
|
||||
\endlist
|
||||
\li <Topic category 3>
|
||||
\list
|
||||
\li <link to a topic>
|
||||
\li <link to a topic>
|
||||
\endlist
|
||||
\endtable
|
||||
\enddiv
|
||||
*/
|