[TYPO3-50-general] CGL discussions (misced topics)

[Jochen Rau]

Hi.

On 2009-05-29 12:37:57 +0200, Ingmar Schlecht <ingmar at typo3.org> said:
> One more topic to add to the CGL discussions:
> 
> Is there already a definition on how to write abbreviations in curlyCaps?
> 
> So, should it be:
>  OpenSSLRSAKey or OpenSslRsaKey
>  XMLParser     or XmlParser?
>  HTMLToXHTMLConverter or HtmlToXhtmlConverter
> 
> I personally prefer the strong enforcement of curlyCaps even in
> abbreviations, but (either way) it should be defined in the CGL.

I also prefer the consequent usage of CurlyCaps (or CamelCase). The CGL says:

"If acronyms or abbreviations are embedded in names, keep them in the 
case they usually are, i.e. keep URL uppercase, also when used in a 
method name like getURLForLink(), ACMEManager etc."
I don't like this guide line for two reasons:
1. Who decides what the term "usually" really means? Let's have "GmbH" 
(a german acronym for Ltd.). It usually has a lowercase "m". Here we 
go: F3_MyPackage_GmBHRulesValidationService. Ouch. Even if we use 
F3_MyPackage_GMBHRulesValidationService -> see 2..
2. While AcmeManager can be perfectly converted into acme_manager, the 
term ACMEManager is ambigue. It can be ac_me_manager or a_c_m_e_manager 
or whatever. (Let's assume suche a conversion generally makes sense; 
and it does: see $_EXTKEY).
To sum this up. I definitely vote for

OpenSslRsaKey
XmlParser
HtmlToXhtmlConverter

Jochen

-- 
"Every nit picked is a bug fixed"