MNG-853: added howto and web site doco for war plugin.

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@291188 13f79535-47bb-0310-9956-ffa450edef68
2005-09-23 18:43:46 +00:00 · 2005-09-23 18:43:46 +00:00 · 47426c6648
parent 3dbec22bcd
commit 47426c6648
3 changed files with 92 additions and 0 deletions
--- a/maven-plugins/maven-war-plugin/src/site/apt/howto.apt
+++ b/maven-plugins/maven-war-plugin/src/site/apt/howto.apt
@ -0,0 +1,35 @@
+ ------
+ Maven 2 War Plugin: configuration examples
+ ------
+ Stephane Nicoll
+ <snicoll@apache.org>
+ ------
+ September 23, 2005
+
+Introduction
+
+  The War plugin allows to package the web application in different mode:
+
+   * war (default): generates the war artifact
+
+   * inplace: package the web application in the source tree
+
+   * exploded (<<deprecated>>): package an exploded web application
+
+  The packaging's mode is to be set in the plugin's configuration. For instance,
+  to use the <inplace> mode configure your project as follows:
+
+--------
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-war-plugin</artifactId>
+        <configuration>
+           <mode>inplace</mode>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+---------
+
--- a/maven-plugins/maven-war-plugin/src/site/apt/introduction.apt
+++ b/maven-plugins/maven-war-plugin/src/site/apt/introduction.apt
@ -0,0 +1,16 @@
+ ------
+ Maven 2 Ear Plugin
+ ------
+ Stephane Nicoll
+ <snicoll@apache.org>
+ ------
+ September 23, 2005
+
+Introduction
+
+  This plugin generates Web application archive (WAR) file.
+
+  The full description of goals is available {{{index.html}here}}.
+
+
+
--- a/maven-plugins/maven-war-plugin/src/site/site.xml
+++ b/maven-plugins/maven-war-plugin/src/site/site.xml
@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+/*
+ * Copyright 2001-2005 The Apache Software Foundation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+-->
+
+<project name="Maven War Plugin">
+  <bannerLeft>
+    <name>Maven War Plugin</name>
+    <src>http://maven.apache.org/images/apache-maven-project.png</src>
+    <href>http://maven.apache.org/</href>
+  </bannerLeft>
+  <bannerRight>
+    <src>http://maven.apache.org/images/maven-small.gif</src>
+  </bannerRight>
+  <body>
+    <links>
+      <item name="Maven 2" href="http://maven.apache.org/maven2/"/>
+    </links>
+
+    <menu name="Overview">
+      <item name="Introduction" href="introduction.html"/>
+      <item name="How to Use" href="howto.html"/>
+    </menu>
+    ${reports}
+  </body>
+</project>