Um Dokumentation in ExtBase Extensions oder FLOW Packages zu schreiben kommt das DocBook Format zum Einsatz. Eine gute Anleitung als Video ist hier zu finden:

http://flow3.typo3.org/documentation/videos/writing-docbook-manuals-for-typo3-t3cast-011/

Der empfohlene Editor ist XmlMind - kostenlos erhältlich für Verwendung in OpenSource Projekten. Zu finden unter http://xmlmind.com/xmleditor/download.shtml. Allerdings hat nur die kostenpflichtige Version die Möglichkeit zum Rendern als HTML oder PDF (im "Convert Document" Menü, welches der freien Version fehlt).

Um aus dem DocBook XML PDF oder HTML zu generieren braucht es wiederum Tools. Ich habe es mit den Tools aus FLOW3 versucht. Dazu Braucht man die 2 Packages DocBookXSLNS und DocTools.

Download:

cd FLOW3-1.0.0-alpha11-build32/Packages/Application
svn export https://svn.typo3.org/FLOW3/Packages/DocBookXSLNS/trunk DocBookXSLNS
svn export https://svn.typo3.org/FLOW3/Packages/DocTools/trunk DocTools

Aktivieren:

cd FLOW3-1.0.0-alpha11-build32
./flow3 package activate DocTools
./flow3 package activate DocBookXSLNS

Render manuals:

...für Extbase unpraktisch, da nur in Flow Packages gesucht wird. Also werde ich zu einem späteren Zeitpunkt hier fortfahren, wenn FLOW3 im Vordergrund steht, momentan ist dies noch ExtBase.

Als Beispiel nehme ich mal das DocBook XML File Introduction.xml aus dem FLOW3 Package.

HTML erzeugen mit Saxon

Saxon installieren

Download von http://sourceforge.net/projects/saxon/files/Saxon-B/saxonb8-5-1.zip/download 

Entpacken z.B. in /usr/local/saxonb8-5-1

Docbook installieren

/opt/local/bin/port install docbook-xsl

Die DocBook stylesheets sind nun unter /opt/local/share/xsl/docbook-xsl/xhtml/docbook.xsl

Rendern

java -jar /usr/local/saxonb8-5-1/saxon8.jar -o Introduction.html Introduction.xml /opt/local/share/xsl/docbook-xsl/xhtml/docbook.xsl

PDF erzeugen mit Apache FOP

FOP installieren

Download unter http://xmlgraphics.apache.org/fop/0.95. Entpacken in ein Verzeichnis (z.B. /usr/local/fop-1.0) und dort folgendes Aufrufen (siehe hierzu http://xmlgraphics.apache.org/fop/0.95/compiling.html):

ant package

PDF Rendern

Zunächst das fo erzeugen mit saxon:

java -jar /usr/local/saxonb8-5-1/saxon8.jar -o Introduction.fo Introduction.xml /opt/local/share/xsl/docbook-xsl/fo/docbook.xsl

Dann das PDF mit FOP:

./fop Introduction.fo Introduction.pdf

Skript

Hier alles zusammengefasst - erzeugt html und pdf Dateien. Aufruf: make_docbook.sh TestDocBook

#!/bin/bash
java -jar /usr/local/saxonb8-5-1/saxon8.jar -o $1.html $1.xml /opt/local/share/xsl/docbook-xsl/xhtml/docbook.xsl
java -jar /usr/local/saxonb8-5-1/saxon8.jar -o $1.fo $1.xml  /opt/local/share/xsl/docbook-xsl/fo/docbook.xsl
/usr/local/fop-1.0/fop $1.fo $1.pdf