svn commit: r1360037 - in /creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt: index.apt index.apt.vm usage.apt usage.apt.vm

[rd...@apache.org]

Author: rdonkin
Date: Wed Jul 11 06:55:42 2012
New Revision: 1360037

URL: http://svn.apache.org/viewvc?rev=1360037&view=rev
Log:
Usage documentation for generate, and switched to vm pre-processing to allow version numbers to be parameterised from the pom.

Added:
    creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/index.apt.vm
      - copied unchanged from r1358605, creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/index.apt
    creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt.vm
      - copied, changed from r1360017, creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt
Removed:
    creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/index.apt
    creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt

Copied: creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt.vm (from r1360017, creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt)
URL: http://svn.apache.org/viewvc/creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt.vm?p2=creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt.vm&p1=creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt&r1=1360017&r2=1360037&rev=1360037&view=diff
==============================================================================
--- creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt (original)
+++ creadur/whisker/trunk/apache-whisker-plugin4maven/src/site/apt/usage.apt.vm Wed Jul 11 06:55:42 2012
@@ -21,4 +21,57 @@
 
 Usage
 
- See {{{./generate-mojo.html} generate mojo}}.
\ No newline at end of file
+ The Apache Whisker 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-plugin4maven</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
\ No newline at end of file