[TYPO3-doc] Documenting TypoScript constants (and more)

[Francois Suter]

Hi all,

(Yes, I've finally joined this mailing list, after resisting a long time 
;-) )

During yesterday's Bug Day a nice new feature was committed to TYPO3 
Trunk making it possible to define custom subcategories for TypoScript 
constants and extension configuration options. While trying to find a 
place where to document this feature I realised that TypoScript constant 
were very poorly documented:

1) there's nothing in doc_core_ts, which should cover all syntax-related 
stuff about TS

2) there's a very small chapter in doc_core_tsref, which doesn't cover 
categorisation/Constant editor at all. Furthermore the end of this 
chapter mentions order of inclusion of static templates, without even 
talking about static templates first.

Now I'm trying to find the best place the necessary enhancements. I would:

a) place them in doc_core_ts, even though this document is about general 
TS stuff and constant cannot be used in TSconfig. I think this is ok, 
since this is already for conditions (described in doc_core_ts, but not 
usable in TSconfig). This new part of documentation would include all 
the information about constants categorisation/constant editor.

b) remove the part about constants from doc_core_tsref and just point to 
doc_core_ts.

c) add to doc_core_api a note about extensions configuration options and 
point to doc_core_ts for full reference.

d) as an aside to this, add a chapter in doc_core_ts about static 
templates inclusions, which are possible for both template TS and TSconfig

e) add a better explanation of all the template TS tools available in 
Web > Template, but this would probably rather go to TSRef, since it is 
only for template TS.

Does that make sense?

Cheers

-- 

Francois Suter
Cobweb Development Sarl - http://www.cobweb.ch