- SEE ALSO
- COPYRIGHT & LICENSE
- COPYRIGHT AND LICENSE
docmake - a tool to render DocBook/XML into various output formats.
# 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
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.
The basic invocation of docmake is:
docmake [flags] MODE input.xml
The available modes are:
To get help.
Convert to XSL-FO.
Convert to Word/RTF.
Convert to XHTML.
Convert to PDF.
The available flags are:
-h ; --help
Display some rudimentary help.
Display the man page.
-v ; --verbose
Verbose - output the commands' invocation as they are executed.
Put the result in OUTPUT_PATH .
-x STYLESHEET ; --stylesheet STYLESHEET
Use the XSLT stylesheet STYLESHEET for performing XSLT transformations.
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.
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 ("
Behave like make in building files only if their dependencies are newer.
There are some examples for sample invocation in the Synopsis.
You can look for information at:
AnnoCPAN: Annotated CPAN documentation
RT: CPAN's request tracker
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 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 ).
Shlomi Fish , http://www.shlomifish.org/ .
Shlomi Fish <firstname.lastname@example.org>
This software is Copyright (c) 2018 by Shlomi Fish.
This is free software, licensed under:
The MIT (X11) License
Please report any bugs or feature requests on the bugtracker website http://rt.cpan.org/Public/Dist/Display.html?Name=App-XML-DocBook-Builder or by email to email@example.com.
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
A modern, open-source CPAN search engine, useful to view POD in HTML format.
The default CPAN search engine, useful to view POD in HTML format.
RT: CPAN's Bug Tracker
The RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.
The AnnoCPAN is a website that allows community annotations of Perl module documentation.
The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.
CPAN Testers Matrix
The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.
CPAN Testers Dependencies
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
Please report any bugs or feature requests by email to
bug-app-xml-docbook-builder at rt.cpan.org, or through the web interface at https://rt.cpan.org/Public/Bug/Report.html?Queue=App-XML-DocBook-Builder. You will be automatically notified of any progress on the request by the system.
The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)
git clone http://bitbucket.org/shlomif/docmake