QtLandingPage: Difference between revisions
AutoSpider (talk | contribs) (Add "cleanup" tag) |
(clean-up) |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
= 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 | ||
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. | ||
| Line 12: | Line 9: | ||
The page name of the landing name should be '''<module>-index.html* | The page name of the landing name should be '''<module>-index.html* | ||
For example, Qt SQL's | 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'' | ''qtbase/src/sql/qtsql.qdoc'' | ||
<code> | <code> | ||
| Line 36: | Line 33: | ||
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] | ||
== Related Pages == | |||
* [[Qt5DocumentationProject | Qt 5 Documentation Project]]- information and statuses of the Qt modules | * [[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 | ''' [[Qt_Documentation_Structure | Qt 5 Documentation Structure]] - how the documentation files are structured in a module | ||
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 Project- information and statuses of the Qt modules
Qt 5 Documentation Structure - how the documentation files are structured in a module