documentation improvement

git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@114983 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
brett 2004-04-08 00:22:27 +00:00
parent fc49fb8f91
commit 7d1bf06e08
3 changed files with 40 additions and 42 deletions

View File

@ -30,6 +30,46 @@
This plug-in provides the ability to generate either a deployed webapp This plug-in provides the ability to generate either a deployed webapp
or a webapp packaged as a WAR file. or a webapp packaged as a WAR file.
</p> </p>
<subsection name="Bundling dependencies">
<p>
If you need to add extra dependencies in the web application, there are two
properties you can use.</p>
<table>
<tr><td><code>war.bundle</code></td><td>This property includes the dependency in
<code>/WEB-INF/lib</code></td></tr>
<tr><td><code>war.target.path</code></td><td>This bundles the dependency in the path
specified relative to the base of the web application.</td></tr>
</table>
<p>For example, the following adds commons-lang to <code>/WEB-INF/lib</code> and
myApplet to the <code>/applets</code> directory.
</p>
<source><![CDATA[
<dependency>
<id>commons-lang</id>
<version>2.0</version>
<properties>
<war.bundle>true</war.bundle>
</properties>
</dependency>
<dependency>
<id>myApplet</id>
<version>1.4</version>
<properties>
<war.target.path>applets</war.target.path>
</properties>
</dependency>]]></source>
</subsection>
<subsection name="Filtering web.xml">
<p>
If you need to copy the web.xml file in order to replace some
filter tokens or simply perform some custom modification to it,
simply write a pre-goal to the <code>war:war</code> goal in which
you perform the manipulation. Then set the
<code>maven.war.webxml</code> property to point to your modified
<code>web.xml</code>.
</p>
</subsection>
</section> </section>
</body> </body>
</document> </document>

View File

@ -28,7 +28,6 @@
<menu name="Overview"> <menu name="Overview">
<item name="Goals" href="/goals.html" /> <item name="Goals" href="/goals.html" />
<item name="Properties" href="/properties.html" /> <item name="Properties" href="/properties.html" />
<item name="Tips" href="/tips.html"/>
</menu> </menu>
</body> </body>
</project> </project>

View File

@ -1,41 +0,0 @@
<?xml version="1.0"?>
<!--
/*
* Copyright 2001-2004 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.
*/
-->
<document>
<properties>
<title>Maven War Plugin Tips</title>
<author email="vmassol@octo.com">Vincent Massol</author>
</properties>
<body>
<section name="Maven War Plugin Tips">
<section name="Filtering web.xml">
<p>
If you need to copy the web.xml file in order to replace some
filter tokens or simply perform some custom modification to it,
simply write a pre-goal to the <code>war:war</code> goal in which
you perform the manipulation. Then set the
<code>maven.war.webxml</code> property to point to your modified
<code>web.xml</code>.
</p>
</section>
</section>
</body>
</document>