maven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From denn...@apache.org
Subject svn commit: r751802 - in /maven/plugins/trunk/maven-war-plugin/src/site: apt/ apt/examples/ fml/
Date Mon, 09 Mar 2009 19:35:46 GMT
Author: dennisl
Date: Mon Mar  9 19:35:46 2009
New Revision: 751802

URL: http://svn.apache.org/viewvc?rev=751802&view=rev
Log:
o Improve the documentation.

Modified:
    maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt
    maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/file-name-mapping.apt
    maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt
    maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt
    maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt
    maven/plugins/trunk/maven-war-plugin/src/site/apt/overlays.apt
    maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt
    maven/plugins/trunk/maven-war-plugin/src/site/fml/faq.fml

Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt
(original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/adding-filtering-webresources.apt
Mon Mar  9 19:35:46 2009
@@ -29,14 +29,14 @@
 Adding and Filtering External Web Resources
 
  The default resource directory for all Maven 2 projects is <<<src/main/resources>>>
which
- will end up in <<<target/classes>>> and in <<<WEB-INF/classes>>>
in the war. The directory
+ will end up in <<<target/classes>>> and in <<<WEB-INF/classes>>>
in the WAR. The directory
  structure will be preserved in the process.
- 
- The war plugin is also capable of including resources not found in the default resource
- directory through the <<<webResources>>> parameter of the war plugin.

- 
+
+ The WAR Plugin is also capable of including resources not found in the default resource
+ directory through the <<<webResources>>> parameter.
+
 *POM configuration
- 
+
 +-------+
 <project>
   ...
@@ -89,7 +89,7 @@
                  `-- websource.jsp
 +----------+
 
- would end up in the war as:
+ would end up in the WAR as:
 
 +----------+
 documentedproject-1.0-SNAPSHOT.war
@@ -117,7 +117,7 @@
      `-- websource.jsp
 +----------+
 
- <<<external-resource2.jpg>>> and <<<image2>>> are copied
to the root of the war, preserving the
+ <<<external-resource2.jpg>>> and <<<image2>>> are copied
to the root of the WAR, preserving the
  directory structure.
 
 *Configuring webResources
@@ -130,95 +130,95 @@
 
   * can be filtered
 
-  * is not limited to the default destination - the root of the war
+  * is not limited to the default destination - the root of the WAR
 
 **Includes/Excludes
 
- To include all jpgs to the war we can add the following to our POM configuration from above:
+ To include all jpgs in the WAR we can add the following to our POM configuration from above:
 
 +----------+
-      ...
-      <configuration>
-        <webResources>
-          <resource>
-            <!-- this is relative to the pom.xml directory -->
-            <directory>resource2</directory>
-            <!-- the list has a default value of ** -->
-            <includes>
-              <include>**/*.jpg</include>
-            <includes>
-          </resource>
-        </webResources>
-      </configuration>
-      ...
-+----------+
-
- To exclude the <<<image2>>> directory from the the war add this:
-
-+----------+
-      ...
-      <configuration>
-        <webResources>
-          <resource>
-            <!-- this is relative to the pom.xml directory -->
-            <directory>resource2</directory>
-            <!-- there's no default value for this -->
-            <excludes>
-              <exclude>**/image2</exclude>
-            </excludes>
-          </resource>
-        </webResources>
-      </configuration>
-      ...
+        ...
+        <configuration>
+          <webResources>
+            <resource>
+              <!-- this is relative to the pom.xml directory -->
+              <directory>resource2</directory>
+              <!-- the list has a default value of ** -->
+              <includes>
+                <include>**/*.jpg</include>
+              <includes>
+            </resource>
+          </webResources>
+        </configuration>
+        ...
++----------+
+
+ To exclude the <<<image2>>> directory from the WAR add this:
+
++----------+
+        ...
+        <configuration>
+          <webResources>
+            <resource>
+              <!-- this is relative to the pom.xml directory -->
+              <directory>resource2</directory>
+              <!-- there's no default value for this -->
+              <excludes>
+                <exclude>**/image2</exclude>
+              </excludes>
+            </resource>
+          </webResources>
+        </configuration>
+        ...
 +----------+
 
  Be careful when mixing includes and excludes, excludes will have a higher priority.
  Includes can not override excludes if a resource matches both.
 
- Having this configuration will exclude all jpgs from the war:
+ Having this configuration will exclude all jpgs from the WAR:
 
 +----------+
-      ...
-      <configuration>
-        <webResources>
-          <resource>
-            <!-- this is relative to the pom.xml directory -->
-            <directory>resource2/</directory>
-            <!-- the list has a default value of ** -->
-            <includes>
-              <include>image2/*.jpg</include>
-            <includes>
-            <!-- there's no default value for this -->
-            <excludes>
-              <exclude>**/*.jpg</exclude>
-            </excludes>
-          </resource>
-        </webResources>
-      </configuration>
-      ...
+        ...
+        <configuration>
+          <webResources>
+            <resource>
+              <!-- this is relative to the pom.xml directory -->
+              <directory>resource2/</directory>
+              <!-- the list has a default value of ** -->
+              <includes>
+                <include>image2/*.jpg</include>
+              <includes>
+              <!-- there's no default value for this -->
+              <excludes>
+                <exclude>**/*.jpg</exclude>
+              </excludes>
+            </resource>
+          </webResources>
+        </configuration>
+        ...
 +----------+
 
  Here's another example of how to specify include and exclude patterns:
 
 +----------+
-      ...
-      <configuration>
-        <webResources>
-          <resource>
-            <!-- the default value is ** -->
-            <includes>
-              <include>**/pattern1</include>
-              <include>*pattern2</include>
-            <includes>
-            <!-- there's no default value for this -->
-            <excludes>
-              <exclude>*pattern3/pattern3</exclude>
-              <exclude>pattern4/pattern4</exclude>
-            </excludes>
-          </resource>
-        </webResources>
-      </configuration>
-      ...
+        ...
+        <configuration>
+          <webResources>
+            <resource>
+              <!-- the default value is ** -->
+              <includes>
+                <include>**/pattern1</include>
+                <include>*pattern2</include>
+              <includes>
+              <!-- there's no default value for this -->
+              <excludes>
+                <exclude>*pattern3/pattern3</exclude>
+                <exclude>pattern4/pattern4</exclude>
+              </excludes>
+            </resource>
+          </webResources>
+        </configuration>
+        ...
 +----------+
 
 **Filtering
@@ -256,37 +256,38 @@
                  `-- websource.jsp
 +----------+
 
-  To prevent corrupting your binary files where filtering is enabled, you can configure a
list of file extensions to not filter.
+  To prevent corrupting your binary files when filtering is enabled, you can configure a
list of file extensions that
+  will not be filtered.
 
 +----------+
-      ...
-      <configuration>
-        <!-- the default value is the filter list under build -->
-        <!-- specifying a filter will override the filter list under build -->
-        <filters>
-          <filter>properties/config.prop</filter>
-        </filters>
-        <nonFilteredFileExtensions>
-          <!-- default value contains jpg,jpeg,gif,bmp,png -->
-          <nonFilteredFileExtension>pdf</nonFilteredFileExtensions>
-        </nonFilteredFileExtensions>
-        <webResources>
-          <resource>
-            <directory>resource2</directory>
-            <!-- it's not a good idea to filter binary files -->
-            <filtering>false</filtering>
-          </resource>
-          <resource>
-            <directory>configurations</directory>
-            <!-- enable filtering -->
-            <filtering>true</filtering>
-            <excludes>
-              <exclude>**/properties</exclude>
-            </excludes>
-          </resource>
-        </webResources>
-      </configuration>
-      ...
+        ...
+        <configuration>
+          <!-- the default value is the filter list under build -->
+          <!-- specifying a filter will override the filter list under build -->
+          <filters>
+            <filter>properties/config.prop</filter>
+          </filters>
+          <nonFilteredFileExtensions>
+            <!-- default value contains jpg,jpeg,gif,bmp,png -->
+            <nonFilteredFileExtension>pdf</nonFilteredFileExtension>
+          </nonFilteredFileExtensions>
+          <webResources>
+            <resource>
+              <directory>resource2</directory>
+              <!-- it's not a good idea to filter binary files -->
+              <filtering>false</filtering>
+            </resource>
+            <resource>
+              <directory>configurations</directory>
+              <!-- enable filtering -->
+              <filtering>true</filtering>
+              <excludes>
+                <exclude>**/properties</exclude>
+              </excludes>
+            </resource>
+          </webResources>
+        </configuration>
+        ...
 +----------+
 
 *** <<<config.prop>>>
@@ -303,7 +304,7 @@
 </another_ioc_container>
 +----------+
 
- The resulting war would be:
+ The resulting WAR would be:
 
 +----------+
 documentedproject-1.0-SNAPSHOT.war
@@ -337,37 +338,37 @@
 +----------+
 <another_ioc_container>
    <configuration>some_config_value</configuration>
-</another_ioc_container>   
+</another_ioc_container>
 +----------+
 
 **Overriding the default destination directory
 
- By default web resources are copied to the root of the war, as shown in the previous example.

+ By default web resources are copied to the root of the WAR, as shown in the previous example.
  To override the default destination directory, specify the target path.
 
 +----------+
-      ...
-      <configuration>
-        <webResources>
-          <resource>
-            ...
-          </resource>
-          <resource>
-            <directory>configurations</directory>
-            <!-- override the destination directory for this resource -->
-            <targetPath>WEB-INF</targetPath>
-            <!-- enable filtering -->
-            <filtering>true</filtering>
-            <excludes>
-              <exclude>**/properties</exclude>
-            </excludes>
-          </resource>
-        </webResources>
-      </configuration>
-      ...
+        ...
+        <configuration>
+          <webResources>
+            <resource>
+              ...
+            </resource>
+            <resource>
+              <directory>configurations</directory>
+              <!-- override the destination directory for this resource -->
+              <targetPath>WEB-INF</targetPath>
+              <!-- enable filtering -->
+              <filtering>true</filtering>
+              <excludes>
+                <exclude>**/properties</exclude>
+              </excludes>
+            </resource>
+          </webResources>
+        </configuration>
+        ...
 +----------+
 
- Using the sample project the resulting war would look like this:
+ Using the sample project the resulting WAR would look like this:
 
 +----------+
 documentedproject-1.0-SNAPSHOT.war

Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/file-name-mapping.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/file-name-mapping.apt?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/file-name-mapping.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/file-name-mapping.apt Mon Mar
 9 19:35:46 2009
@@ -27,7 +27,7 @@
 
 Using File Name Mapping
 
- It might be necessary to customize the file name of libraries and TLD. By default, those
resources are stored
+ It might be necessary to customize the file name of libraries and TLDs. By default, those
resources are stored
  using the following pattern:
 
 +-----
@@ -41,10 +41,10 @@
 +-----
 
  The <<<outputFileNameMapping>>> parameter allows you to give a custom
pattern. Each token defined in the
- pattern will be replaced with the value for the current Artifact. You can use any property
of Artifact and
+ pattern will be replaced with the value for the current artifact. You can use any property
of Artifact and
  ArtifactHandler as a token.
 
- For instance, to store the libraries and TLDs with no versioning, use the following pattern:
+ For instance, to store the libraries and TLDs without version numbers, use the following
pattern:
 
 +-----
 @{artifactId}@.@{extension}@

Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt
(original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/rapid-testing-jetty6-plugin.apt
Mon Mar  9 19:35:46 2009
@@ -28,15 +28,15 @@
 
 Rapid Testing Using the Jetty Plugin
 
- Normally, testing a web application involves compiling java sources, creating a war and

+ Normally, testing a web application involves compiling java sources, creating a WAR and
  deploying it to a web container.
 
- But using the Jetty plugin enables you to quickly test your web application by skipping
- the last two steps. By default the Jetty plugin scans your <<<target/classes>>>
for
+ Using the Jetty Plugin enables you to quickly test your web application by skipping
+ the last two steps. By default the Jetty Plugin scans your <<<target/classes>>>
for
  any changes in your java sources and <<<src/main/webapp>>> for your web
sources.
- The Jetty plugin will automatically reload the modified classes and web sources.
+ The Jetty Plugin will automatically reload the modified classes and web sources.
 
- To use the Jetty plugin just add the following in your <<<pom.xml>>>:
+ To use the Jetty Plugin just add the following in your <<<pom.xml>>>:
 
 +-----------------+
 <project>
@@ -64,11 +64,11 @@
 +-----------------+
 
  Then start Jetty:
- 
+
 +-----------------+
   mvn jetty:run
 +-----------------+
 
  The command will block with Jetty listening on port 8080.
 
- Check the {{{http://docs.codehaus.org/display/JETTY/Maven+Jetty+Plugin}Jetty plugin documentation}}
for more details.
+ Check the {{{http://docs.codehaus.org/display/JETTY/Maven+Jetty+Plugin}Jetty Plugin documentation}}
for more details.

Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/skinny-wars.apt Mon Mar  9
19:35:46 2009
@@ -34,7 +34,7 @@
  the J2EE specification allows WARs to reference external JARs packaged within the EAR
  via the <<<Class-Path>>> setting in their <<<MANIFEST.MF>>>.
 
- The Maven WAR and EAR plugins do not directly support this mode of operation but
+ The Maven WAR and EAR Plugins do not directly support this mode of operation but
  we can fake it through some POM and configuration magic.  First you need to tell
  Maven to exclude the dependent JARs and add references to them in the <<<MANIFEST.MF>>>
  instead.  This goes into your WAR project's <<<pom.xml>>>:

Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-manifest-guide.apt Mon
Mar  9 19:35:46 2009
@@ -1,5 +1,5 @@
  ------
- War Manifest Customization
+ WAR Manifest Customization
  ------
  Pete Marvin King
  ------
@@ -26,9 +26,9 @@
 ~~ NOTE: For help with the syntax of this file, see:
 ~~ http://maven.apache.org/doxia/references/apt-format.html
 
-War Manifest Customization
+WAR Manifest Customization
 
- The manifest can be customized by configuring the war plugin's archiver. For full information
on the different
+ The manifest can be customized by configuring the WAR Plugin's archiver. For full information
on the different
  configuration options available check the documentation for
  {{{http://maven.apache.org/shared/maven-archiver/index.html}Maven Archiver}}.
  This version of Maven WAR Plugin uses Maven Archiver 2.4.
@@ -70,9 +70,9 @@
 
 *Generating a manifest classpath
 
-  Generating a manifest classpath for a war is similar to for a jar, but there are a couple
of slight differences since
-  you normally don't want a jar in both the manifest classpath and the <<<WEB-INF/lib>>>.
 Customize the war plugin's
-  archiver:
+  Generating a manifest classpath for a WAR is similar to for a JAR, but there are a couple
of slight differences since
+  you normally don't want a JAR in both the manifest classpath and the <<<WEB-INF/lib>>>
directory.  Customize the WAR
+  Plugin's archiver:
 
 +--------------------+
 <project>
@@ -100,7 +100,8 @@
 
   Now, you can control which dependencies are included in <<<WEB-INF/lib>>>
and in the manifest classpath by following
   these examples.  Maven will follow the transitive dependency tree until it gets to artifacts
scoped as "provided".
-  Note that no way is shown to include a dependency in <<<WEB-INF/lib>>>
but not the manifest classpath.
+
+  <<Note:>> No way is shown how to include a dependency in <<<WEB-INF/lib>>>
but not in the manifest classpath.
 
 +--------------------+
 <project>
@@ -132,5 +133,5 @@
 </project>
 +--------------------+
 
-  Check the {{{http://maven.apache.org/guides/mini/guide-manifest.html}Guide to manifest
customization}} for more
+  Check the {{{http://maven.apache.org/guides/mini/guide-manifest.html}Guide to Working with
Manifests}} for more
   examples.

Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/overlays.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/overlays.apt?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/overlays.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/overlays.apt Mon Mar  9 19:35:46 2009
@@ -28,11 +28,11 @@
 
 Overlays
 
- Overlays are meant to share common resources accross multiple web applications. In general,
- all dependencies of a war project are collected in <<<WEB-INF/lib>>> except
for war
- artifacts that are overlayed on the war source.
+ Overlays are used to share common resources accross multiple web applications. In general,
+ all dependencies of a WAR project are collected in <<<WEB-INF/lib>>> except
for WAR
+ artifacts that are overlayed on the WAR source.
 
- In previous versions of the war plugin, no configuration was necessary. This is still the
+ In previous versions of the WAR Plugin, no configuration was necessary. This is still the
  case if you are happy with the default settings. However, if you need more control, read
on!
 
 * Overlays at a glance
@@ -84,7 +84,7 @@
  `-- index-dependency.jsp
 +-----------------+
 
- Assuming that you've declared the war artifact as a dependency in your <<<pom.xml>>>:
+ Assuming that you've declared the WAR artifact as a dependency in your <<<pom.xml>>>:
 
 +-----------------+
   ...
@@ -101,7 +101,7 @@
   ...
 +-----------------+
 
- the resulting war would end up like this:
+ the resulting WAR would end up like this:
 
 +-----------------+
 
@@ -134,7 +134,7 @@
 
 * Overlay types
 
-  The war plugin handles both <<war>> and <<zip>> artifacts. However,
for backard compatibility reason, zip
+  The WAR Plugin handles both <<war>> and <<zip>> artifacts. However,
for backard compatibility reason, zip
   overlays are handled only if they are defined explicitely in the plugin's configuration.
 
 
@@ -142,7 +142,7 @@
 
   The {overlay} element can be configured as follows:
 
-  * <<id>> - sets the id of the overlay. If none is provided, the war plugin
will
+  * <<id>> - sets the id of the overlay. If none is provided, the WAR Plugin
will
   generate one.
 
   * <<groupId>> - sets the groupId of the overlay artifact you want to configure.
@@ -151,7 +151,7 @@
   configure.
 
   * <<type>> - sets the type of the overlay artifact you want to
-  configure. By default, war.
+  configure. Default value is: <<<war>>>.
 
   * <<classifier>> - sets the classifier of the overlay artifact you want to
   configure if multiple artifacts matches the groupId/artifact.
@@ -162,15 +162,15 @@
   is excluded.
 
   * <<targetPath>> - sets the target relative path in the webapp structure, which
is only
-  available for <<war>> overlays. By default, the content of the overlay is added
in the root
+  available for <<<war>>> types. By default, the content of the overlay
is added in the root
   structure of the webapp.
 
-  * <<skip>> - set to <<<true>>> to skip this overlay. Default
is <<<false>>>.
+  * <<skip>> - set to <<<true>>> to skip this overlay. Default
value is: <<<false>>>.
 
   []
 
   For instance, to exclude the <<<sampleimage-dependency.jpg>>> of our
-  <<<documentedprojectdependency>>> war overlay above:
+  <<<documentedprojectdependency>>> <<<war>>> overlay
above:
 
 +-----------------+
   ...
@@ -230,7 +230,7 @@
               <artifactId>my-webapp</artifactId>
             </overlay>
             <overlay>
-              <!-- empty groupId/artifactId detected as the current build -->
+              <!-- empty groupId/artifactId is detected as the current build -->
             </overlay>
           </overlays>
         </configuration>
@@ -241,12 +241,12 @@
 +-----------------+
 
   Note that in the scenario above, any other overlay will be applied after the current build
-  since they have not been configured in the <<<overlays>>> section.
+  since they have not been configured in the <<<overlays>>> element.
 
-  To perform an even fine grained overwriting policy, overlays can be packaged multiple times
+  To perform an even more fine grained overwriting policy, overlays can be packaged multiple
times
   with different includes/excludes. For instance if the <<<index.jsp>>>
file of the
   overlay <<<my-webapp>>> <<must>> be set in the webapp but
other files can be controlled the
-  regular way, define two overlays configuration for <<<my-webapp>>>:
+  regular way, define two overlay configurations for <<<my-webapp>>>:
 
 +-----------------+
   ...
@@ -266,7 +266,7 @@
               </includes>
             </overlay>
             <overlay>
-              <!-- empty groupId/artifactId detected as the current build -->
+              <!-- empty groupId/artifactId is detected as the current build -->
             </overlay>
 
             <!-- Other overlays here if necessary -->
@@ -287,10 +287,10 @@
 
 * Overlay global settings
 
-   The following settings can be specified globally and modify further the way overlays are
applied.
+   The following settings can be specified globally and modify the way overlays are applied.
 
    * <<dependentWarIncludes>> - sets the default includes to apply to all overlays.
Any overlay that
-    has no specific <<<includes>>> section inherit this settings by default.
+    has no specific <<<includes>>> element will inherit this setting by
default.
 
 +-----------------+
     ...
@@ -307,7 +307,7 @@
 +-----------------+
 
    * <<dependentWarExcludes>> - sets the default excludes to apply to all overlays.
Any overlay that
-    has no specific <<<excludes>>> section inherit this settings by default.
+    has no specific <<<excludes>>> element will inherit this setting by
default.
 
 +-----------------+
     ...
@@ -340,7 +340,7 @@
     ...
 +-----------------+
 
-  * <<useCache>> - set to <<<false>>> to disable the webapp
structure cache. Defaults to <<<true>>>.
+  * <<useCache>> - set to <<<false>>> to disable the webapp
structure cache. Default value is: <<<true>>>.
 
 +-----------------+
     ...

Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt Mon Mar  9 19:35:46 2009
@@ -28,26 +28,26 @@
 
 Usage
 
- There are 4 ways to use the war plugin:
- 
+ There are 4 ways to use the WAR Plugin:
+
  * using the <<<package>>> phase with the project package type as <<<war>>>
- 
+
  * invocation of the <<<war:war>>> goal
- 
+
  * invocation of the <<<war:exploded>>> goal
- 
+
  * invocation of the <<<war:inplace>>> goal
 
  []
 
  <<Note:>> When using the <<<war:>>> goals it is assumed that
the <<<compile>>> phase is already done.
- The war plugin is not responsible for compiling the java sources or copying of the resources.

+ The WAR Plugin is not responsible for compiling the java sources or copying the resources.
 
 *Using the <<<package>>> phase with the project package type as war / invocation
of the <<<war:war>>> goal
 
- This is the common way of using the war plugin. 
+ This is the general way of using the WAR Plugin.
  To illustrate, here's the <<<pom.xml>>> for our project:
-    
+
 +----------+
 <project>
   ...
@@ -62,7 +62,7 @@
 +----------+
 
  The project's structure looks like this:
- 
+
 +----------+
  .
  |-- pom.xml
@@ -86,7 +86,7 @@
 +----------+
 
  Invoking
- 
+
 +----------+
 mvn package
 +----------+
@@ -95,10 +95,10 @@
 
 +----------+
 mvn compile war:war
-+----------+ 
++----------+
+
+ will generate the WAR file <<<target/documentedproject-1.0-SNAPSHOT.war>>>.
Here are the contents of that WAR file:
 
- will generate the war file <<<target/documentedproject-1.0-SNAPSHOT.war>>>.
Here are the contents of that war file: 
-  
 +----------+
 documentedproject-1.0-SNAPSHOT.war
   |-- META-INF
@@ -123,18 +123,18 @@
 +----------+
 
 *Invocation of <<<war:exploded>>> goal
- 
- To speed up testing during the developement phase, <<<war:explode>>> can
be use to generate the war in exploded
+
+ To speed up testing during the developement phase, <<<war:explode>>> can
be used to generate the WAR in exploded
  form.
  Use the same project as above and invoke:
- 
+
 +----------+
 mvn compile war:exploded
 +----------+
 
- This will generate an exploded version of the war in <<<target/documentedproject-1.0-SNAPSHOT>>>.
+ This will generate an exploded version of the WAR in <<<target/documentedproject-1.0-SNAPSHOT>>>.
  The contents of that directory looks like this:
- 
+
 +----------+
  documentedproject-1.0-SNAPSHOT
  |-- META-INF
@@ -152,10 +152,10 @@
      `-- websource.jsp
 +----------+
 
- The default directory for the exploded war is <<<target/\<finalName\>>>>.
The <<<finalName>>> is usually in the form
+ The default directory for the exploded WAR is <<<target/\<finalName\>>>>.
The <<<finalName>>> is usually in the form
  of <<<\<artifactId\>-\<version\>>>>.
- This default directory can be overridden by specifying the <<<webappDirectory>>>
plugin parameter.
-  
+ This default directory can be overridden by specifying the <<<webappDirectory>>>
parameter.
+
 +-------+
 <project>
   ...
@@ -166,7 +166,7 @@
         <artifactId>maven-war-plugin</artifactId>
         <version>2.0</version>
         <configuration>
-          <webappDirectory>/sample/servlet/container/deploy/directory</webappDirectory>
   
+          <webappDirectory>/sample/servlet/container/deploy/directory</webappDirectory>
         </configuration>
       </plugin>
     </plugins>
@@ -176,17 +176,17 @@
 +-------+
 
 *Invocation of <<<war:inplace>>> goal
- 
- Another variation of <<<war:exploded>>> is <<<war:inplace>>>.
With <<<war:inplace>>> the exploded war is created
- in the webapp source, which defaults to <<<src/main/webapp>>>. 
+
+ Another variation of <<<war:exploded>>> is <<<war:inplace>>>.
With <<<war:inplace>>> the exploded WAR is created
+ in the webapp source, which defaults to <<<src/main/webapp>>>.
  Use our sample project above, and invoke:
- 
+
 +----------+
 mvn compile war:inplace
 +----------+
 
- This will result to:
- 
+ This will result in:
+
 +----------+
  .
  |-- pom.xml

Modified: maven/plugins/trunk/maven-war-plugin/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/fml/faq.fml?rev=751802&r1=751801&r2=751802&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/fml/faq.fml (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/fml/faq.fml Mon Mar  9 19:35:46 2009
@@ -24,7 +24,7 @@
    <faq id="filtering">
      <question>How is filtering done in the WAR plugin?</question>
      <answer>
-       <p>To enable filtering of <code>web.xml</code> you must configure
the war plugin as this:
+       <p>To enable filtering of <code>web.xml</code> you must configure
the WAR Plugin like this:
          <source><![CDATA[
       <plugin>
         <artifactId>maven-war-plugin</artifactId>
@@ -39,7 +39,7 @@
      </answer>
    </faq>
    <faq id="classifieruse">
-     <question>How does the classifier of dependency artifacts affect my war project?</question>
+     <question>How does the classifier of dependency artifacts affect my WAR project?</question>
      <answer>
        <p>When used, the copy of the dependency artifact in your project will have
the classifier appended to its
        filename. This can be used to differentiate duplicate artifacts.</p>
@@ -54,22 +54,22 @@
    <faq id="dependentwarexclude">
      <question>What's the difference between using dependentWarExclude and provided
scope?</question>
      <answer>
-       <p><code>dependentWarExclude</code> is used in <a href="overlays.html">war
overlays</a> for excluding dependent
-       war files from being included in the exploded war.</p>
+       <p><code>dependentWarExclude</code> is used in <a href="overlays.html">overlays</a>
for excluding dependent
+       WAR files from the exploded webapp.</p>
      </answer>
    </faq>
    <faq id="webresourcesexclude">
      <question>How do I exclude files in my web resources?</question>
      <answer>
-       <p>Use the <code>webResources</code> <code>exclude</code>
parameter to identify the tokens to use for the filtering.</p>
+       <p>Use the <code>webResources</code> <code>exclude</code>
parameter to identify the tokens to exclude.</p>
+       <p>For more information refer to <a href="examples/adding-filtering-webresources.html">Adding
and Filtering
+       External Web Resources</a>.</p>
      </answer>
    </faq>
    <faq id="waroverlaysexclude">
-     <question>How do I exclude files when doing war overlays?</question>
+     <question>How do I exclude files when doing overlays?</question>
      <answer>
-       <p>Use the <code>dependentWarExcludes</code> parameter to identify
the tokens to use for the filtering.</p>
-       <p>For more information refer to <a href="examples/adding-filtering-webresources.html">Adding
and Filtering
-       External Web Resources</a>.</p>
+       <p>Use the <code>dependentWarExcludes</code> parameter to identify
the tokens to exclude.</p>
      </answer>
    </faq>
    <faq id="configurationdoc">
@@ -81,30 +81,29 @@
        <p>
          If you need a specific version, generate it using <code>mvn site:site</code>
or use:
          <source><![CDATA[
-mvn help:describe -DgroupId=org.apache.maven.plugins -DartifactId=maven-war-plugin \
-  -Dfull=true -Dversion=<your-plugin-version-here>
+mvn help:describe -Dplugin=war -Dfull=true -Dversion=<your-plugin-version-here>
 ]]></source>
        </p>
      </answer>
    </faq>
    <faq id="attached">
-     <question>How do I create a jar containing the classes in my webapp?</question>
+     <question>How do I create a JAR containing the classes in my webapp?</question>
        <answer>
-       <p>If you would simply like to package the classes and resources as a jar in
<code>WEB-INF/lib</code>
+       <p>If you would simply like to package the classes and resources as a JAR in
<code>WEB-INF/lib</code>
            rather than as loose files under <code>WEB-INF/classes</code>, use
the following configuration:</p>
        <p>
          <source><![CDATA[
-       <plugin>
-         <artifactId>maven-war-plugin</artifactId>
-         <version>X.Y</version>
-         <configuration>
-           <archiveClasses>true</archiveClasses>
-         </configuration>
-       </plugin>
+      <plugin>
+        <artifactId>maven-war-plugin</artifactId>
+        <version>X.Y</version>
+        <configuration>
+          <archiveClasses>true</archiveClasses>
+        </configuration>
+      </plugin>
 ]]></source>
        </p>
-       <p>If you need to re-use this jar in another project, the recommended approach
is to move the classes to a
-       separate module that builds a jar, and then declare a dependency on that jar from
your webapp as well as from
+       <p>If you need to re-use this JAR in another project, the recommended approach
is to move the classes to a
+       separate module that builds a JAR, and then declare a dependency on that JAR from
your webapp as well as from
        any other projects that need it.</p>
        <p>If you can't move the classes to another project, you can deploy the classes
and resources included in
            your webapp as an "attached" artifact, with a classifier, by using the following
configuration:</p>



Mime
View raw message