[Development] Spelling of module names in documentation

[Atlant Schmidt]

Thomas:

> names like 'xml' are no longer abbreviations, they are product names.
> Not just something that Qt made up, but industry wide known product names.
>
> As such they should have only one capital.

  I absolutely disagree with this.

  The correct spelling of "XML" is "XML". The only time we
  should deviate from that is when it's part of a CamelCase
  name, and even that causes confusion and error.

  Similarly, the correct spelling of "SQL" is "SQL".

  When Wikipedia changes the article names to "Xml" or "Sql",
  then you might have a case. But until that time...

                          Atlant

-----Original Message-----
From: development-bounces+aschmidt=dekaresearch.com at qt-project.org [mailto:development-bounces+aschmidt=dekaresearch.com at qt-project.org] On Behalf Of Thomas Zander
Sent: Wednesday, December 14, 2011 07:50
To: development at qt-project.org
Cc: kevin.wright at nokia.com
Subject: Re: [Development] Spelling of module names in documentation

On Wednesday 14 December 2011 09.34.54 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

names like 'xml' are no longer abbreviations, they are product names. Not just
something that Qt made up, but industry wide known product names.

As such they should have only one capital.

I think it would be confusing to change the docs while all places where we
follow this rule in the code will not change.
_______________________________________________
Development mailing list
Development at qt-project.org
http://lists.qt-project.org/mailman/listinfo/development


 Click https://www.mailcontrol.com/sr/G4Qieg+xdDvTndxI!oX7UsdpzMR7Bo2Kr225Su6UcP2axKYO3pUqKudbFUCHIJwpz2ZU+cpJ+Pm7aUicAedHBg==  to report this email as spam.

This e-mail and the information, including any attachments, it contains are intended to be a confidential communication only to the person or entity to whom it is addressed and may contain information that is privileged. If the reader of this message is not the intended recipient, you are hereby notified that any dissemination, distribution or copying of this communication is strictly prohibited. If you have received this communication in error, please immediately notify the sender and destroy the original message.

Thank you.

Please consider the environment before printing this email.