[TYPO3-doc] Issue #42322: How to lift up ./Documentation to latest structure

Martin Bless m.bless at gmx.de
Wed Oct 24 09:09:40 CEST 2012


Hi François & Christopher,

please merge this one: https://review.typo3.org/#/c/15913/

At the same time this is a model of what we need to do with other
official documents to adapt the file structure to our current
rendering machinery.

.. note::

   You can use that 'conf.py' and 'Includes.txt' unchanged
   for other manuals as well. Instead of customzing 'conf.py'
   make the individual declarations in 'Settings.yml'.


One more: I'm planning to write a little script that does some
more postprocessing as adding ".. include:: (..)*/Include.txt at
the beginning of each file and maybe tweak those many instances
of:

001 here is some example:
002
003 ::
004 
005   example code  

which could be rewritten as:

001 here is some example::
002
003   example code  


[TASK] Add Settings.yml, Includes.txt and more ...

We start by doing this: Add Settings.yml, add Includes.txt, use a
better 'conf.py' file. It is the "current up to date" generic one
with the "TYPO3 codeblock" at the end.

Add .. include:: Includes.txt in Documentation/Index.rst to show
what should be done in each ReST file. (Will do that later
programmatically, I think.)

Change all Images.txt files to not use the height and width
specification given there as those numbers reflect what OpenOffice
once thought was the correct size. But it isn't the actual size of
the screenshots but a scaled down number. We better ignore
those numbers.

This patch can serve as a model of what needs to be done with
other manuals as well.

Resolves: #42322 http://forge.typo3.org/issues/42322


Sail on ...

Martin


More information about the TYPO3-project-documentation mailing list