QtLandingPage: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
(clean-up)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Qt Landing Pages=
= Qt Landing Pages =
 
Each module requires a landing page. These landing pages act as a hub, containing a list of relevant information for the reader. The reader should not
Each module requires a landing page. These landing pages act as a hub, containing a list of relevant information for the reader. The reader should not<br /> spend much time in this page, but simply find the necessary link or information he or she needs.
spend much time in this page, but simply find the necessary link or information he or she needs.


Required components:
Required components:
* '''Title'''
The title should list the module name. For example, Qt Quick or Qt Core.


* '''Title'''<br /> The title should list the module name. For example, Qt Quick or Qt Core.
The page name of the landing name should be '''<module>-index.html*
 
The page name of the landing name should be '''&lt;module&gt;-index.html'''


For example, Qt <span class="caps">SQL</span>’s [http://doc.qt.io/qt-5.0/qtsql/qtsql-index.html landing page] ''[qt.io]'' is in a file in<br />''qtbase/src/sql/qtsql.qdoc''<br />
For example, Qt SQL's [http://doc.qt.io/qt-5.0/qtsql/qtsql-index.html landing page] is in a file in
''qtbase/src/sql/qtsql.qdoc''
<code>
qtsql-index.html
t SQL
A module that provides a driver layer, SQL API layer, and a user
interface layer for SQL databases.
</code>


* '''Brief description'''<br /> The brief description is short information on what features the module provides
* '''Brief description'''
The brief description is short information on what features the module provides


* '''Module overview'''<br /> The module overview section lists the features, frameworks, submodules, or other things that the module presents. <br /> A good style would be to present the module as a solution to a problem. For example,<br /> “Qt Quick provides <span class="caps">QML</span> types for …” is a good description. Note that this section does not need a section title.
* '''Module overview'''
The module overview section lists the features, frameworks, submodules, or other things that the module presents.
A good style would be to present the module as a solution to a problem. For example,
"Qt Quick provides QML types for …" is a good description. Note that this section does not need a section title.


* '''Getting Started''' Instructions on how to use the module. A small section on how to use the C++ classes or <span class="caps">QML</span> types should be listed. This is<br /> important for the reader to know how to link to the module or how to include classes.
* '''Getting Started''' Instructions on how to use the module. A small section on how to use the C++ classes or QML types should be listed. This is
important for the reader to know how to link to the module or how to include classes.


* '''Reference section'''<br /> The reference section contains a list articles, C++ classes, <span class="caps">QML</span> types, or examples.
* '''Reference section'''
The reference section contains a list articles, C++ classes, QML types, or examples.


For examples of a landing page:
For examples of a landing page:
* [http://doc-snapshot.qt.io/5.0/qtsql-index.html Qt SQL]
* [http://doc-snapshot.qt.io/5.0/qtnetwork-index.html Qt Network]


* [http://doc-snapshot.qt.io/5.0/qtsql-index.html Qt <span class="caps">SQL</span>] ''[doc-snapshot.qt.io]''
== Related Pages ==
* [http://doc-snapshot.qt.io/5.0/qtnetwork-index.html Qt Network] ''[doc-snapshot.qt.io]''
* [[Qt5DocumentationProject | Qt 5 Documentation Project]]- information and statuses of the Qt modules
 
''' [[Qt_Documentation_Structure | Qt 5 Documentation Structure]] - how the documentation files are structured in a module
==Related Pages==
 
* [[Qt5DocumentationProject|Qt 5 Documentation Project]] – information and statuses of the Qt modules
* [[Qt Documentation Structure|Qt 5 Documentation Structure]] – how the documentation files are structured in a module
* [[Documentation|Developing Qt Documentation]] – information about documentation processes

Latest revision as of 12:30, 24 March 2016

Qt Landing Pages

Each module requires a landing page. These landing pages act as a hub, containing a list of relevant information for the reader. The reader should not spend much time in this page, but simply find the necessary link or information he or she needs.

Required components:

  • Title

The title should list the module name. For example, Qt Quick or Qt Core.

The page name of the landing name should be <module>-index.html*

For example, Qt SQL's landing page is in a file in qtbase/src/sql/qtsql.qdoc 

 qtsql-index.html
 t SQL
 A module that provides a driver layer, SQL API layer, and a user
 interface layer for SQL databases.
  • Brief description

The brief description is short information on what features the module provides

  • Module overview

The module overview section lists the features, frameworks, submodules, or other things that the module presents. A good style would be to present the module as a solution to a problem. For example, "Qt Quick provides QML types for …" is a good description. Note that this section does not need a section title.

  • Getting Started Instructions on how to use the module. A small section on how to use the C++ classes or QML types should be listed. This is

important for the reader to know how to link to the module or how to include classes.

  • Reference section

The reference section contains a list articles, C++ classes, QML types, or examples.

For examples of a landing page:

Related Pages

Qt 5 Documentation Structure - how the documentation files are structured in a module

Retrieved from "https://wiki.qt.io/index.php?title=QtLandingPage&oldid=23063"