[TYPO3-core] Migrating the system extension manuals to ReStructured Text

François Suter fsu-lists at cobweb.ch
Thu Aug 2 18:42:21 CEST 2012


Hi all,

I have discussed with the TYPO3 6.0 RM team about migrating all system 
extension manuals to ReST. This would entail the following:

- migrating the manuals themselves
- changing the EM to have links pointing to the rendered docs online
- provide a fallback when someone has no internet connection to view the 
raw ReST files in the TYPO3 BE

The changes would apply to the new-new EM. I wanted to post this here so 
that you could ask questions and express worries.

On the Doc Team side we are confident that we will be ready with a full 
rendering chain - including for system extension manuals - by the time 
6.0 is released.

It would be good if the new-new EM provided hooks for things such as 
extra documentation links and such. I'm thinking that the Documentation 
Team could provide extensions related to documentation that enable 
things like linking to other formats (PDF, for example) and downloading 
such resources for offline viewing. But as we have no PDF rendering yet 
(only experimental) we can't implement such a feature now. Thus it would 
be good to have possibilities for extensions.

Cheers

-- 

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


More information about the TYPO3-team-core mailing list