[TYPO3-ect] Documenting Typoscript

[Kasper Skårhøj]

Looking forward at version 4.5 I think it could be _the_ usability  
improvement for developers if _all_ TypoScript could be validated and  
documented inline:

- Any TypoScript configuration (TS templates/TSconfig) is "somehow"  
defined in the actual code and can be extracted from there by some  
viewer.
- Semantics are fixed without this definition so that any TypoScript  
can be validated!
As a consequence:
- All TypoScript documentation (TSref/TSconfig/Extension documents  
with tables) is removed because its obsolete. Documentation is  
completely inline in TYPO3, depends exactly on what extensions are  
installed and it all validates so no more guesswork!


So, now its time to go to the HCI team and suggestion this!

- kasper




On May 25, 2006, at 12:46 , Christian Jul Jensen wrote:

> Jeff Segars wrote:
>
>> Has anyone else given any thought to standardizing inline  
>> documentation
>> for Typoscript in order to pull it up to higher level documentation?
>
> I think the discussion and ideas that have been has been more centered
> around the actual PHP-implementation of TS, ie. to refactor in a  
> way that
> allows for automatic documentation using reflection.
>
> I think to some degree Dan Frosts OBTS is a step in this direction.
>
> Cleaning up the constant-editors markup could absolutely be a way  
> to achieve
> some of this. Maybe it could even be made to be useful within local
> typoscript stuff.
>
> -- 
> - Christian Jul Jensen
>
> TYPO3 core developer (http://TYPO3.org)
> Professional webdeveloper (http://jul.net)
>
> _______________________________________________
> TYPO3-team-extension-coordination mailing list
> TYPO3-team-extension-coordination at lists.netfielders.de
> http://lists.netfielders.de/cgi-bin/mailman/listinfo/typo3-team- 
> extension-coordination


- kasper

"A contribution a day keeps the fork away"
-------------------------------
kasper2006 at typo3.com | +45 20 999 115 | skype: kasperskaarhoej |  
gizmo: kasper_typo3