Documentation

Description

Ant4docbook is an ant task for processing docbook xml documents.

• see: http://ant.apache.org/
• see: http://www.docbook.org/

Installation

1. Apache ant

Download and install latest version of apache ant. Optionally set env variable

# Example for linux
ANT_HOME=/path/to/apache-ant
PATH=$ANT_HOME/bin:$PATH

2. Ant4docbook

Download latest version of ant4docbook on sourceforge.

• copy ant4x.jar to $ANT_HOME/lib,
• copy ant4docbook.jar to $ANT_HOME/lib.

Transformation

Ant4docbook transforms docbook files into other formats using different technologies :

• DocBook XSL stylesheets and XSL Formatting Objects, to process:
  • docbook to pdf
  • docbook to epub

• Pandoc to process:
  • docbook to docx
  • and any other format supported by pandoc…

Aggregation

Ant4docbook may aggregates some files to split some huge ones:

• some other docbook files
• but also some markdown, plantuml files

see :

• XInclude Markdown inside DocBook
• XInclude Plantuml inside DocBook

Preprocessing

Ant4docbook may preprocess docbook files using freemarker engine to add variables and conditions on docbook files.

see : Preprocessing docbook or markdown with freemarker task

Miscellaneous

Encoding

By default, all files are processed as UTF-8.

Debugging

Debugging process

Global properties

DocBook task have parameters and inner elements to define behavior. Nevertheless, some global properties are useful to set some specific points.

Attribute	Description	Value	Required
ant4docbook. keepTempFiles	keep temp files (for debugging)	<property name="ant4docbook. keepTempFiles” value="true	false*"/>
ant4docbook.dtd. validating	use dtd validator	<property name="ant4docbook.dtd. validating” value="true	false*"/>
ant4docbook.fop	external fo processor	/path/to/fo/processor	no