Maven Asciidoc Plugin

This plug-in allows you to generate documnetation with various file format using Asciidoc source file.

Setting Maven repository

Room Work eXperience repository must be added to use Asciidoc Plugin.

<repositories>
  <repository>
    <url>http://maven.r-w-x.net/releases</url>
    <id>rwx</id>
  </repository>
</repositories>

<pluginRepositories>
  <pluginRepository>
    <id>rwx</id>
    <name>Room Work Plugin Repository</name>
    <url>http://maven.r-w-x.net/releases</url>
    <layout>default</layout>
    <snapshots>
      <enabled>false</enabled>
    </snapshots>
    <releases>
      <updatePolicy>never</updatePolicy>
    </releases>
  </pluginRepository>
</pluginRepositories>

Setting documents

Documents to generate must be set in the plugin configuration

<plugin>
  <groupId>net.rwx.asciidoc</groupId>
  <artifactId>asciidoc-maven-plugin</artifactId>
  <configuration>
    <defaultBackend>pdf</defaultBackend>
    <defaultDocumentType>article</defaultDocumentType>
    <documents>
      <document>
        <title>Asciidoc Article Template</title>
        <path>article.txt</path>
        <backend>html5</backend>
      </document>
    </documents>
  </configuration>
</plugin>

Setting backend

Backend defines target format for documentation. defaultBackend is used to define default backend for every documents to generate. Each document configuration can override this value using backend.

Supported backends are :

html5	Generates HTML 5 markup
xhtml11	Generates XHTML 1.1 markup styled with CSS2. Output files have an .html extension.
html4	Generates plain HTML 4.01 Transitional markup.
slidy	Generates self-contained Slidy HTML slideshows for your web browser.
docbook	Generates DocBook XML 4.5 markup.
pdf	Generates PDF document using FOP transformation

More information on Asciidoc document type can be found on Asciidoc site.

Setting document type

Document type defines how to interpret Asciidoc source file. defaultDocumentType is used to define document type for every documents to generates. Each document configuration can override this value using documentType.

article : is used for short document.
book : is used to generates a document with multi-part and specific sections.