QtLandingPage: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
=Qt Landing Pages=
h1. 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<br /> spend much time in this page, but simply find the necessary link or information he or she needs.
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.


Required components:
Required components:<br />* '''Title'''<br />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 '''&lt;module&amp;gt;<s>index.html*
 
<br />For example, Qt SQL's &quot;landing page&amp;quot;:http://doc.qt.io/qt-5.0/qtsql/qtsql-index.html is in a file in<br />''qtbase/src/sql/qtsql.qdoc''<br /><code><br /> qtsql-index.html<br /> t SQL<br /> A module that provides a driver layer, SQL API layer, and a user<br /> interface layer for SQL databases.<br /></code>
The page name of the landing name should be '''&lt;module&gt;-index.html'''
<br />* '''Brief description'''<br />The brief description is short information on what features the module provides
 
<br />* '''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 />&quot;Qt Quick provides QML types for …&quot; is a good description. Note that this section does not need a section title.
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 />
<br />* '''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<br />important for the reader to know how to link to the module or how to include classes.
 
<br />* '''Reference section'''<br />The reference section contains a list articles, C++ classes, QML types, or examples.
* '''Brief description'''<br /> The brief description is short information on what features the module provides
<br />For examples of a landing page:<br />* &quot;Qt SQL&amp;quot;:http://doc-snapshot.qt.io/5.0/qtsql-index.html<br />* &quot;Qt Network&amp;quot;:http://doc-snapshot.qt.io/5.0/qtnetwork-index.html
 
<br />h2. Related Pages
* '''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.
<br />* [[Qt5DocumentationProject | Qt 5 Documentation Project]]</s> information and statuses of the Qt modules<br />''' [[Qt_Documentation_Structure | Qt 5 Documentation Structure]] - how the documentation files are structured in a module
 
* '''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.
 
* '''Reference section'''<br /> The reference section contains a list articles, C++ classes, <span class="caps">QML</span> types, or examples.
 
For examples of a landing page:
 
* [http://doc-snapshot.qt.io/5.0/qtsql-index.html Qt <span class="caps">SQL</span>] ''[doc-snapshot.qt.io]''
* [http://doc-snapshot.qt.io/5.0/qtnetwork-index.html Qt Network] ''[doc-snapshot.qt.io]''
 
==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

Revision as of 06:29, 24 February 2015

h1. 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&gt;index.html*


For example, Qt SQL's "landing page&quot;:http://doc.qt.io/qt-5.0/qtsql/qtsql-index.html is in a file in
qtbase/src/sql/qtsql.qdoc

<br /> qtsql-index.html<br /> t SQL<br /> A module that provides a driver layer, SQL API layer, and a user<br /> interface layer for SQL databases.<br />


* 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:
* "Qt SQL&quot;:http://doc-snapshot.qt.io/5.0/qtsql-index.html
* "Qt Network&quot;:http://doc-snapshot.qt.io/5.0/qtnetwork-index.html
h2. Related Pages
* Qt 5 Documentation Project
information and statuses of the Qt modules
Qt 5 Documentation Structure - how the documentation files are structured in a module