------
  Usage
  ------

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~
~~  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.    
~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Usage

 The Apache Whisker Maven Plugin allows {{{http://creadur.apache.org/whisker} Whisker}}
 features to be integrated into a Maven built project. The following examples
 illustrate the basic usage of this plugin.

* Generate Licensing Documents From Meta-Data

 {{{http://creadur.apache.org/whisker} Apache Whisker}} generates licensing
 documentation (for example, <<<LICENSE>>> and <<<NOTICE>>> documents) from
 a meta-data document. Read more about this format 
 {{{http://creadur.apache.org/whisker/meta-data.html} here}} (in the Whisker 
 documentation).
 
 Configure the path (to the meta-data describing the licensing)
 using the <<<descriptor>>> element, and generate during package.  
 
 Let's say, for example, that the meta-data path in your project is 
 <<<descriptor.xml>>>. Then <<<LICENSE>>> and <<<NOTICE>>> documents
 could be generated each build by adding (to the project <<<pom.xml>>>) 
 a plugin definition something like:
 
+---------------------------------------+
  ...
  <build>
    <plugins>
        ...
        <plugin>
          <groupId>org.apache.creadur.whisker</groupId>
            <artifactId>apache-whisker-maven-plugin</artifactId>
            <version>${project.version}</version>
            <executions>
                <execution>
                    <id>generate-licensing-docs</id>
                    <phase>package</phase>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <descriptor>descriptor.xml</descriptor>
            </configuration>
        </plugin>
        ...
    </plugins>
  </build>
  ...
 
+---------------------------------------+

 In short:
 
   * Execution whisker in <<<generate>>> phase
   
   * Configure descriptor path in <<<descriptor>>> element