NAME
docmake - a tool to render DocBook/XML into various output formats.
SYNOPSIS
# To render input.xml file into XHTML
docmake -o output.xhtml xhtml input.xml
# Same with more verbose output
docmake -v -o output.xhtml xhtml input.xml
# Render into pdf
docmake -v -o output.pdf pdf input.xml
# Same while not rebuilding if not necessary
docmake -v --make -o output.pdf pdf input.xml
# Render using a Stylesheet
docmake -v -o output.xhtml -x my-stylesheets.xsl xhtml input.xml
DESCRIPTION
docmake is a tool to render DocBook/XML into its resultant formats using XSLT: XHTML, XSL-FO, PDF, RTF, etc. For a brief help type docmake help
.
It aims to be a replacement for xmlto - http://cyberelk.net/tim/software/xmlto/ . As opposed to xmlto, it is written in Perl, which is easier to get right than xmlto's Bash, and xmlto hasn't been updated for a long time when I started work on docmake.
USAGE
The basic invocation of docmake is:
docmake [flags] MODE input.xml
MODES
The available modes are:
help
To get help.
fo
Convert to XSL-FO.
rtf
Convert to Word/RTF.
xhtml
Convert to XHTML.
pdf
Convert to PDF.
FLAGS
The available flags are:
-h ; --help
Display some rudimentary help.
--man
Display the man page.
-v ; --verbose
Verbose - output the commands' invocation as they are executed.
-o OUTPUT_PATH
Put the result in OUTPUT_PATH .
-x STYLESHEET ; --stylesheet STYLESHEET
Use the XSLT stylesheet STYLESHEET for performing XSLT transformations.
--basepath PATH
This is the base path for the DocBook stylesheets. The appropriate XSLT mode will be appended to it. This is for example, useful for building DocBook 5 documents by specifying the path to their stylesheets.
--stringparam KEY=VALUE
Specify the string parameter of KEY as VALUE. Note that as opposed to xsltproc, KEY and VALUE cannot be specified as different command line arguments, but rather should be on the same one, delimited by an equal sign ("
=
").--make
Behave like make in building files only if their dependencies are newer.
EXAMPLES
There are some examples for sample invocation in the Synopsis.
SUPPORT
You can look for information at:
Search CPAN
AnnoCPAN: Annotated CPAN documentation
CPAN Ratings
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=App::XML::DocBook::Docmake
SEE ALSO
DocBook on the Wikipedia - http://en.wikipedia.org/wiki/DocBook
DocBook/XSL - The Complete Guide - http://www.sagehill.net/docbookxsl/
The DocBook Homepage - http://www.docbook.org/
COPYRIGHT & LICENSE
Copyright 2008 Shlomi Fish, all rights reserved.
This program is released under the following license: MIT/X11 License. ( http://www.opensource.org/licenses/mit-license.php ).
AUTHOR
Shlomi Fish , http://www.shlomifish.org/ .