<?xml version="1.0" encoding="UTF-8"?>
<!--
 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.
-->
<document>

 <properties>
  <title>Torque Maven Plugin</title>
 </properties>

 <body>
  <section name="Introduction">
    <p>
      The Torque Maven plugin provides the Maven 2/3 integration of the
      Torque generator.
    </p>
    <p>
      The only goal this plugin offers currently is the "generate" goal, which
      starts the Torque generator. 
      A basic configuration for using pre-defined templates would be
    </p>
    <source><![CDATA[
      <plugin>
        <groupId>org.apache.torque</groupId>
        <artifactId>torque-maven-plugin</artifactId>
        <version>4.0</version>
        <executions>
          <execution>
            <id>generate-sources</id>
            <phase>generate-sources</phase>
            <goals>
              <goal>generate</goal>
            </goals>
            <configuration>
              <packaging>classpath</packaging>
              <configPackage>${templates-config-package}</configPackage>
              <sourceDir>${source-dir}</sourceDir>
              ...
            </configuration>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>${templates-group-id}</groupId>
            <artifactId>${templates-artifact-id}</artifactId>
            <version>${templates-version}</version>
          </dependency>
        </dependencies>
      </plugin>
     ]]></source>   
    <p>
      See the documentation of the template package to get the values for
      ${templates-config-package}, ${templates-group-id}, 
      ${templates-artifact-id} and ${templates-version}.
      Set ${source-dir} to the directory where the source files for the
      generation are located.
    </p>
    <p>
      See <a href="generate-goal.html">the generate goal documentation</a>
      for the available configuration parameters.
    </p> 
  </section>
 </body>
</document>