[TYPO3-doc] [ReST migration] Final URLs for rendered documentation

[Jacob Floyd]

Personally, I like the UpperCamelCase URIs. If we had 
lower-case-by-default, then you'd have to add a "-" between all the words 
for legibility.

When it comes to the API docs, I would prefer we use the UpperCamelCase, 
because then I can just copy/paste to build up the url. Or, if there was a 
rewrite rule that took upper camel case and redirected to the version with 
dashes, I'd be ok with that.

consider this URI, which should (IMO) always retain the same case as in the 
source.
http://api.typo3.org/flow3/master/?TYPO3/FLOW3/Persistence/Doctrine/Mapping/Exception/class-ClassSchemaNotFoundException.html

The other docs could just be lowercase by default, but if the API already 
requires UpperCamelCase, why not do the same for the rest of the docs? What 
would it take to make FLOW3 handle case-sensitive URIs? (ie redirect 
uppercamelcase to UpperCamelCase)

According to the spec[1] the scheme and host must be lowercase, and 
anything that is percent encoded should be upper case (A-F). The rest of 
the URL can be whatever case we want. Normally, it's all lower-case, but 
UpperCamelCase does not seem to be prohibited in the path.
[1] http://tools.ietf.org/html/rfc3986#section-3.2.2

(Robert, I'm just trying to understand other perspectives, so I've 
explained how I see it so that you can hopefully point out where I don't 
understand. I'm good with whatever is decided.)

On Monday, July 16, 2012 1:06:44 PM UTC-6, François Suter wrote:
>
> Hi Robert, 
>
> >> Note that Robert was just talking about URLs, not all the other files. 
> But I think that if the server is case-insensitive, then it doesn't matter 
> if the rendered HTML files and folders use UpperCamelCase. On the contrary, 
> I think it makes the structure more readable when we look at it from a 
> server admin point of view. 
> > 
> > sorry if I stepped on someone's toes, I was just spontaneous and 
> honest;-) 
>
> I don't think you did step on anyone's toes. 
>
> > Yes, having case sensitive file names but case insensitive, 
> lower-case-by-default URIs would be my personally preferred solution. 
> FLOW3's URIs are usually case insensitive and lower case … 
>
> I can't really remember why we first decided to go with mixed case URLs. 
> Maybe we can rediscuss this on Thursday. It sure makes the file system a 
> bit more readable, but it's indeed not like FLOW3 does. 
>
> Cheers 
>
> -- 
>
> Francois Suter 
> Cobweb Development Sarl - http://www.cobweb.ch 
> _______________________________________________ 
> TYPO3-project-documentation mailing list 
> TYPO3-project-documentation at lists.typo3.org 
> http://lists.typo3.org/cgi-bin/mailman/listinfo/typo3-project-documentation 
>