[TYPO3-doc] Restoring the official manual example

François Suter fsu-lists at cobweb.ch
Thu Jul 26 22:16:39 CEST 2012


Hi all,

I worked on restoring the official manual example, adapted to 
ReStructured Text. This is meant - as before - to be the basis for new 
official manuals. I have pushed a first version to Gerrit:

https://review.typo3.org/#/c/13084/

I would be very glad for reviews, especially from Martin, as this is my 
first try at ReST. I based myself on the converted OO file [1], picked 
up some stuff from the converted official manuals (since they went 
through a better conversion process) and added some stuff myself.

We should make sure that this manual is squeaky clean, to avoid errors 
perpetuating from it.

Some questions I have already:

- for admonitions, I stuck to what we had chosen for DocBook, i.e. 
"tip", "note" and "caution". Do we want others? Do we want to leave the 
liberty to use all of the admonitions available? (this would mean having 
to style them all and also could induce confusion in the editors, for 
excess of choice).
- still about admonitions: can we give them a title or is a tip bound to 
be a "Tip"?
- I tried to put the Images folder in "Documentation/", but then failed 
to refer to it from "Chapter1/Images.txt". Can this be done and - if yes 
- how?
- BTW we need to discuss a strategy for storing images. All in one 
folder or in separate folder along the page tree. I would favor all in 
one folder, as it would simplify the work of people updating screenshots.
- still about images: rather than using |img-1| as a reference, I used 
|img-login-screen|. Does it make sense to have more explicit references? 
I would say yes, because it seems hard to manage the numbering manually 
on a large manual. Do you agree?

Thanks in advance for your reviews and opinions.

Cheers

-- 

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

[1] 
http://preview.docs.typo3.org/TYPO3/Extensions/official_template/nightly/manual.rst


More information about the TYPO3-project-documentation mailing list