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)
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
=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.


==Language and Article Styles writing articles and pages==
== Language and Article Styles - writing articles and pages ==


* [[LanguageGuidelines|Language Guidelines]]
* [[LanguageGuidelines | Language Guidelines]]
* [[CppDocumentationStyle|C++ Documentation Style]]
* [[CppDocumentationStyle | C++ Documentation Style]]
* [[QMLDocumentationStyle|<span class="caps">QML</span> Documentation Style]]
* [[QMLDocumentationStyle | QML Documentation Style]]
* [[ExamplesDocumentationStyle|Examples and Tutorials Style]]
* [[ExamplesDocumentationStyle| Examples and Tutorials Style]]
* [[Spelling Module Names in Qt Documentation|Spelling Qt Module Names]]
* [[Spelling_Module_Names_in_Qt_Documentation | Spelling Qt Module Names]]


==QDoc Guidelines writing the QDoc files==
== QDoc Guidelines - writing the QDoc files ==


These QDoc guidelines complement the [http://doc.qt.io/qt-5/qdoc-index.html QDoc Manual] ''[qt.io]''
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
* [[QDocLinkingGuidelines|Linking Guidelines]]
* [[QDocLinkingGuidelines | Linking Guidelines ]]
* [[QDocExamples|Integrating Examples]]
* [[QDocExamples | Integrating Examples]]
* [[QDoc Project Templates]]
* [[QDoc_Project_Templates | QDoc Project Templates]]


==Qt 5 Documentation Requirements==
== Qt 5 Documentation Requirements ==


When writing Qt documentation, ensure that new Qt 5 modules conform to the requirements:
When writing Qt documentation, ensure that new Qt 5 modules conform to the requirements:
 
* [[Qt5DocumentationProject | Qt 5 Documentation]]
* [[Qt5DocumentationProject|Qt 5 Documentation]]
* [[Checklist for Adding Documentation for a New Module]]
* [[Checklist-for-Adding-Documentation-for-a-New-Module|Checklist for Adding Documentation for a New Module]]
* [[Qt_Documentation_Structure | Documentation Structure]] page contains a map of how the directory structure of a repository or module should be
* [[Qt Documentation Structure|Documentation Structure]] page contains a map of how the directory structure of a repository or module should be


QDoc changes should pass the [[QDocRegressionTesting]]
QDoc changes should pass the [[QDocRegressionTesting]]


==Licensing Qt Reference Documentation==
== Licensing Qt Reference Documentation ==


We distribute documentation, examples, or snippets under the following licenses:
We distribute documentation, examples, or snippets under the following licenses:
 
* GNU Free Documentation License: for pure documentation (typically in .qdoc files)
* <span class="caps">GNU</span> Free Documentation License: for pure documentation (typically in .qdoc files)
* BSD 3-Clause License: for snippet documentation and examples
* <span class="caps">BSD</span> 3-Clause License: for snippet documentation and examples
* LGPL: for demo applications and when LGPL is warranted
* <span class="caps">LGPL</span>: for demo applications and when <span class="caps">LGPL</span> is warranted


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


==Related Links==
== Related Links ==


* [[:Category:Developing Qt::Documentation|Qt Documentation Wiki]] ''[qt.io]'' – 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'''
* [http://doc.qt.io/qt-5/qdoc-index.html QDoc Manual] ''[qt.io]'' – contains a guide to QDoc as well as information about C++ and <span class="caps">QML</span> 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]] 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/ ''[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