[Development] Spelling of module names in documentation

[henry.haverinen at nokia.com]

Hi all,

Thanks Thiago, Lars, Atlant and others. I updated the wiki page according to this discussion:
http://developer.qt.nokia.com/wiki/Spelling_Module_Names_in_Qt_Documentation

To make this clear, the wiki page lists all the module names that have been discussed for Qt 5.0 so far. I'm copying the guideline here:

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".

Cheers,
Henry

> On 12/14/11 6:34 PM, "ext henry.haverinen at nokia.com"
> <henry.haverinen at nokia.com> wrote:
> 
> >I got some feedback outside this list about the documentation spelling
> >of module names that contain acronyms. Now the guideline says we should
> >write about the Qt Sql module, the Qt Xml module and so on. The
> >feedback is that we should write about the Qt SQL module, the Qt XML
> >module, the Qt XML Patterns module, the Qt MIME Types module and so
> on.
> >The short version used in the code would continue be QtSql, QtXml and so
> on.
> >
> >I agree this would lead to more natural language in documentation and
> >other communications, so I propose we change the guideline in the wiki
> >accordingly.

Lars wrote:
> +1 from me.
>