[TYPO3-doc] Experiences with ReSTructured Text

[Fabien Udriot]

On 9/6/11 11:40 AM, Sebastian Kurfürst wrote:
>> Very nice being able to extend it but if we start using it for
>> > documentation and replacing the OOo format, we have to make sure that:
>> >
>> > - it's straightforward to install and start writing (download,
>> > install, use, period)
>> > - output is already preconfigured to render as well as the current
>> > OpenOffice output (if not better)
>> > - anybody may without taking hours, reproduce any common needs of
>> > current documentation (picture, code block, enumerated lists, links,
>> > references) - just take current TSref with all missing intra-links, it
>> > should be dead easy to do that
> It is easy to set up and of course we'd deliver all the "TYPO3 Corporate
> Identity" styling.
> 
>     easy_install -U Sphinx
>     git clone git://git.typo3.org/FLOW3/Documentation.git
>     cd Documentation
>     make html # on windows: make.bat html
> 


I would say we need also to provide on-line infrastructure to the End User so that don't have to
bother with installing something on his local machine (=> an on-line tool where he can upload /
render its doc quickly). I see it as an important requirement. Obviously, this would not exclude a
local installation for offline rendering for instance...

ReST format is very close the Wiki format we know on Redmine, for instance. Doesn't it exist any
ReST Wiki tool that we could benefit from?

Kindly,

Fabien