jdocbook:generate

This mojo's responsibility within the plugin/packaging is actually performing the DocBook transformations. At the highest level, it takes the source and process it via the specified DocBook XSLT to produce output.

Mojo Attributes:

Required Parameters

Name Type Description
formats Format[] The formats in which to perform rendering.
sourceDocumentName String The name of the document (relative to sourceDirectory) which is the document to be rendered.

Optional Parameters

Name Type Description
cssDirectory File The directory containing local css
fontConfig String The relative path font configuration to use.
fontsDirectory File The directory containing local fonts
imagesDirectory File The directory containing local images
masterTranslationArtifactId String The artifactId of the master translation (unless, of course, this is the master translation). It is assumed that the master translation:
  1. is part of the same groupId
  2. has its source defined as a dependency (classifier = source)
masterTranslationFile File Local path to the master translation to use for diff reporting.
options Options Configurable options
sourceDirectory File The directory where the sources are located.
targetDirectory File The directory where the output will be written.

Parameter Details

cssDirectory The directory containing local css
fontConfig The relative path font configuration to use.
fontsDirectory The directory containing local fonts
formats The formats in which to perform rendering.
imagesDirectory The directory containing local images
masterTranslationArtifactId The artifactId of the master translation (unless, of course, this is the master translation). It is assumed that the master translation:
  1. is part of the same groupId
  2. has its source defined as a dependency (classifier = source)
masterTranslationFile Local path to the master translation to use for diff reporting.
options Configurable options
sourceDirectory The directory where the sources are located.
sourceDocumentName The name of the document (relative to sourceDirectory) which is the document to be rendered.
targetDirectory The directory where the output will be written.