Author: brett
Date: Mon Jul 10 23:46:58 2006
New Revision: 420742
URL: http://svn.apache.org/viewvc?rev=420742&view=rev
Log:
[MWAR-48] finish war plugin documentation
Submitted by: Pete Marvin King
Added:
maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt (with props)
Modified:
maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt
maven/plugins/trunk/maven-war-plugin/src/site/apt/usage.apt
maven/plugins/trunk/maven-war-plugin/src/site/site.xml
Modified:
maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt
URL:
http://svn.apache.org/viewvc/maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt?rev=420742&r1=420741&r2=420742&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt
(original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/examples/war-overlay.apt
Mon Jul 10 23:46:58 2006
@@ -11,8 +11,6 @@
for war artifacts. Instead, war artifacts are overlayed on the war source.
No configurations is necessary.
- <<Warning : Overlayed war files will overwrite the files in your war.>>
-
To demonstrate, given a project structure
+-----------------+
Added: 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=420742&view=auto
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt (added)
+++ maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt Mon Jul 10
23:46:58 2006
@@ -0,0 +1,36 @@
+ ------
+ Maven 2 War Plugin - Basic usage
+ ------
+ Pete Marvin King
+ ------
+ 27 June 2006
+
+Overview
+
+ The war plugin is responsible for collecting all artifact dependencies,
classes
+ and resources of the web application and packaging them into a web
application archive.
+
+Supported goals
+
+ {{{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 on specified directory.
+
+ {{{inplace-mojo.html}war:inplace}} another variation of the war:explode the
war is instead generated in the web source directory
+ which is <<<src/main/webapp>>> by default.
+
+ See {{{usage.html}usage section}} for the basic usage.
+
+Example configurations :
+
+ *{{{examples/adding-filtering-webresources.html}Adding and/or filtering
webResources}}
+
+ *{{{examples/war-overlay.html}War overlays}}
+
+ *{{{examples/war-manifest-guide.html}Managing your war manifest}}
+
+Related links
+
+
{{{http://maven.apache.org/guides/mini/guide-archive-configuration.html}Exclusion
of Maven Descriptors}}
+
\ No newline at end of file
Propchange: maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/plugins/trunk/maven-war-plugin/src/site/apt/index.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
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=420742&r1=420741&r2=420742&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 Jul 10
23:46:58 2006
@@ -22,7 +22,7 @@
*Using the package phase with the project package type as war / invocation of
the <<<war:war>>> goal
- This is the common way to use the war plugin.
+ This is the common way of using the war plugin.
To illustrate, given the <<<pom.xml>>>
+----------+
@@ -106,7 +106,7 @@
Using the same project above and invoking
+----------+
- mvn compile mvn:exploded
+ mvn compile war:exploded
+----------+
would generate an exploded version of the war in
<<<target/documentedproject-1.0-SNAPSHOT>>>
@@ -154,7 +154,7 @@
Using our sample project above, invoking
+----------+
- mvn compile mvn:exploded
+ mvn compile war:exploded
+----------+
would result to
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=420742&r1=420741&r2=420742&view=diff
==============================================================================
--- maven/plugins/trunk/maven-war-plugin/src/site/site.xml (original)
+++ maven/plugins/trunk/maven-war-plugin/src/site/site.xml Mon Jul 10 23:46:58
2006
@@ -32,7 +32,8 @@
<item name="Maven 2" href="http://maven.apache.org/maven2/"/>
</links>
<menu name="Overview">
- <item name="Introduction" href="overview.html"/>
+ <item name="Introduction" href="index.html"/>
+ <item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
<!--<item name="FAQ" href="faq.html"/> -->
</menu>
