[TYPO3-core] How to refer to TYPO3_CONF_VARS in the documentation (since v6.0)

Jigal van Hemert jigal.van.hemert at typo3.org
Fri Dec 7 15:56:24 CET 2012

Hi François,

On 7-12-2012 9:27, François Suter wrote:
>> I think it would even be more useful to have documentation for a
>> specific TYPO3 version (branch).
>> It would be a little more work to have the documentation in the same
>> branch structure as the PHP sources. "Backporting" documentation to
>> multiple branches is relatively simple as git is quite good at cherry
>> picking (as it doesn't look at files but at the content itself).
> In a sense we always had this, but it wasn't really visible in the sense
> that there was no way to easily reach older versions. After the
> migration to ReST, it is still possible but not ready yet. We have made
> 4.7 branches for all reference manuals, but we still have to implement
> some form of navigation to be able to reach them. For older versions, we
> plan to have some kind of PDF archive.

It would be too much work to implement it for really old versions, but 
maybe we start now with the changes in 6.0 to have easily available 
versions for different branches?

Take for example the MySQL documentation [1] where the links on the left 
take you to the same page for another version.

It becomes rather needed after the release of 6.0 because a lot of 
references and code examples are not correct anymore (class names have 
changed, classes were moved and namespaces were introduced).

>> Having chapters as pages (or even smaller) with navigation to move
>> quickly around the manual would be very useful.
> Have you looked at docs.typo3.org? We have such table of contents now,
> but maybe that's not what you mean. All suggestions to improve the
> browsing experience are welcome.

First of all, docs.typo3.org is a huge improvement over the old table 
rendering we had. There are still chapters which are kind of long, for 
example: [2] . It would help a lot to break that down.

Also some kind of neighbourhood navigation might be useful [1] on the 
right, [3] on the left.

One more thing...

The colour orange is still a problem for readability. It won't pass the 
colour contrast guidelines for accessibility (for example [4]).
#FF8700 vs. white : 2.4:1 (minimal 4.5:1 for normal text, 3:1 for large 
#F58006 vs. #E8E8E8 : 2.1:1

I am aware that these are colours from the design, but then we must 
simply give feedback to the designers that the text must still be readable.

[1] http://dev.mysql.com/doc/refman/5.1/en/replace.html
[2] http://docs.typo3.org/typo3cms/TCA-Reference/Reference/Ctrl/Index.html
[3] http://nl3.php.net/preg_match
[4] http://webaim.org/resources/contrastchecker/

Jigal van Hemert
TYPO3 Core Team member

TYPO3 .... inspiring people to share!
Get involved: typo3.org

More information about the TYPO3-team-core mailing list