1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
We're using the DocBook XSL distribution for HTML and PDF
generation. The best results can be achieved with the
Saxon XSLT processor (don't use Xalan!) and the Apache
FOP library.
The documentation is generated by Red5's build.xml file
for Ant. Targets included are:
* doc-pdf - generates the PDF documentation
* doc-html - generates the HTML documentation
* doc-htmlsingle - generates single page HTML documentation
* doc-clean - clean any output directories for docs
NOTE: You will need to setup trac login details so the wiki2docbook tool is able
to collect the trac wiki pages to convert to docbook xml.
In the red5 build.properties file locate these properties, and place your
trac login details here.
trac.url=http://trac.red5.org/login/xmlrpc
trac.username=
trac.password=
trac.page=Documentation/UsersReferenceManual
To generate documentation, you need to include a lot
of libraries, which haven't been added to SVN because
they're simply too big. The libraries can be found at:
http://red5.electroteque.org/doc/reference/docbook-reference-libs.tar.bz2.
doc-prepare target will download these libs and extract them to the lib directory.
The fulllist of required libraries are:
ant-contrib-1.0b3.jar - Ant Contrib - http://downloads.sourceforge.net/ant-contrib/ant-contrib-1.0b3-bin.tar.gz?modtime=1162486708&big_mirror=0
fop.jar - FOP - http://xmlgraphics.apache.org/fop/download.html
fop-hyph.jar - Objects For Formatting Objects required for FOP hypenation - http://offo.sourceforge.net/
avalon-framework-4.2.0.jar - Apache Avalon Framework required by FOP - http://avalon.apache.org/closed.html
batik-util.jar - Batik required by FOP - http://xmlgraphics.apache.org/batik/download.cgi
commons-io-1.4.jar - Apache Commons IO required by FOP - http://commons.apache.org/io/
commons-logging-1.1.1.jar - Apache Commons Logging required by FOP - http://commons.apache.org/logging/
xmlgraphics-commons-1.3.1.jar - XML Graphics Commons required for FOP images - http://xmlgraphics.apache.org/commons/download.html
saxon.jar - Saxon 6.5 - http://saxon.sourceforge.net/
xercesImpl.jar - Xerces required for Xinclude parsing - http://xerces.apache.org/xerces-j/
xalan.jar - Xalan required by Xerces ?? - http://xml.apache.org/xalan-j/
docbook-5.0 - Docbook 5 XML - http://www.docbook.org/xml/5.0/
docbook-xsl-ns - Docbook XSL Namespace Stylesheets required by Docbook 5 - http://sourceforge.net/project/showfiles.php?group_id=21935&package_id=219178
saxon-dbxsl-extensions.jar - Docbook XSL Extensions for Saxon - http://sourceforge.net/project/showfiles.php?group_id=21935&package_id=243973
xslthl-2.0.0.jar - XSLT Syntax Highlighting Extension - http://sourceforge.net/projects/xslthl
The Docbook 5 reference - http://www.docbook.org/tdg5/en/html/docbook.html
Thanks to Hibernate + Spring Framework, for providing the skeleton for the
DocBook documentation!
Author: Dan Rossi (spam@electroteque.org)
|
