Spelling Qt Module Names in Qt Documentation: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Use term 'Qt module' instead of the more ambiguous 'module') |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Writing Guidelines]] | [[Category:Writing Guidelines]] | ||
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 Qt 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: | The recommendation for consistent and readable spelling of Qt module names in the documentation is as follows: | ||
* Use the Qt prefix. Instead of "Core", write '''Qt Core'''. | * 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''' | * 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''' | * 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. | * Don't use the module repository (git submodule) names qtbase, qtsystems, qtpim or qtconnectivity in the documentation. Instead, you should refer directly to the individual Qt 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 | * If the Qt 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. | ** 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 Qt 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. | ||
For a list of Qt 6 module names, see [[Qt Terms and Concepts#Qt Modules]] | |||
Latest revision as of 06:05, 7 June 2024
Currently, Qt documentation uses various conventions for spelling Qt 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 Qt 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 (git submodule) names qtbase, qtsystems, qtpim or qtconnectivity in the documentation. Instead, you should refer directly to the individual Qt modules in those repositories.
- If the Qt 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 Qt 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.
For a list of Qt 6 module names, see Qt Terms and Concepts#Qt Modules