[TYPO3-core] RFC: Bug #529: update inline TypoScript help

[Ernesto Baschny [cron IT]]

Sebastian Kurfuerst wrote: on 18.06.2007 09:09:

> this is a SVN patch request.
> 
> Problem: The online TypoScript help was never updated.
> 
> Branches: trunk, 4.1.2
> 
> Bugtracker reference: http://bugs.typo3.org/view.php?id=529
> 
> Solution: a new backend module (under Help->TypoScript Help) where one
> can rebuild TypoScript help from installed extensions. The extension
> parses the documentation and extracts the tables and adds it to the
> online TypoScript help.
> 
> Thanks to Stephane Schitter and Francois Suter for writing this extension!

Yes, this is pretty cool. And the backend module looks clean and easy.
Some minor styling stuff must be corrected like space after functions
and before the opening "(" like:

   $this->nextTSDefinitionTable ($vals, $index, $id);

the "DEBUG" comment in the middle of the parsing routine.

I would also refactor the whole generation process into a separate class
so that it is easier to call the functionality from somewhere else, for
example to make a CLI from the module. This could be helpful if we want
to automate the generation of the static_tsconfig_help contents.

> Please test it and give quick feedback, as Michael and I want to include
> it with TYPO3 4.1.2.
> 
> I will commit an updated definition of the tsconfig_help table as well.

We could instead ship doc_core_tsref + doc_core_tsconfig (total size =
544kb) instead of shipping tsconfig_help with static data (total size ~
600 kb) and let the user generate them, if needed. So the TS-wizard will
link to tsconfig_help/mod1 if there is no content in
static_tsconfig_help. This would also make shipping TYPO3 easier, as we
don't have to generate these contents for each release. Instead we just
add the current .swx manual to trunk when the release time comes.

Cheers,
Ernesto