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

Ernesto Baschny [cron IT] ernst at cron-it.de
Thu Dec 6 15:23:22 CET 2012


François Suter schrieb am 06.12.2012 15:09:

> I'm coming back to this topic to try and find a modus operandi for
> updating the manuals.
> 
>> ".. please set the<link>Local Configuration</link>  item
>> "['SYS']['encryptionKey']" to a unique ..."
> 
> I think this is good enough and I would say that we don't need text
> roles for this. The link to "Local Configuration" could be just a normal
> ReST cross-link to the corresponding chapter in Inside TYPO3, which
> precisely has such chapter.
> 
> Of course this means trying to hurry with the update of Inside TYPO3,
> which is terribly out of date.

Wasn't it the plan some time ago to split up "Inside TYPO3" into
separate documents to avoid having a "huge package" which needs to be
"updated at once"? Having a separate document per "chapter" would allow
to release new chapters faster and developers will be able to identify
which section is how old more easily. We could start doing that with
"new chapters" (like this "LocalConfiguration" documentation) to avoid a
huge overhead.

Same goes for "TYPO3 Core API". First step was done by separating the
$TCA documentation in it's own manual, but same procedure could be
applied to *all* chapters - at least "new ones" - i.e Caching Framework,
SwiftMailer, Categorization API, FORM Protection, which already have
some Wiki-Docs and Issues pending in the Forge Tracker.

Of course then those need to be better grouped on the start page:

http://typo3.org/documentation/document-library/core-documentation//current/

Cheers,
Ernesto


More information about the TYPO3-team-core mailing list