You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by jv...@apache.org on 2006/11/28 22:22:38 UTC

svn commit: r480211 - in /maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt: index.apt usage.apt

Author: jvanzyl
Date: Tue Nov 28 13:22:35 2006
New Revision: 480211

URL: http://svn.apache.org/viewvc?view=rev&rev=480211
Log:
o adding more doco to the plugin, almost passing docck

Modified:
    maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/index.apt
    maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/usage.apt

Modified: maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/index.apt?view=diff&rev=480211&r1=480210&r2=480211
==============================================================================
--- maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/index.apt Tue Nov 28 13:22:35 2006
@@ -17,8 +17,13 @@
 
 * Goals Overview
 
-  * {{{superduper-transform.html}superduper:transform}} retrieves specified
-    remote resource bundles, process them and places them in your <<<${basedir}/target/classes>>> directory.
+  * {{{bundle-mojo.html}remote-resources:bundle}} creates the resource bundle manifest required
+    by the remote resource bundle processing. The manifest file, 
+    <<<${basedir}/target/classes/META-INF/maven/remoteresources.xml>>>, is created from the contents of the 
+    <<<src/main/resources>>>.
+        
+  * {{{process-mojo.html}remote-resources:process}} retrieves the specified
+    remote resource bundles, processes them and places them in your <<<${basedir}/target/classes>>> directory.
 
   []
 

Modified: maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/usage.apt?view=diff&rev=480211&r1=480210&r2=480211
==============================================================================
--- maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-remote-resources-plugin/src/site/apt/usage.apt Tue Nov 28 13:22:35 2006
@@ -8,14 +8,38 @@
 
 Usage
 
- This plugin is used to create miraculously transform your build!
+* How to Create a Resource Bundle
+
+ In order to turn on the bundle resource manifest generation you need to configure the 
+ plugin as follows.
+
+-------------------
+<project>
+  ...  
+  <build>
+    <plugins>
+      <!-- Turn this into a lifecycle -->
+      <plugin>      
+        <artifactId>maven-remote-resources-plugin</artifactId>        
+        <executions>
+          <execution>
+            <goals>
+              <goal>bundle</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>
+
+------------------- 
  
-*How to miraculously transform your build
+ This will triggering the scanning of your <<<${basedir}/src/main/resources>>> directory and create the
+ <<<${basedir}/target/classes/META-INF/maven/remote-resources.xml>>> manifest file.
  
- Describe here how you miraculously transform peoples' builds! 
+* How to Use Remote Resource Bundles 
 
 -------------------
-
-Put your awesome example here.
 
 -------------------