[TYPO3-doc] Re: TypoScript rendering

[Elmar Hinz]

Thank you Martin,

> some patterns we've been using in the old Tsref. I've now added
> your "['property', 'datatype', 'description', 'example']" pattern.

Would suggest the plural "Examples", even if I need to update my text thereafter.

> Best solution would be:
> ======================
> http://docs.typo3.org/typo3cms/TyposcriptReference/Functions/Imagelinkwrap/Index.html

Doubled TOC
------------------

You created first a table to give an overview of the properties. Then a ".. contents::" directive follows to give the same overview again. This doubling doesn't give additional value, hence it becomes rather tiresome with respect to reading.

Flattened levels
---------------------

The properties are a sublevel of "imageLinkWrap =".  Tables are not well suited to display nesting. They acutally can only display one level.

That's where I introduced a "Context" description to show the position of properties: http://docs.typo3.org/typo3cms/extensions/esp/TypoScriptReference.html.

Definition lists
-------------------

It's a matter of taste, if they are harder to read. At least they are more simple to write, because they don't require table formatting.

Would it be possible to generate a TOC of a definition list?

\Elmar



















-- 
### NOW ### until 10th of  May 2013 ### NOW ###

=> Give +1 for the Extension Feedback System: http://forum.typo3.org/index.php/t/195934/ <=

Certified TYPO3 Integrator:  https://www.xing.com/profile/Elmar_Hinz | https://github.com/t3elmar