[TYPO3-doc] Restoring the official manual example

[Martin Bless]

François Suter,

>- I have changed the use of "image" to the use of "figure". There have 
>been side-effects though. The image now appears on top of the "Chapter1" 
>page rather than at the bottom and the reference still appears at the 
>bottom (the caption appears fine, after the correction applied in 
>patchset #5). What did I do wrong?

It turns out that we can't use the replacement technique for figures.
Docutils defines the replacement directive:

.. |name| replace:: paragraph

Which allows to use |name| instead of the paragraph. Paragraph is
restricted to text with "inline markup".

Sphinx has extended the replacement technique so that it works for
"image::" as well. But there is no such thing for "figure::". My first
impulse was: "Wow, that's inconsistent, I should add a feature request
to the Sphinx bugtracker." But then I came to the conclusion that the
current situation - probably - is there very much on purpose. The
answer will probably be: Figures with caption and description usually
occur only once. They should therefor go directly into the text. And
the caption and description belong to the text to make the ReST source
complete und understandable.

I did that change in Patchset #6. At least I wanted it to become #6.
What I got instead was this:
http://review.typo3.org/13415

Hhm, what did I do wrong? It's the first time I just tried the -m
"Change-Id: ..." on the commandline, that's probably the error. I
should have use the exect existing commit message!? 

-F "../commit-msg.txt"

is what I had been using before.


marble at SANDYMAX
/d/Repositories/git.typo3.org/Documentation/TYPO3/Example/kannweg/OfficialManual.git
(patchset13084#6)
$ git commit --amend -a -m " Change-Id:
Ief3992f7f1d3db6dc3ebf1a2d32323f0b99d4e3f "
[patchset13084#6 d6cd673]  Change-Id:
Ief3992f7f1d3db6dc3ebf1a2d32323f0b99d4e3f
 Author: Francois Suter <francois at typo3.org>
 13 files changed, 1144 insertions(+)
 create mode 100644 Documentation/Chapter1/Index.rst
 create mode 100644 Documentation/Images.txt
 create mode 100644
Documentation/Images/IntroductionPackageLoginScreen.png
 create mode 100644 Documentation/Includes.txt
 create mode 100644 Documentation/Index.rst
 create mode 100644 Documentation/Introduction/Index.rst
 create mode 100644 Documentation/NextSteps/Index.rst
 create mode 100644 Documentation/_make/Makefile
 create mode 100644 Documentation/_make/_not_versioned/.gitignore
 create mode 100644 Documentation/_make/build/.gitignore
 create mode 100644 Documentation/_make/conf.py
 create mode 100644 Documentation/_make/make-html.bat
 create mode 100644 Documentation/_make/make.bat
 delete mode 100644 Readme

marble at SANDYMAX
/d/Repositories/git.typo3.org/Documentation/TYPO3/Example/kannweg/OfficialManual.git
(patchset13084#6)
$ git push origin HEAD:refs/for/master
Counting objects: 22, done.
Delta compression using up to 4 threads.
Compressing objects: 100% (15/15), done.
Writing objects: 100% (21/21), 109.76 KiB, done.
Total 21 (delta 0), reused 0 (delta 0)
remote:
remote: New Changes:
remote:   http://review.typo3.org/13415
remote:
To
ssh://marble@review.typo3.org:29418/Documentation/TYPO3/Example/OfficialManual.git
 * [new branch]      HEAD -> refs/for/master



This is the result of my change. The figure appears as desired:
http://preview.docs.typo3.org/TYPO3/OfficialManualExample/Chapter1/Index.html

The corresponding ReST:
http://preview.docs.typo3.org/TYPO3/OfficialManualExample/_sources/Chapter1/Index.txt

Since the Images.txt file is empty I removed it and removed the "..
include:: Images.txt" line.

Over!

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de