[TYPO3-doc] preview.docs.typo3.org/typo3/extensions/ - just in time for 4.7!

Martin Bless m.bless at gmx.de
Mon Apr 23 12:54:04 CEST 2012


You may find this already useful:

http://preview.docs.typo3.org/typo3/extensions/

The "nightly" versions already reflect TYPO3-4_7. You'll find the
english versions of the official documents and of the system
extensions.

We are using just plain reST markup - no special tricks like
"field-list-tables" required. Each table row of the original documents
has been turned into a definition list.

The styling is all done in one single CSS file. All pages are linking
to that. If you know how to improve that CSS file: Answer here for the
moment. The Share font didn't work so I commented that part out.

Since there are no tables in the output and you can jump back and
forth to the table of contents I can read the documents rather well on
my Smartphone.

In a way you're looking at the first efforts on automating rendering
directly on the server. I works rather well!

Note that we aren't using Sphinx for this. It's just reST markup and
Docutils rendering. Therefor the advanced features of Sphinx aren't
available here. In our last DocTeam meeting we thought about what we
should offer the extension authors that have their documentation in
OpenOffice format. From my point of view the output at which you're
looking right now is what we could offer for display of OpenOffice
documents.

I turned "Options +Indexes" ON on the server since we need a way to
navigate als long as there aren't index pages made by some clever
service of our own. And I don't see anything that needs to be hidden.

See 'do-the-work.sh' in
http://preview.docs.typo3.org/render-sys-extensions/
if you want to know how its done. Since we are at an early stage I
edited and started that file manually for each extension.

"Thankfully" the doc_core_inside manual represents a case where the
automatic conversion process doesn't succeed. I'm saying "thankfully"
because in this case the link to "nightly/" gives you insight into
what files are being involved. The reason for not succeeding is that
the reST file contains headlines that are list items at the same time.
This is not allowed in reST and should be edited to something that
makes sense. See:
http://preview.docs.typo3.org/typo3/extensions/doc_core_inside/nightly/


Enjoy!

Martin

-- 
Certified TYPO3 Integrator | TYPO3 Documentation Team Member

http://mbless.de


More information about the TYPO3-project-documentation mailing list