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.

Spelling Module Names in Qt Documentation: Difference between revisions

From Qt Wiki
Jump to navigation Jump to search
(Add "cleanup" tag)
(Fix typo)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Cleanup | reason=Auto-imported from ExpressionEngine.}}
[[Category:Writing Guidelines]]
 
[[Category:Developing_Qt::Documentation]]
 
= Spelling Module Names in Qt 5 Documentation =


Currently, Qt documentation uses various conventions for spelling module names, depending on the history of the module, the length of the name, and personal preferences of different writers.
Currently, Qt documentation uses various conventions for spelling module names, depending on the history of the module, the length of the name, and personal preferences of different writers.
Line 14: Line 10:
* If the module name includes words like "and", they can be omitted in the source code name: '''Qt Publish and Subscribe''' is QtPublishSubscribe in the code
* If the module name includes words like "and", they can be omitted in the source code name: '''Qt Publish and Subscribe''' is QtPublishSubscribe in the code
* Avoid abbreviations, because it is hard to be consistent with their usage. If you cannot avoid them, then make sure you use them consistently in the code and documentation. For example, since the source code spelling is QtSystemInfo, the documentation name should be '''Qt System Info''', not Qt System Information. And since the source code spelling is QtJsonDb, the documentation name is '''Qt JSON DB''', not "Qt JSON Database".
* Avoid abbreviations, because it is hard to be consistent with their usage. If you cannot avoid them, then make sure you use them consistently in the code and documentation. For example, since the source code spelling is QtSystemInfo, the documentation name should be '''Qt System Info''', not Qt System Information. And since the source code spelling is QtJsonDb, the documentation name is '''Qt JSON DB''', not "Qt JSON Database".
** Currently, '''Qt Network Authorization''' violates this guideline, as the source code spelling is QtNetworkAuth.


In the code, the module names are used as header file names, and in QML import statements. In these cases, the module is spelled in CamelCase and without the separating white space.
In the code, the module names are used as header file names, and in QML import statements. In these cases, the module is spelled in CamelCase and without the separating white space.
Line 19: Line 16:
The following table summarizes the correct spelling for the current modules in the plans for Qt 5.
The following table summarizes the correct spelling for the current modules in the plans for Qt 5.


