[Development] Spelling of module names in documentation

[Thiago Macieira]

On Wednesday, 14 de December de 2011 09.46.10, Atlant Schmidt wrote:
> 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...

I'm arriving a bit late to the discussion, but...

For now, these terms are still known as acronyms, so they should be referred 
as such: Qt XML module, Qt XML module, Qt MIME classes, etc. Eventually, the 
acronym may be forgotten and it might crystallise as a word, but we're not 
there yet.

But the Qt naming guidelines require acronyms to be treated as one word and 
only the first letter to be capitalised:

	#include <QtXml>
	QSqlDatabase
	QMimeFoo

Except where it would be silly:

	QHostAddress::toIPv4Address() 
	Here, "IP" did not get lowercased to "Ip" because it's followed by "v"
	Alternatively, we could have done "Ip4"

	QtDBus
	The technology name is not an acronym, but two "words": D-Bus

-- 
Thiago Macieira - thiago.macieira (AT) intel.com
  Software Architect - Intel Open Source Technology Center
     Intel Sweden AB - Registration Number: 556189-6027
     Knarrarnäsgatan 15, 164 40 Kista, Stockholm, Sweden
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 190 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.qt-project.org/pipermail/development/attachments/20111214/f5fddc34/attachment.sig>