doxia-book:render-books

Full name:

org.apache.maven.doxia:doxia-book-maven-plugin:1.3-SNAPSHOT:render-books

Description:

A Mojo to create books in different output formats.

Attributes:

  • Requires a Maven project to be executed.
  • Since version: 1.0.

Required Parameters

Name Type Since Description
books List 1.0 A list of books.

Optional Parameters

Name Type Since Description
basedir File 1.0 Base directory of the project.
Default value is: ${basedir}.
generatedDocs File 1.0 Directory containing the generated project docs.
Default value is: ${project.build.directory}/generated-site.
inputEncoding String 1.0 Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
locales String 1.0 A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
Default value is: ${locales}.
outputEncoding String 1.0 Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.

Parameter Details

basedir:

Base directory of the project.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${basedir}

books:

A list of books.
  • Type: java.util.List
  • Since: 1.0
  • Required: Yes

generatedDocs:

Directory containing the generated project docs.
  • Type: java.io.File
  • Since: 1.0
  • Required: No
  • Default: ${project.build.directory}/generated-site

inputEncoding:

Specifies the input encoding.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

locales:

A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Default: ${locales}

outputEncoding:

Specifies the output encoding.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • Expression: ${outputEncoding}
  • Default: ${project.reporting.outputEncoding}