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
Jump to navigation
Jump to search
(Gather writing guidelines into a category) |
(Fix typo) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 10: | 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 26: | Line 27: | ||
|- | |- | ||
| Qt Bluetooth || QtBluetooth | | Qt Bluetooth || QtBluetooth | ||
|- | |||
| Qt Canvas 3D || QtCanvas3D | |||
|- | |||
| Qt Charts || QtCharts | |||
|- | |- | ||
| Qt CLucene || QtCLucene | | Qt CLucene || QtCLucene | ||
| Line 34: | Line 39: | ||
|- | |- | ||
| Qt Core || QtCore | | Qt Core || QtCore | ||
|- | |||
| Qt Data Visualization || QtDataVisualization | |||
|- | |- | ||
| Qt D-Bus || QtDBus | | Qt D-Bus || QtDBus | ||
| Line 40: | Line 47: | ||
|- | |- | ||
| Qt Feedback || QtFeedback | | Qt Feedback || QtFeedback | ||
|- | |||
| Qt Gamepad || QtGamepad | |||
|- | |- | ||
| Qt Graphical Effects || QtGraphicalEffects | | Qt Graphical Effects || QtGraphicalEffects | ||
| Line 48: | Line 57: | ||
|- | |- | ||
| Qt JSON DB || QtJsonDb | | Qt JSON DB || QtJsonDb | ||
|- | |||
| Qt KNX || QtKnx | |||
|- | |- | ||
| Qt Location || QtLocation | | Qt Location || QtLocation | ||
| Line 54: | Line 65: | ||
|- | |- | ||
| Qt MIME Types || QtMimeTypes | | Qt MIME Types || QtMimeTypes | ||
|- | |||
| Qt MQTT || QtMqtt | |||
|- | |- | ||
| Qt Multimedia || QtMultimedia | | Qt Multimedia || QtMultimedia | ||
| Line 60: | Line 73: | ||
|- | |- | ||
| Qt Network || QtNetwork | | Qt Network || QtNetwork | ||
|- | |||
| Qt Network Authorization || ''QtNetworkAuth'' | |||
|- | |- | ||
| Qt NFC || QtNfc | | Qt NFC || QtNfc | ||
|- | |||
| Qt OPC UA || QtOpcUa | |||
|- | |- | ||
| Qt Organizer || QtOrganizer | | Qt Organizer || QtOrganizer | ||
| Line 76: | Line 93: | ||
|- | |- | ||
| Qt Script Tools || QtScriptTools | | Qt Script Tools || QtScriptTools | ||
|- | |||
| Qt SCXML || QtScxml | |||
|- | |- | ||
| Qt Sensors || QtSensors | | Qt Sensors || QtSensors | ||
|- | |||
| Qt Serial Bus || QtSerialBus | |||
|- | |- | ||
| Qt Serial Port || QtSerialPort | | Qt Serial Port || QtSerialPort | ||
|- | |- | ||
| Qt Service Framework || QtServiceFramework | | Qt Service Framework || QtServiceFramework | ||
|- | |||
| Qt Speech || QtSpeech | |||
|- | |- | ||
| Qt SQL || QtSql | | Qt SQL || QtSql | ||
| Line 96: | Line 119: | ||
|- | |- | ||
| Qt Versit Organizer || QtVersitOrganizer | | Qt Versit Organizer || QtVersitOrganizer | ||
|- | |||
| Qt Virtual Keyboard || QtVirtualKeyboard | |||
|- | |- | ||
| Qt Wayland || QtWayland | | Qt Wayland || QtWayland | ||
| Line 106: | Line 131: | ||
|- | |- | ||
| Qt WebKit Widgets || QtWebKitWidgets | | Qt WebKit Widgets || QtWebKitWidgets | ||
|- | |||
| Qt WebSockets || QtWebSockets | |||
|- | |- | ||
| Qt Widgets || QtWidgets | | Qt Widgets || QtWidgets | ||
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 |