[TYPO3-doc] Questions about rendering manuals

[Martin Bless]

Hi Stefano,

we (who?) should consider adding some of this to the Questions & Answers
part in the wiki.

>Hey Documentation team,
>
>yesterday I cloned the CGL repo from [1] and built it with a local build
>chain (latex, sphinx, typo3 templates).
>It works very smooth and I got a PDF, but without the TYPO3 style and
>font. I red the docu at the wiki, that I have to change manual into
>typo3manual and the compiler will look for sphinxtypo3manual. But where
>it expected this?
>
>Another topic: Why is the meta informations about the manual not
>correctly set in conf.py? Will this done by some release script or is
>this just a task-to-be-done?
>
>(For the last question I got some answers from Martin by mail. I sent
>him exatly this mail and he encourage me asking the same question here
>again. )
>
>As I understand it correctly. I have to fill out this settings.yaml to
>get the meta informations into the document.
>
>Kind regards
>Stefano
>
>[1] http://git.typo3.org/Documentation/TYPO3/Reference/CodingGuidelines.git


Great you're repeating exactly the same question of our PM conversation
here in the documentation mailing list as I can answer only part of it. 

I'm
thankful that the others are adding to the wiki but I have to admit that
I'm not up to date what's in the wiki by now. And personally I haven't
got to using Latex so far. But Xavier did and is providing some Tex
stuff in Documentation/RestTools.git.

Meta information isn't updated in conf.py yet because the state of the
ReST sources of the manual is still "initial". This means it's still
what we've got from the first initial translation from OO to ReST. At
that point I used the same generic conf.py for all manuals to lower work
load a bit. It's up to editors (like you?) then to add the correct meta
information. The recommended way to add that meta information is by
using a Yaml file Settings.yml [2].

As far as I know the - technically - most advanced manual at the time
being is the Official Manual [5]. It has the mentioned Settings.yml [6]
and the necessary "TYPO3 code block" in the conf.py [7]. You may want to
clone that for instructional purpose and see how its done [8].

Other important achievements ("milestones": [3], [4]

It's great to hear that you have started with building ReST
documentation and got it - partly - working already. Are you interested
in improving a manual? That would be really good.  Any help in improving
the manuals and bringing them up to date is highly appreciated!

It's good to see you in the mailing list here. As I told you: Only kind
people here :-)

Martin


[2]
http://lists.typo3.org/pipermail/typo3-project-documentation/2012-August/004048.html
[3]
http://lists.typo3.org/pipermail/typo3-project-documentation/2012-August/004060.html
[4]
http://lists.typo3.org/pipermail/typo3-project-documentation/2012-September/004099.html

Official manual:
[5] http://preview.docs.typo3.org/TYPO3/OfficialManualExample/
[6]
http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git/Documentation/
[7]
http://srv123.typo3.org/~mbless/git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git.make/
[8] http://git.typo3.org/Documentation/TYPO3/Example/OfficialManual.git


-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de