{background:#009900}. |''. Module name in documentation|''. Module name in the code|
{| class="wikitable"
| Active Qt | QAxContainer, QAxServer and other names with the QAx prefix |
|-
| Qt 3D | Qt3D |
! Module name in documentation !! Module name in the code
| Qt Android Extras | QtAndroidExtras |
|-
| Qt Bluetooth | QtBluetooth |
| Active Qt || QAxContainer, QAxServer and other names with the QAx prefix
| Qt CLucene | QtCLucene |
|-
| Qt Concurrent | QtConcurrent |
| Qt 3D || Qt3D
| Qt Contacts | QtContacts |
|-
| Qt Core | QtCore |
| Qt Android Extras || QtAndroidExtras
| Qt D-Bus | QtDBus |
|-
| Qt Designer | QtDesigner |
| Qt Bluetooth || QtBluetooth
| Qt Feedback | QtFeedback |
|-
| Qt Graphical Effects | QtGraphicalEffects |
| Qt Canvas 3D || QtCanvas3D
| Qt GUI | QtGui |
|-
| Qt Help | QtHelp |
| Qt Charts || QtCharts
| Qt JSON DB |QtJsonDb |
|-
| Qt Location | QtLocation |
| Qt CLucene || QtCLucene
| Qt Mac Extras | QtMacExtras |
|-
| Qt MIME Types | QtMimeTypes |
| Qt Concurrent || QtConcurrent
| Qt Multimedia | QtMultimedia |
|-
| Qt Multimedia Widgets | QtMultimediaWidgets |
| Qt Contacts || QtContacts
| Qt Network | QtNetwork |
|-
| Qt NFC | QtNfc |
| Qt Core || QtCore
| Qt Organizer | QtOrganizer |
|-
| Qt Positioning | QtPositioning |
| Qt Data Visualization || QtDataVisualization
| Qt Print Support | QtPrintSupport |
|-
| Qt Publish and Subscribe | QtPublishSubscribe |
| Qt D-Bus || QtDBus
| Qt Quick (for Qt Quick 2.0) | QtQuick |
|-
| Qt Quick (for Qt Quick 1.0 in the QML context) or Qt Declarative in the C++ context | QtQuick in QML, QtDeclarative in C++ |
| Qt Designer || QtDesigner
| Qt Script | QtScript |
|-
| Qt Script Tools | QtScriptTools |
| Qt Feedback || QtFeedback
| Qt Sensors | QtSensors |
|-
| Qt Serial Port | QtSerialPort |
| Qt Gamepad || QtGamepad
| Qt Service Framework | QtServiceFramework |
|-
| Qt SQL | QtSql |
| Qt Graphical Effects || QtGraphicalEffects
| Qt SVG | QtSvg |
|-
| Qt System Info | QtSystemInfo |
| Qt GUI || QtGui
| Qt Test | QtTest |
|-
| Qt UI Tools | QtUiTools |
| Qt Help || QtHelp
| Qt Versit | QtVersit |
|-
| Qt Versit Organizer | QtVersitOrganizer |
| Qt JSON DB || QtJsonDb
| Qt Wayland | QtWayland |
|-
| Qt WebChannel | QtWebChannel |
| Qt KNX || QtKnx
| Qt WebEngine | QtWebEngine |
|-
| Qt WebKit | QtWebKit |
| Qt Location || QtLocation
| Qt WebKit Widgets| QtWebKitWidgets |
|-
| Qt Widgets | QtWidgets |
| Qt Mac Extras || QtMacExtras
| Qt Windows Extras | QtWindowsExtras |
|-
| Qt X11 Extras | QtX11Extras |
| Qt MIME Types || QtMimeTypes
| Qt XML |QtXml |
|-
| Qt XML Patterns | QtXmlPatterns |
| Qt MQTT || QtMqtt
|-
| Qt Multimedia || QtMultimedia
|-
| Qt Multimedia Widgets || QtMultimediaWidgets
|-
| Qt Network || QtNetwork
|-
| Qt Network Authorization || ''QtNetworkAuth''
|-
| Qt NFC || QtNfc
|-
| Qt OPC UA || QtOpcUa
|-
| Qt Organizer || QtOrganizer
|-
| Qt Positioning || QtPositioning
|-
| Qt Print Support || QtPrintSupport
|-
| Qt Publish and Subscribe || QtPublishSubscribe
|-
| Qt Quick || QtQuick
|-
| Qt Script || QtScript
|-
| Qt Script Tools || QtScriptTools
|-
| Qt SCXML || QtScxml
|-
| Qt Sensors || QtSensors
|-
| Qt Serial Bus || QtSerialBus
|-
| Qt Serial Port || QtSerialPort
|-
| Qt Service Framework || QtServiceFramework
|-
| Qt Speech || QtSpeech
|-
| Qt SQL || QtSql
|-
| Qt SVG || QtSvg
|-
| Qt System Info || QtSystemInfo
|-
| Qt Test || QtTest
|-
| Qt UI Tools || QtUiTools
|-
| Qt Versit || QtVersit
|-
| Qt Versit Organizer || QtVersitOrganizer
|-
| Qt Virtual Keyboard || QtVirtualKeyboard
|-
| Qt Wayland || QtWayland
|-
| Qt WebChannel || QtWebChannel
|-
| Qt WebEngine || QtWebEngine
|-
| Qt WebKit || QtWebKit
|-
| Qt WebKit Widgets || QtWebKitWidgets
|-
| Qt WebSockets || QtWebSockets
|-
| Qt Widgets || QtWidgets
|-
| Qt Windows Extras || QtWindowsExtras
|-
| Qt X11 Extras || QtX11Extras
|-
| Qt XML || QtXml
|-
| Qt XML Patterns || QtXmlPatterns
|}

Latest revision as of 07:19, 26 October 2017


Currently, Qt documentation uses various conventions for spelling module names, depending on the history of the module, the length of the name, and personal preferences of different writers.

The recommendation for consistent and readable spelling of module names in the documentation is as follows:

  • Use the Qt prefix. Instead of "Core", write Qt Core.
  • Spell all words separated by white space and start all words with a capital letter. For example Qt Service Framework
  • Acronyms and established names spelled in their standard format, for example Qt SQL, Qt XML Patterns, Qt D-Bus
  • Don't use the module repository names qtbase, qtsystems, qtpim or qtconnectivity in the documentation. Instead, you should refer directly to the individual modules in those repositories.
  • If the module name includes words like "and", they can be omitted in the source code name: Qt Publish and Subscribe is QtPublishSubscribe in the code
  • Avoid abbreviations, because it is hard to be consistent with their usage. If you cannot avoid them, then make sure you use them consistently in the code and documentation. For example, since the source code spelling is QtSystemInfo, the documentation name should be Qt System Info, not Qt System Information. And since the source code spelling is QtJsonDb, the documentation name is Qt JSON DB, not "Qt JSON Database".
    • Currently, Qt Network Authorization violates this guideline, as the source code spelling is QtNetworkAuth.

In the code, the module names are used as header file names, and in QML import statements. In these cases, the module is spelled in CamelCase and without the separating white space.

The following table summarizes the correct spelling for the current modules in the plans for Qt 5.

Module name in documentation Module name in the code
Active Qt QAxContainer, QAxServer and other names with the QAx prefix
Qt 3D Qt3D
Qt Android Extras QtAndroidExtras
Qt Bluetooth QtBluetooth
Qt Canvas 3D QtCanvas3D
Qt Charts QtCharts
Qt CLucene QtCLucene
Qt Concurrent QtConcurrent
Qt Contacts QtContacts
Qt Core QtCore
Qt Data Visualization QtDataVisualization
Qt D-Bus QtDBus
Qt Designer QtDesigner
Qt Feedback QtFeedback
Qt Gamepad QtGamepad
Qt Graphical Effects QtGraphicalEffects
Qt GUI QtGui
Qt Help QtHelp
Qt JSON DB QtJsonDb
Qt KNX QtKnx
Qt Location QtLocation
Qt Mac Extras QtMacExtras
Qt MIME Types QtMimeTypes
Qt MQTT QtMqtt
Qt Multimedia QtMultimedia
Qt Multimedia Widgets QtMultimediaWidgets
Qt Network QtNetwork
Qt Network Authorization QtNetworkAuth
Qt NFC QtNfc
Qt OPC UA QtOpcUa
Qt Organizer QtOrganizer
Qt Positioning QtPositioning
Qt Print Support QtPrintSupport
Qt Publish and Subscribe QtPublishSubscribe
Qt Quick QtQuick
Qt Script QtScript
Qt Script Tools QtScriptTools
Qt SCXML QtScxml
Qt Sensors QtSensors
Qt Serial Bus QtSerialBus
Qt Serial Port QtSerialPort
Qt Service Framework QtServiceFramework
Qt Speech QtSpeech
Qt SQL QtSql
Qt SVG QtSvg
Qt System Info QtSystemInfo
Qt Test QtTest
Qt UI Tools QtUiTools
Qt Versit QtVersit
Qt Versit Organizer QtVersitOrganizer
Qt Virtual Keyboard QtVirtualKeyboard
Qt Wayland QtWayland
Qt WebChannel QtWebChannel
Qt WebEngine QtWebEngine
Qt WebKit QtWebKit
Qt WebKit Widgets QtWebKitWidgets
Qt WebSockets QtWebSockets
Qt Widgets QtWidgets
Qt Windows Extras QtWindowsExtras
Qt X11 Extras QtX11Extras
Qt XML QtXml
Qt XML Patterns QtXmlPatterns
Retrieved from "https://wiki-qt-io-staging.herokuapp.com/index.php?title=Spelling_Module_Names_in_Qt_Documentation&oldid=32009"