src/site/apt/usage.apt.vm

 -----
 Usage
 -----
 Lukas Theussl
 -----
 2012-04-13
 ------

~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements.  See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership.  The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License.  You may obtain a copy of the License at
~~
~~   http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied.  See the License for the
~~ specific language governing permissions and limitations
~~ under the License.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html

Usage

 Below is a sample <<<pom.xml>>> illustrating how to use it.

+------------------------------------------------------
      <plugin>
        <groupId>org.apache.maven.doxia</groupId>
        <artifactId>doxia-book-maven-plugin</artifactId>
        <version>${project.version}</version>
        <executions>
          <execution>
            <phase>pre-site</phase>
            <goals>
              <goal>render-books</goal>
            </goals>
          </execution>
        </executions>
        <configuration>
          <books>
            <book>
              <directory>src/books/example-book</directory>
              <descriptor>src/books/example-book.xml</descriptor>
              <formats>
                <format>
                  <id>latex</id>
                </format>
                <format>
                  <id>xdoc</id>
                </format>
                <format>
                  <id>pdf</id>
                </format>
                <format>
                  <id>rtf</id>
                </format>
              </formats>
            </book>
          </books>
        </configuration>
      </plugin>
+------------------------------------------------------

 See also the sample given on the main Doxia {{{http://maven.apache.org/doxia/book/index.html}site}}.