[TYPO3-doc] Organization for the next steps

Philipp Gampe philipp.gampe at typo3.org
Fri Aug 3 10:17:46 CEST 2012


Hi Jigal van Hemert,

Jigal van Hemert wrote:

>  From what François wrote in here and in the core list the ReST files
> will not be displayed as is, but rendered (as HTML).

Only if there is an online connection. Otherwise the EM will need to fall 
back to either PDF, local HTML or the plain reST version (in that order).
It is not possible to render the reST files without the toolchain being 
available on the server.

> Alle core manuals are already rendered as HTML and/or PDF or another
> widely available format. It is indeed a good idea IMO to include those
> in the core. This is far easier to build.
> 
> Why not have the following in the core:
> - PDF; local; single file with images
> - HTML; online; possibly with comments when they become available

The HTML version should be there almost immediately after triggering the 
rendering. The rendering is pretty fast and we do not have that many 
documentation changes.

> Rendering ReST format manuals is far easier than .sxw formats, so it
> might even be an option to include the PDF and/or HTML formats in the
> .t3x/.zip files in TER. People are used to a delay between uploading an
> extension and the availability in TER. That delay can also be used to
> render the manual.

If the extensions are repacked on the server already, this should be no 
problem once the rendering is fully automated.

Cheers
-- 
Philipp Gampe – PGP-Key 0AD96065 – TYPO3 UG Bonn/Köln
Documentation – linkvalidator
TYPO3 .... inspiring people to share!



More information about the TYPO3-project-documentation mailing list