Qt wiki will be updated on October 12th 2023 starting at 11:30 AM (EEST) and the maintenance will last around 2-3 hours. During the maintenance the site will be unavailable.

Qt Writing Guidelines: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
No edit summary
(Gather writing guidelines into a category)
 
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
h1. Qt Writing Guidelines
[[Category:Writing Guidelines]]
 
The Qt Writing Guidelines contains information about writing Qt documentation in a consistent way. Though there are exceptions, maintain the consistency level outlined in the guidelines or the existing Qt documentation.
The Qt Writing Guidelines contains information about writing Qt documentation in a consistent way. Though there are exceptions, maintain the consistency level outlined in the guidelines or the existing Qt documentation.


Line 13: Line 12:
== QDoc Guidelines - writing the QDoc files ==
== QDoc Guidelines - writing the QDoc files ==


These QDoc guidelines complement the "QDoc Manual":http://doc.qt.io/qt-5/qdoc-index.html
These QDoc guidelines complement the [http://doc.qt.io/qt-5/qdoc-index.html QDoc Manual]


* [[QDocStyleGuidelines | Style Guidelines]] - proper use of commands, code blocks, markup, and indentation
* [[QDocStyleGuidelines | Style Guidelines]] - proper use of commands, code blocks, markup, and indentation
Line 40: Line 39:
== Related Links ==
== Related Links ==


* "Qt Documentation Wiki":http://wiki.qt.io/Category:Developing_Qt::Documentation - the main Documentation wiki which contains style information and contribution details. '''Also contains contact information for the Qt Documentation Team'''
* [http://wiki.qt.io/Category:Developing_Qt::Documentation Qt Documentation Wiki] - the main Documentation wiki which contains style information and contribution details. '''Also contains contact information for the Qt Documentation Team'''
* "QDoc Manual":http://doc.qt.io/qt-5/qdoc-index.html - contains a guide to QDoc as well as information about C++ and QML commands
* [http://doc.qt.io/qt-5/qdoc-index.html QDoc Manual] - contains a guide to QDoc as well as information about C++ and QML commands
* [[Building_Qt_Documentation | Building Qt Documentation]] - outlines how to build the documentation for Qt 5 and for each module
* [[Building_Qt_Documentation | Building Qt Documentation]] - outlines how to build the documentation for Qt 5 and for each module
* "http://doc-snapshot.qt.io/":http://doc-snapshot.qt.io/ - the documentation snapshot
* [http://doc-snapshots.qt.io/ doc-snapshots.qt.io] - the documentation snapshot

Latest revision as of 15:35, 25 November 2016

The Qt Writing Guidelines contains information about writing Qt documentation in a consistent way. Though there are exceptions, maintain the consistency level outlined in the guidelines or the existing Qt documentation.

Language and Article Styles - writing articles and pages

QDoc Guidelines - writing the QDoc files

These QDoc guidelines complement the QDoc Manual

Qt 5 Documentation Requirements

When writing Qt documentation, ensure that new Qt 5 modules conform to the requirements:

QDoc changes should pass the QDocRegressionTesting

Licensing Qt Reference Documentation

We distribute documentation, examples, or snippets under the following licenses:

  • GNU Free Documentation License: for pure documentation (typically in .qdoc files)
  • BSD 3-Clause License: for snippet documentation and examples
  • LGPL: for demo applications and when LGPL is warranted

The header for the licenses are located in qtbase and should be pasted on the top of the files.

Related Links

  • Qt Documentation Wiki - the main Documentation wiki which contains style information and contribution details. Also contains contact information for the Qt Documentation Team
  • QDoc Manual - contains a guide to QDoc as well as information about C++ and QML commands
  • Building Qt Documentation - outlines how to build the documentation for Qt 5 and for each module
  • doc-snapshots.qt.io - the documentation snapshot