Format is the term used to describe a particular output option for a DocBook transformation. For example, we might talk about the PDF output format, or the HTML output format.
The jDocBook Plugin has support for most of the standard DocBook defined formats as (as of DocBook version 1.70.1 and later). For completeness, here is the full list of supported formats (as defined by the StandardDocBookFormatSpecification class):
Configuration of formats occurs via the Format class. The list of configurable properties defined by the Format config class include:
These Format values are combined with the corresponding StandardDocBookFormatSpecification values to determine the options used for that output format, with the Format values given precedence.
Here is a minimal configuration defining PFD and HTML output formats:
<plugin> <groupId>org.jboss.maven.plugins</groupId> <artifacId>maven-jdocbook-plugin</artifactId> <extensions>true</extensions> <configuration> <formats> <format> <formatName>pdf</formatName> </format> <format> <formatName>html</formatName> </format> </formats> </configuration> </plugin>
The jDocBook Plugin uses staging for handling of images, css and fonts in a consistent manner. All of these resources miight come from multiple sources and DocBook, generally speaking, only allows defining a single path for resources. To get around that, the jDocBook Plugin collects all those resources together under a single staging directory. By default, this directory is target/staging directory, and each type of resource is under that. In general there is not much to configure here, although you can point at alternate source directories for css, fonts and images:
<plugin> <groupId>org.jboss.maven.plugins</groupId> <artifacId>maven-jdocbook-plugin</artifactId> <extensions>true</extensions> <configuration> ... <imagesDirectory>path/to/alternate/image/dir</imagesDirectory> <cssDirectory>path/to/alternate/css/dir</cssDirectory> <fontsDirectory>path/to/alternate/fonts/dir</fontsDirectory> </configuration> </plugin>
Or to an alternate location to use for staging:
<plugin> <groupId>org.jboss.maven.plugins</groupId> <artifacId>maven-jdocbook-plugin</artifactId> <extensions>true</extensions> <configuration> ... <stagingDirectory>path/to/alternate/staging/dir</stagingDirectory> </configuration> </plugin>