fcf9868eba
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>
1.3 KiB
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
- Copy the file to the
doc/srcfolder in your documentation project. - Copy the images that you need from the
imagesfolder to theimagesfolder in your documentation project. - 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, this
section is called HOW TO.