[TYPO3-doc] How to document TypoScript

[Xavier Perseguers]

Hi Alexander,

alexander mcnight wrote:
> more post please.

What do you want? Examples?

http://docs.typo3.org/typo3cms/extensions/restdoc/latest/Configuration/TxRestdocPi1/Index.html

corresponding source (link "Show Source" on top):

http://docs.typo3.org/typo3cms/extensions/restdoc/latest/_sources/Configuration/TxRestdocPi1/Index.txt

and another example with a custom admonition "Deprecated" (a little
trick that may be useful to others):

http://docs.typo3.org/typo3cms/extensions/restdoc/latest/Configuration/TxRestdocPi1Setup/Index.html

So, in short, documenting TS is now best done as two parts:

1a) Mini-TOC only for HTML (and JSON) output (does not make sense with
PDF with TYPO3 branding)

1b) Table of the various properties

	- column Property: each property is automatically linked to the
corresponding definition in 2b) (through auto-link to section name as
underscore)
	- column Data type: data type, cross-linked to TSref
	- column stdWrap: whether stdWrap is active on data type (what we used
to write as "string /stdWrap" for a data type string with stdWrap support
	- column Default: well, ... default value

2a) Mini-TOC of the various properties, only for HTML (and JSON)

2b) Section with each property, full definition (name + data type),
description and possible example.

Kind regards

-- 
Xavier Perseguers
Release Manager TYPO3 4.6

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