Author: dennisl
Date: Sat Aug 2 19:04:02 2008
New Revision: 682092
URL: http://svn.apache.org/viewvc?rev=682092&view=rev
Log:
o Rewrite some texts to make it flow better.
o Fix errors, typos and broken links.
o Add more formating.
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/index.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
maven/plugins/trunk/maven-war-plugin/src/site/site.xml
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=682092&r1=682091&r2=682092&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
Sat Aug 2 19:04:02 2008
@@ -3,8 +3,9 @@
------
Pete Marvin King
------
- 19 June 2006
-
+ 2008-08-03
+ ------
+
~~ 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
@@ -27,7 +28,7 @@
Adding and Filtering External Web Resources
- The default resource directory for all maven2 projects is
<<<src/main/resources>>> which
+ 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
structure will be preserved in the process.
@@ -38,7 +39,7 @@
+-------+
<project>
- [...]
+ ...
<build>
<plugins>
<plugin>
@@ -52,16 +53,16 @@
<directory>resource2</directory>
</resource>
</webResources>
- </configuration>
- </plugin>
+ </configuration>
+ </plugin>
</plugins>
</build>
- [...]
+ ...
</project>
+-------+
- Using our sample project in the usage section with an added external resource
-
+ Using our sample project in the {{{../usage.html}usage section}} with an
added external resource, like this:
+
+----------+
.
|-- pom.xml
@@ -88,10 +89,10 @@
`-- websource.jsp
+----------+
- would end up in the war as
-
+ would end up in the war as:
+
+----------+
-documentedproject-1.0-SNAPSHOT.war
+documentedproject-1.0-SNAPSHOT.war
|-- META-INF
| |-- MANIFEST.MF
| `-- maven
@@ -115,47 +116,47 @@
`-- jsp
`-- websource.jsp
+----------+
-
+
<<<external-resource2.jpg>>> and <<<image2>>> are copied to the root of the
war, preserving the
directory structure.
-
+
*Configuring webResources
-
- <<<webResources>>> is a list of resources. All options of resource is
supported.
-
+
+ <<<webResources>>> is a list of resources. All options of resource are
supported.
+
A web resource
-
- * can have inclusion/exclusion
-
- * can be filtered
-
- * is not limited to the default destination - the root of the war.
-
-**Inclusion/Exclusion for webResources
- Using our pom configuration above we can add
-
-+----------+
- [..]
+ * can have includes/excludes
+
+ * can be filtered
+
+ * 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:
+
++----------+
+ ...
<configuration>
- <webResources>
+ <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>
+ <include>**/*.jpg</include>
+ <includes>
</resource>
</webResources>
- </configuration
- [...]
-+----------+
-
- to include all jpgs to the war or
-
-+----------+
- [..]
+ </configuration>
+ ...
++----------+
+
+ To exclude the <<<image2>>> directory from the the war add this:
+
++----------+
+ ...
<configuration>
<webResources>
<resource>
@@ -163,62 +164,68 @@
<directory>resource2</directory>
<!-- there's no default value for this -->
<excludes>
- <exclude>**/image2</exclude>
+ <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:
+
++----------+
+ ...
+ <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>
- [...]
-+----------+
-
- to exclude the image2 directory from the the war. Be careful when mixing
include and exclude,
- exclude will have a higher priority. Include can not override exclude if a
resource matches
- both.
-
- Having this 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>
- [...]
-+----------+
-
- will exclude all jpgs from the war. Another example of how to specify
include and exclude patterns :
-
-+----------+
- [...]
- <!-- 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>
- [...]
-+----------+
-
-**Filtering webResources
+ </configuration>
+ ...
++----------+
+
+**Filtering
Using our example above, we can also configure filters for our resources.
- We will add a hypothetical configurations directory on our project
-
+ We will add a hypothetical <<<configurations>>> directory to our project:
+
+----------+
.
|-- configurations
@@ -246,61 +253,59 @@
| `-- web.xml
|-- index.jsp
`-- jsp
- `-- websource.jsp
-+----------+
+ `-- websource.jsp
++----------+
-***with the following in our pom.xml :
-
- To prevent corrupting your binaries files where filtering is enabled, you
can configure a list of file extensions to not filtering.
-
-+----------+
- [...]
- <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>
- <nonFilteredFileExtension>pdf</nonFilteredFileExtensions>
- <!-- default value contains jpg,jpeg,gif,bmp,png -->
- </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>
+ To prevent corrupting your binary files where filtering is enabled, you can
configure a list of file extensions to not filter.
+
++----------+
+ ...
+ <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>
- [...]
-+----------+
-
-***with <<<config.prop>>>
-
-+----------+
- interpolated_property=some_config_value
-+----------+
+ </excludes>
+ </resource>
+ </webResources>
+ </configuration>
+ ...
++----------+
-***with <<<configuration.cfg>>>
-
-+----------+
+*** <<<config.prop>>>
+
++----------+
+interpolated_property=some_config_value
++----------+
+
+*** <<<config.cfg>>>
+
++----------+
<another_ioc_container>
<configuration>${interpolated_property}</configuration>
-</another_ioc_container>
-+----------+
+</another_ioc_container>
++----------+
- the resulting war would be
-
-+----------+
+ The resulting war would be:
+
++----------+
documentedproject-1.0-SNAPSHOT.war
|-- META-INF
| |-- MANIFEST.MF
@@ -324,10 +329,10 @@
| `-- external-resource2.jpg
|-- index.jsp
`-- jsp
- `-- websource.jsp
-+----------+
+ `-- websource.jsp
++----------+
- with <<<config.cfg>>> content of
+ and the content of <<<config.cfg>>> would be:
+----------+
<another_ioc_container>
@@ -335,36 +340,36 @@
</another_ioc_container>
+----------+
-**Overriding the default destination directory of a web resource
+**Overriding the default destination directory
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>
- <directory>configurations</directory>
- <!-- override the destination directory for this resource -->
- <targetPath>WEB-INF</targetPath>
- <!-- enable filtering -->
- <filtering>true</filtering>
- <excludes>
+
++----------+
+ ...
+ <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>
- </resource>
- </webResources>
- </configuration>
- [...]
-+----------+
+ </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
|-- META-INF
| |-- MANIFEST.MF
@@ -389,13 +394,4 @@
|-- index.jsp
`-- jsp
`-- websource.jsp
-+----------+
-
-
-
-
-
-
-
-
-
++----------+
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=682092&r1=682091&r2=682092&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
Sat Aug 2 19:04:02 2008
@@ -1,9 +1,9 @@
------
- Using the file name mapping
+ Using File Name Mapping
------
Stephane Nicoll
------
- 31 Jan 2008
+ 2008-08-03
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -25,15 +25,27 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Using the file name mapping
+Using File Name Mapping
It might be necessary to customize the file name of libraries and TLD. By
default, those resources are stored
- using the following pattern: <<<@[EMAIL PROTECTED]@[EMAIL
PROTECTED]@\{extension\}@>>> (if the artifact has
- a classifier it is <<<@[EMAIL PROTECTED]@[EMAIL PROTECTED]@[EMAIL
PROTECTED]@\{extension\}@>>> of course).
+ using the following pattern:
+
++-----
[EMAIL PROTECTED]@[EMAIL PROTECTED]@[EMAIL PROTECTED]@
++-----
+
+ If the artifact has a classifier it is of course:
+
++-----
[EMAIL PROTECTED]@[EMAIL PROTECTED]@[EMAIL PROTECTED]@[EMAIL PROTECTED]@
++-----
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
ArtifactHandler as a token.
- For instance, to store the libraries and TLDs with no versionning, use the
following pattern:
- <<<@[EMAIL PROTECTED]@\{extension\}@>>>.
+ For instance, to store the libraries and TLDs with no versioning, use the
following pattern:
+
++-----
[EMAIL PROTECTED]@[EMAIL PROTECTED]@
++-----
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=682092&r1=682091&r2=682092&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
Sat Aug 2 19:04:02 2008
@@ -1,10 +1,11 @@
------
- Rapid Testing Using the Jetty6 Plugin
+ Rapid Testing Using the Jetty Plugin
------
Pete Marvin King
------
- 19 June 2006
-
+ 2008-08-03
+ ------
+
~~ 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
@@ -26,48 +27,48 @@
~~ http://maven.apache.org/doxia/references/apt-format.html
Rapid Testing Using the Jetty Plugin
-
+
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
+ 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
any changes in your java sources and <<<src/main/webapp>>> for your web
sources.
- The jetty6 plugin will automatically reload the modified classes and web
sources.
-
- To use the jetty plugin just add the following in your <<<pom.xml>>>:
-
-+-----------------+
+ 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>>>:
+
++-----------------+
<project>
- [...]
+ ...
<build>
<plugins>
<plugin>
- <groupId>org.mortbay.jetty</groupId>
- <artifactId>maven-jetty-plugin</artifactId>
- <configuration>
- <scanIntervalSeconds>10</scanIntervalSeconds>
- <connectors>
- <connector
implementation="org.mortbay.jetty.nio.SelectChannelConnector">
- <port>8080</port>
- <maxIdleTime>60000</maxIdleTime>
- </connector>
- </connectors>
- </configuration>
+ <groupId>org.mortbay.jetty</groupId>
+ <artifactId>maven-jetty-plugin</artifactId>
+ <configuration>
+ <scanIntervalSeconds>10</scanIntervalSeconds>
+ <connectors>
+ <connector
implementation="org.mortbay.jetty.nio.SelectChannelConnector">
+ <port>8080</port>
+ <maxIdleTime>60000</maxIdleTime>
+ </connector>
+ </connectors>
+ </configuration>
</plugin>
- [...]
- </plugins>
+ ...
+ </plugins>
</build>
- [...]
+ ...
</project>
-+-----------------+
++-----------------+
- then start Jetty:
+ Then start Jetty:
-+-----------------+
++-----------------+
mvn jetty:run
-+-----------------+
++-----------------+
The command will block with Jetty listening on port 8080.
-
- Check the {{{http://jetty.mortbay.org/maven-plugin/index.html}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=682092&r1=682091&r2=682092&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
Sat Aug 2 19:04:02 2008
@@ -3,8 +3,9 @@
------
Mike Perham
------
- July 2006
-
+ 2008-08-03
+ ------
+
~~ 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
@@ -26,7 +27,7 @@
~~ http://maven.apache.org/doxia/references/apt-format.html
Creating Skinny WARs
-
+
In a typical J2EE environment, a WAR is packaged within an EAR for
deployment. The
WAR can contain all its dependent JARs in <<<WEB-INF/lib>>> but then the EAR
can quickly grow
very large if there are multiple WARs, due to the presence of duplicate JARs.
Instead
@@ -36,84 +37,88 @@
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's <<<pom.xml>>>:
-
-+-----------------+
+ instead. This goes into your WAR project's <<<pom.xml>>>:
+
++-----------------+
<project>
- [...]
+ ...
<build>
<plugins>
<plugin>
- <artifactId>maven-war-plugin</artifactId>
- <configuration>
- <!-- In version 2.x, this was incorrectly named warSourceExcludes
-->
- <packagingExcludes>WEB-INF/lib/*.jar</packagingExcludes>
- <archive>
- <manifest>
- <addClasspath>true</addClasspath>
- <classpathPrefix>lib/</classpathPrefix>
- </manifest>
- </archive>
- </configuration>
+ <artifactId>maven-war-plugin</artifactId>
+ <configuration>
+ <!-- In version 2.x, this was incorrectly named warSourceExcludes -->
+ <packagingExcludes>WEB-INF/lib/*.jar</packagingExcludes>
+ <archive>
+ <manifest>
+ <addClasspath>true</addClasspath>
+ <classpathPrefix>lib/</classpathPrefix>
+ </manifest>
+ </archive>
+ </configuration>
</plugin>
- </plugins>
+ </plugins>
</build>
- [...]
+ ...
</project>
-+-----------------+
++-----------------+
- Next we need to change the EAR's <<<pom.xml>>> to package those dependent
JARs in the EAR.
- Notice that we package everything into a lib/ directory within the EAR. This
is
+ Next we need to change the EAR project's <<<pom.xml>>> to package those
dependent JARs in the EAR.
+ Notice that we package everything into a <<<lib/>>> directory within the EAR.
This is
just my own personal preference to distinguish between J2EE modules (which
will
- be packaged in the root of the EAR) and Java libraries (which are packaged in
lib/).
+ be packaged in the root of the EAR) and Java libraries (which are packaged in
<<<lib/>>>).
-+-----------------+
++-----------------+
+ ...
<build>
<plugins>
<plugin>
<artifactId>maven-ear-plugin</artifactId>
<configuration>
<defaultJavaBundleDir>lib/</defaultJavaBundleDir>
- </configuration>
+ </configuration>
</plugin>
- </plugins>
+ </plugins>
</build>
-+-----------------+
+ ...
++-----------------+
- Now the painful part. Your EAR's <<<pom.xml>>> needs to list every
dependency that the WAR has.
+ Now the painful part. Your EAR project's <<<pom.xml>>> needs to list every
dependency that the WAR has.
This is because Maven assumes fat WARs and does not include transitive
dependencies
of WARs within the EAR.
-+-----------------+
- <dependencies>
- <dependency>
- <groupId>com.acme</groupId>
- <artifactId>shared-jar</artifactId>
- <version>1.0.0</version>
- </dependency>
- <dependency>
- <groupId>com.acme</groupId>
- <artifactId>war1</artifactId>
- <version>1.0.0</version>
- <type>war</type>
- </dependency>
- <dependency>
- <groupId>com.acme</groupId>
- <artifactId>war2</artifactId>
- <version>1.0.0</version>
- <type>war</type>
- </dependency>
- </dependencies>
-+-----------------+
++-----------------+
+ ....
+ <dependencies>
+ <dependency>
+ <groupId>com.acme</groupId>
+ <artifactId>shared-jar</artifactId>
+ <version>1.0.0</version>
+ </dependency>
+ <dependency>
+ <groupId>com.acme</groupId>
+ <artifactId>war1</artifactId>
+ <version>1.0.0</version>
+ <type>war</type>
+ </dependency>
+ <dependency>
+ <groupId>com.acme</groupId>
+ <artifactId>war2</artifactId>
+ <version>1.0.0</version>
+ <type>war</type>
+ </dependency>
+ </dependencies>
+ ...
++-----------------+
Your EAR will contain something like this:
-+-----------------+
++-----------------+
.
|-- META-INF
- | |-- application.xml
+ | `-- application.xml
|-- lib
- | |-- shared-jar-1.0.0.jar
+ | `-- shared-jar-1.0.0.jar
|-- war1-1.0.0.war
- |-- war2-1.0.0.war
-+-----------------+
+ `-- war2-1.0.0.war
++-----------------+
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=682092&r1=682091&r2=682092&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
Sat Aug 2 19:04:02 2008
@@ -3,8 +3,9 @@
------
Pete Marvin King
------
- 19 June 2006
-
+ 2008-08-03
+ ------
+
~~ 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
@@ -27,11 +28,13 @@
War Manifest Customization
- The manifest can be customized by configuring the war plugin's archiver.
-
+ 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}}.
+
+--------------------+
<project>
- [...]
+ ...
<build>
<plugins>
<plugin>
@@ -46,36 +49,33 @@
</archive>
</configuration>
</plugin>
- [...]
+ ...
</plugins>
</build>
- [...]
+ ...
</project>
-+--------------------+
-
++--------------------+
+
The <<<pom.xml>>> would generate this <<<META-INF/MANIFEST.MF>>> in your war.
-
-+--------------------+
+
++--------------------+
Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
-Built-By: <current_user>
-Build-Jdk: <jdk version>
-Extension-Name: <artifactId>
-Specification-Vendor: MyCompany Inc
-Implementation-Vendor: MyCompany Inc
-Implementation-Title: <artifactId>
-Implementation-Version: <version>
+Built-By: ${user.name}
+Build-Jdk: ${java.version}
manifest_entry: value
+--------------------+
-Generating a manifest classpath
+*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>>>. Customize the war plugin's
+ archiver:
+--------------------+
<project>
- [...]
+ ...
<build>
<plugins>
<plugin>
@@ -90,18 +90,20 @@
</archive>
</configuration>
</plugin>
- [...]
+ ...
</plugins>
</build>
- [...]
+ ...
</project>
+--------------------+
- 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.
+ 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.
+--------------------+
<project>
- [...]
+ ...
<dependencies>
<dependency>
<groupId>org.foo</groupId>
@@ -118,17 +120,16 @@
</dependency>
<dependency>
<groupId>org.foo</groupId>
- <artifactId>bar-jar1</artifactId>
+ <artifactId>bar-jar3</artifactId>
<version>${pom.version}</version>
<scope>provided</scope>
<!-- excluded from manifest classpath, and excluded from WEB-INF/lib -->
</dependency>
- [...]
+ ...
</dependencies>
- [...]
+ ...
</project>
+--------------------+
-
-
- Check the {{{http://maven.apache.org/guides/mini/guide-manifest.html}Guide
to manifest customization}} for more examples.
+ Check the {{{http://maven.apache.org/guides/mini/guide-manifest.html}Guide
to manifest customization}} for more
+ examples.
Modified: maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt?rev=682092&r1=682091&r2=682092&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt Sat Aug 2
19:04:02 2008
@@ -3,7 +3,7 @@
------
Pete Marvin King
------
- 27 June 2006
+ 2008-08-03
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -33,10 +33,10 @@
* Goals Overview
- * {{{war-mojo.html}war:war}} is the default goal invoked during the package
phase for projects with a package type of war.
+ * {{{war-mojo.html}war:war}} is the default goal invoked during the package
phase for projects with a package type of <<<war>>>.
* {{{exploded-mojo.html}war:exploded}} is generally used to speed up testing
during the developement phase by creating
- an exploded war in a specified directory.
+ an exploded war in a specified directory.
* {{{inplace-mojo.html}war:inplace}} another variation of the war:explode
where the war is instead generated in the web source directory
which is <<<src/main/webapp>>> by default.
@@ -44,7 +44,7 @@
* Usage
Instructions on how to use the Maven WAR Plugin can be found
{{{usage.html}here}}. Specific documentation
- regarding overlays can be found {{{overlays.html}here}}
+ regarding overlays can be found {{{overlays.html}here}}.
* Examples
@@ -59,6 +59,8 @@
* {{{examples/skinny-wars.html}Creating Skinny WARs}}
+ * {{{examples/file-name-mapping.html}Using File Name Mapping}}
+
* Related links
*
{{{http://maven.apache.org/guides/mini/guide-archive-configuration.html}Exclusion
of Maven Descriptors}}
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=682092&r1=682091&r2=682092&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 Sat Aug 2
19:04:02 2008
@@ -4,7 +4,7 @@
Pete Marvin King
Stephane Nicoll
------
- 12 Augustus 2007
+ 2008-08-03
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -37,7 +37,7 @@
* Overlays at a glance
- To demonstrate, given a project structure
+ To demonstrate, given this project structure:
+-----------------+
.
@@ -61,7 +61,7 @@
`-- websource.jsp
+-----------------+
- which depends on <<<documentedprojectdependency-1.0-SNAPSHOT.war>>>.
+ The project depends on <<<documentedprojectdependency-1.0-SNAPSHOT.war>>>:
+-----------------+
documentedprojectdependency-1.0-SNAPSHOT.war
@@ -78,30 +78,30 @@
| | | `-- example
| | | `-- projects
| | | `-- SampleActionDependency.class
- | | |-- images
- | | | `-- sampleimage-dependency.jpg
+ | | `-- images
+ | | `-- sampleimage-dependency.jpg
| `-- web.xml
- |-- index-dependency.jsp
+ `-- 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>>>:
+-----------------+
- [...]
- <dependencies>
- <dependency>
- <groupId>com.example.projects</groupId>
- <artifactId>documentedprojectdependency</artifactId>
- <version>1.0-SNAPSHOT</version>
- <type>war</type>
- <scope>runtime</scope>
- </dependency>
- [...]
- </dependencies>
- [...]
+ ...
+ <dependencies>
+ <dependency>
+ <groupId>com.example.projects</groupId>
+ <artifactId>documentedprojectdependency</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <type>war</type>
+ <scope>runtime</scope>
+ </dependency>
+ ...
+ </dependencies>
+ ...
+-----------------+
- the resulting war would end up like this
+ the resulting war would end up like this:
+-----------------+
@@ -122,14 +122,14 @@
| | | `-- projects
| | | |-- SampleAction.class
| | | `-- SampleActionDependency.class
- | | |-- images
- | | | |-- sampleimage-dependency.jpg
- | | | `-- sampleimage.jpg
+ | | `-- images
+ | | |-- sampleimage-dependency.jpg
+ | | `-- sampleimage.jpg
| `-- web.xml
|-- index-dependency.jsp
|-- index.jsp
- |-- jsp
- | `-- websource.jsp
+ `-- jsp
+ `-- websource.jsp
+-----------------+
* Overlay types
@@ -165,31 +165,35 @@
available for <<war>> overlays. 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 is <<<false>>>.
+
+ []
For instance, to exclude the <<<sampleimage-dependency.jpg>>> of our
<<<documentedprojectdependency>>> war overlay above:
+-----------------+
- [...]
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-war-plugin</artifactId>
- <configuration>
- <overlays>
- <overlay>
- <groupId>com.example.projects</groupId>
- <artifactId>documentedprojectdependency</artifactId>
- <excludes>
- <exclude>images/sampleimage-dependency.jpg</exclude>
- </excludes>
- </overlay>
- </overlays>
- </configuration>
- </plugin>
- </plugins>
- [...]
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-war-plugin</artifactId>
+ <configuration>
+ <overlays>
+ <overlay>
+ <groupId>com.example.projects</groupId>
+ <artifactId>documentedprojectdependency</artifactId>
+ <excludes>
+ <exclude>images/sampleimage-dependency.jpg</exclude>
+ </excludes>
+ </overlay>
+ </overlays>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+-----------------+
@@ -200,41 +204,43 @@
they are defined in the <<<overlays>>> configuration. If no configuration is
provided,
the order in which they are defined in the dependencies is used (warning:
this is not
deterministic, especially if you have overlays as transitive dependencies).
In case of
- a mixed situation (e.g. configured overlays and non)configured overlays),
non-configured
+ a mixed situation (e.g. configured overlays and non-configured overlays),
non-configured
overlays are added after configured overlays.
- By default, the source of the project (<<<a.k.a>>> the current build) is
added first (e.g.
+ By default, the source of the project (a.k.a the current build) is added
first (e.g.
before any overlay is applied). The current build is defined as a special
overlay
with no <<<groupId>>>, <<<artifactId>>>. If overlays need to be applied
first, simply
configure the current build after those overlays.
For instance, if <<<my-webapp>>> from the <<<com.example.projects>>> group
is a dependency
- of the project and needs to be applied before the projec's source, do as
follows:
+ of the project and needs to be applied before the project's source, do as
follows:
+-----------------+
- [...]
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-war-plugin</artifactId>
- <configuration>
- <overlays>
- <overlay>
- <groupId>com.example.projects</groupId>
- <artifactId>my-webapp</artifactId>
- </overlay>
- <overlay>
- <!-- empty groupId/artifactId detected as the current build -->
- </overlay>
- </overlays>
- </configuration>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-war-plugin</artifactId>
+ <configuration>
+ <overlays>
+ <overlay>
+ <groupId>com.example.projects</groupId>
+ <artifactId>my-webapp</artifactId>
+ </overlay>
+ <overlay>
+ <!-- empty groupId/artifactId detected as the current build -->
+ </overlay>
+ </overlays>
+ </configuration>
</plugin>
- </plugins>
- [...]
+ </plugins>
+ </build>
+ ...
+-----------------+
- Note that in the scenario above, any other overlay will be applied afther
the current build
+ 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.
To perform an even fine grained overwriting policy, overlays can be packaged
multiple times
@@ -243,13 +249,14 @@
regular way, define two overlays configuration for <<<my-webapp>>>:
+-----------------+
- [...]
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-war-plugin</artifactId>
- <configuration>
- <overlays>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-war-plugin</artifactId>
+ <configuration>
+ <overlays>
<overlay>
<id>my-webapp-index.jsp</id>
<groupId>com.example.projects</groupId>
@@ -263,16 +270,18 @@
</overlay>
<!-- Other overlays here if necessary -->
+
<overlay>
<id>my-webapp</id>
<groupId>com.example.projects</groupId>
<artifactId>my-webapp</artifactId>
</overlay>
</overlays>
- </configuration>
+ </configuration>
</plugin>
- </plugins>
- [...]
+ </plugins>
+ </build>
+ ...
+-----------------+
@@ -284,7 +293,7 @@
has no specific <<<includes>>> section inherit this settings by default.
+-----------------+
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -294,14 +303,14 @@
</configuration>
</plugin>
</plugins>
- [...]
+ ...
+-----------------+
* <<dependentWarExcludes>> - sets the default excludes to apply to all
overlays. Any overlay that
has no specific <<<excludes>>> section inherit this settings by default.
+-----------------+
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -311,14 +320,13 @@
</configuration>
</plugin>
</plugins>
- [...]
+ ...
+-----------------+
-
* <<workDirectory>> - sets the directory where overlays will be temporarily
extracted.
+-----------------+
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -329,13 +337,13 @@
</configuration>
</plugin>
</plugins>
- [...]
+ ...
+-----------------+
- * <<useCache>> - set to false to disable the webapp structure cache. Default
to true
+ * <<useCache>> - set to <<<false>>> to disable the webapp structure cache.
Defaults to <<<true>>>.
+-----------------+
- [...]
+ ...
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -345,22 +353,22 @@
</configuration>
</plugin>
</plugins>
- [...]
+ ...
+-----------------+
* Zip dependencies with overlays
- To use a <<zip>> dependency as an overlay you have to configure it
explicitely in the plugins's configuration. For
- instance to inject the content of a zip overlay in the <<scripts>> directory
of the webapp, do as follows:
+ To use a <<zip>> dependency as an overlay you have to configure it
explicitly in the plugin's configuration. For
+ instance to inject the content of a zip overlay in the <<<scripts>>>
directory of the webapp, do as follows:
+-----------------+
- [...]
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-war-plugin</artifactId>
- <configuration>
- <overlays>
+ ...
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-war-plugin</artifactId>
+ <configuration>
+ <overlays>
<overlay>
<groupId>zipGroupId</groupId>
<artifactId>zipArtifactId</artifactId>
@@ -368,8 +376,8 @@
<targetPath>scripts</targetPath>
</overlay>
</overlays>
- </configuration>
+ </configuration>
</plugin>
- </plugins>
- [...]
+ </plugins>
+ ...
+-----------------+
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=682092&r1=682091&r2=682092&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 Sat Aug 2
19:04:02 2008
@@ -3,7 +3,8 @@
------
Pete Marvin King
------
- 27 June 2006
+ 2008-08-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -27,40 +28,40 @@
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
+ * using the <<<package>>> phase with the project package type as <<<war>>>
- *invocation of the <<<war:war>>> goal.
+ * invocation of the <<<war:war>>> goal
- *invocation of the <<<war:exploded>>> goal
+ * invocation of the <<<war:exploded>>> goal
- *invocation of the <<<war:inplace>>> goal
+ * invocation of the <<<war:inplace>>> goal
[]
- <<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.>>
+ <<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.
-*Using the package phase with the project package type as war / invocation of
the <<<war:war>>> goal
+*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.
- To illustrate, given the <<<pom.xml>>>
+ To illustrate, here's the <<<pom.xml>>> for our project:
+----------+
<project>
- [...]
+ ...
<groupId>com.example.projects</groupId>
<artifactId>documentedproject</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<name>Documented Project</name>
<url>http://example.com</url>
- [...]
+ ...
</project>
+----------+
- with a project structure
+ The project's structure looks like this:
+----------+
.
@@ -84,19 +85,19 @@
`-- websource.jsp
+----------+
- and invoking
+ Invoking
+----------+
- mvn package
+mvn package
+----------+
or
+----------+
- mvn compile war:war
+mvn compile war:war
+----------+
- generates the war file <<<target/documentedproject-1.0-SNAPSHOT.war>>>.
+ will generate the war file <<<target/documentedproject-1.0-SNAPSHOT.war>>>.
Here are the contents of that war file:
+----------+
documentedproject-1.0-SNAPSHOT.war
@@ -119,44 +120,45 @@
|-- index.jsp
`-- jsp
`-- websource.jsp
-+----------+
++----------+
*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
use to generate the war in exploded
form.
- Using the same project above and invoking
+ Use the same project as above and invoke:
+----------+
- mvn compile war:exploded
+mvn compile war:exploded
+----------+
- would 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
- |-- WEB-INF
- | |-- classes
- | | |-- com
- | | | `-- example
- | | | `-- projects
- | | | `-- SampleAction.class
- | | `-- images
- | | `-- sampleimage.jpg
- | `-- web.xml
- |-- index.jsp
- `-- jsp
- `-- websource.jsp
-+----------+
+ documentedproject-1.0-SNAPSHOT
+ |-- META-INF
+ |-- WEB-INF
+ | |-- classes
+ | | |-- com
+ | | | `-- example
+ | | | `-- projects
+ | | | `-- SampleAction.class
+ | | `-- images
+ | | `-- sampleimage.jpg
+ | `-- web.xml
+ |-- index.jsp
+ `-- jsp
+ `-- websource.jsp
++----------+
- The default directory for the exploded war is <<<target/\<finalName\>>>>. The
finalName is usually in the form
- of \<artifact\>-\<version\>.
- This default directory can be overridden by specifying the webappDirectory
plugin parameter.
+ 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.
+-------+
<project>
- [...]
+ ...
<build>
<plugins>
<plugin>
@@ -164,26 +166,26 @@
<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>
</build>
- [...]
+ ...
</project>
-+-------+
++-------+
*Invocation of <<<war:inplace>>> goal
- Another variation of the <<<war:exploded>>> is the <<<war:inplace>>>. In
<<<war:inplace>>> the exploded war is created
- in the webapp source which defaults to <<<src/main/webapp>>>.
- Using our sample project above, invoking
+ 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:exploded
+mvn compile war:inplace
+----------+
- would result to
+ This will result to:
+----------+
.
@@ -192,7 +194,7 @@
| `-- main
| |-- java
| | `-- com
- | | `-- ideal
+ | | `-- example
| | `-- projects
| | `-- SampleAction.java
| |-- resources
@@ -204,7 +206,7 @@
| |-- WEB-INF
| | |-- classes
| | | |-- com
- | | | | `-- ideal
+ | | | | `-- example
| | | | `-- projects
| | | | `-- SampleAction.class
| | | `-- images
@@ -216,12 +218,9 @@
`-- target
`-- classes
|-- com
- | `-- ideal
+ | `-- example
| `-- projects
| `-- SampleAction.class
`-- images
`-- sampleimage.jpg
-+----------+
-
-
-
++----------+
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=682092&r1=682091&r2=682092&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 Sat Aug 2
19:04:02 2008
@@ -24,20 +24,18 @@
<faq id="filtering">
<question>How is filtering done in the war plugin?</question>
<answer>
- <p>To enable filtering of web.xml you must configure the war plugin as
this :
- <source>
-<![CDATA[
- <plugin>
- <artifactId>maven-war-plugin</artifactId>
- <version>2.1-alpha-2</version>
- <configuration>
- <filteringDeploymentDescriptors>true</filteringDeploymentDescriptors>
- </configuration>
- </plugin>
-]]>
- </source>
+ <p>To enable filtering of <code>web.xml</code> you must configure the
war plugin as this:
+ <source><![CDATA[
+ <plugin>
+ <artifactId>maven-war-plugin</artifactId>
+ <version>2.1-alpha-2</version>
+ <configuration>
+ <filteringDeploymentDescriptors>true</filteringDeploymentDescriptors>
+ </configuration>
+ </plugin>
+]]></source>
</p>
- <p>Examples can be found <a
href="examples/adding-filtering-webresources.html">here</a></p>
+ <p>Examples can be found <a
href="examples/adding-filtering-webresources.html">here</a>.</p>
</answer>
</faq>
<faq id="classifieruse">
@@ -54,54 +52,56 @@
</answer>
</faq>
<faq id="dependentwarexclude">
- <question>What's the difference in using dependentWarExclude and provided
scope?</question>
+ <question>What's the difference between using dependentWarExclude and
provided scope?</question>
<answer>
- <p>dependentWarExclude is used in <a
href="examples/war-overlay.html">war overlays</a> for excluding dependent
+ <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>
</answer>
</faq>
<faq id="webresourcesexclude">
- <question>How do I exclude files in my web rources?</question>
+ <question>How do I exclude files in my web resources?</question>
<answer>
- <p>Use the webResources exclude 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 use for the filtering.</p>
</answer>
</faq>
<faq id="waroverlaysexclude">
<question>How do I exclude files when doing war overlays?</question>
<answer>
- <p>Use the dependentWarExcludes parameter to identify the tokens to use
for the filtering.</p>
+ <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>
+ External Web Resources</a>.</p>
</answer>
</faq>
<faq id="configurationdoc">
<question>Where can I find the documentation for the plugin's
configuration?</question>
<answer>
<p>
- For each goal, you can use the documentation from the <a
href="http://maven.apache.org/plugins/maven-war-plugin/plugin-info.html";>plugin
site</a>.
+ For each goal, you can use the documentation from the <a
href="plugin-info.html">plugin site</a>.
</p>
<p>
- If you need a specific version, generate it using site:site or use
mvn help:describe \\ <br/>
- -DgroupId=org.apache.maven.plugins -DartifactId=maven-war-plugin
-Dfull=true \\ <br/>
- -Dversion>your-plugin-version-here<
+ 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>
+]]></source>
</p>
</answer>
</faq>
<faq id="attached">
<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 WEB-INF/lib
- rather than as loose files under WEB-INF/classes, use the following
configuration:</p>
+ <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>
- <plugin>
- <artifactId>maven-war-plugin</artifactId>
- <version>X.Y</version>
- <configuration>
- <archiveClasses>true</archiveClasses>
- </configuration>
- </plugin>
- </source>
+ <source><![CDATA[
+ <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
@@ -109,25 +109,29 @@
<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>
<p>
- <source>
- <project>
- ...
- <artifactId>mywebapp</artifactId>
- <version>1.0-SNAPSHOT</version>
- ...
- <plugin>
- <artifactId>maven-war-plugin</artifactId>
- <version>X.Y</version>
- <configuration>
- <attachClasses>true</attachClasses>
- </configuration>
- </plugin>
- ...
- </project>
- </source>
+ <source><![CDATA[
+<project>
+ ...
+ <artifactId>mywebapp</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <artifactId>maven-war-plugin</artifactId>
+ <version>X.Y</version>
+ <configuration>
+ <attachClasses>true</attachClasses>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ ...
+</project>
+]]></source>
</p>
- <p>This will result in two artifacts being deployed:
mywebapp-1.0-SNAPSHOT.war
- and mywebapp-1.0-SNAPSHOT-classes.jar</p>
+ <p>This will result in two artifacts being deployed:
<code>mywebapp-1.0-SNAPSHOT.war</code>
+ and <code>mywebapp-1.0-SNAPSHOT-classes.jar</code>.</p>
</answer>
</faq>
</part>
Modified: maven/plugins/trunk/maven-war-plugin/src/site/site.xml
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/site.xml?rev=682092&r1=682091&r2=682092&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/site.xml Sat Aug 2 19:04:02
2008
@@ -33,9 +33,9 @@
<menu name="Examples">
<item name="Adding and Filtering External Web Resources"
href="examples/adding-filtering-webresources.html"/>
<item name="War Manifest Customization"
href="examples/war-manifest-guide.html"/>
- <item name="Rapid Testing Using Jetty6"
href="examples/rapid-testing-jetty6-plugin.html"/>
+ <item name="Rapid Testing Using the Jetty Plugin"
href="examples/rapid-testing-jetty6-plugin.html"/>
<item name="Creating Skinny WARs" href="examples/skinny-wars.html"/>
- <item name="Using the file name mapping"
href="examples/file-name-mapping.html"/>
+ <item name="Using File Name Mapping"
href="examples/file-name-mapping.html"/>
</menu>
</body>
</project>
