[TYPO3-core] RFC #15504: Description of TYPO3_CONF settings should allow HTML markup for readability

[Ernesto Baschny [cron IT]]

François Suter schrieb am 19.08.2010 18:23:
> Hi Ernesto,
> 
>> Problem:
>> Sometimes It is difficult to describe an option in "one single
>> paragraph". Often you would want to have a list of choices or have some
>> code-snippet (.htaccess entries) properly marked up so that the admin
>> can more easily grasp what the setting does.
>>
>> Solution:
>> Attached patch (15504.diff) allows HTML in descriptions. Some CSS
>> changes are needed so that DL, PRE and CODE look nice.
> 
> I must say I would have gladly taken a different approach: move the
> description of all those configuration variables into a locallang file.
> All it takes is to define a logic, e.g.
> 
> $TYPO3_CONF_VARS[SYS][cookieDomain] is described by key
> config_default.sys.cookieDomain is some locallang file
> 
> then we can start having a localizable install tool.
> 
> Of course this complicates the matter for what you are trying to
> introduce, since you can't easily have markup in a locallang file...
> 
> So while this comment is not really related to your patch, I still would
> rather think of a way to get rid of this ugly method of describing
> variables first, and then only enhance what can be put in these
> descriptions (i.e. HTML tags).

Of course I also don't like the current format, but I don't want to wait
for the "major rewrite" of it to be able to have more flexibility in
describing the current settings. So I would rather do this "small"
change first, so that we at least have an improvement.

About using locallang.xml files, the trouble is that the Install Tool
cannot depend on much other parts of the core when doing its job, since
TYPO3 might not even be installed yet. So it is a "chicken/egg" problem,
that it sometimes have to use a very different approach then the one we
know from other components of TYPO3.

But I would be happy if someone is able to integrate locallang.xml
support on it, no doubt about it. This enhancement was just not the
scope for it.

Cheers,
Ernesto