<?xml version="1.0" encoding="ISO-8859-1"?>
<document>

  <properties>
    <title>War Properties</title>
    <author email="vmassol@octo.com">Vincent Massol</author>
  </properties>

  <body>
    <section name="War Settings">
      <table>
        <tr><th>Property</th><th>Optional?</th><th>Description</th></tr>
        <tr>
          <td>maven.war.src</td>
          <td>Yes</td>
          <td>
			Location of where the webapp is located in the source tree. Your
			<code>WEB-INF</code> directory must be located right under
			<code>${maven.war.src}</code>. It defaults to 
			<code>${maven.src.dir}/webapp</code>.
          </td>
        </tr>
        <tr>
          <td>maven.war.webxml</td>
          <td>Yes</td>
          <td>
			Location of the <code>web.xml</code> file. It defaults to
			<code>${maven.war.src}/WEB-INF/web.xml</code>.
	      </td>
        </tr>
        <tr>
          <td>maven.war.classes.includes</td>
          <td>Yes</td>
          <td>
			Classes to include from WEB-INF/classes
			Note: Classes are relative to 
			<code>${maven.build.dir}</code>.
          </td>
        </tr>
        <tr>
          <td>maven.war.classes.excludes</td>
          <td>Yes</td>
          <td>
			Classes to exclude from WEB-INF/classes
			Note: Classes are relative to 
			<code>${maven.build.dir}</code>.
          </td>
        </tr>
        <tr>
          <td>maven.war.final.name</td>
          <td>Yes</td>
          <td>
            <p>Name of the war file that is built.</p>
            <p>Defaults to <code>${pom.artifactId}.war</code></p>
            <p>
              Use <code>${pom.artifactId}-${pom.currentVersion}</code>
              to mimic the files created using the jar and ear plugins
            </p>
          </td>
        </tr>
        <tr>
          <td>maven.war.build.dir</td>
          <td>Yes</td>
          <td>
			Directory where the war will be generated. It defaults
			to <code>${maven.build.dir}</code>.
          </td>
        </tr>
        <tr>
          <td>maven.war.webapp.dir</td>
          <td>Yes</td>
          <td>
              Directory where the webapp will be generated. It defaults to
              <code>${maven.war.build.dir}/${pom.artifactId}</code>.
          </td>
        </tr>
        <tr>
          <a id="tld_dir"/>
          <td>maven.war.tld.dir</td>
          <td>Yes</td>
          <td>
             Subdirectory of web application context root directory 
             where tag library descriptors (tld files) will be copied. 
             Maven WAR Plugin copies to this location all dependencies 
             (specified in the POM) of the 
             type <code>"tld"</code> and marked with special meta-information.
             See the section below for more information.
             <br/>
             It defaults to
             <code>WEB-INF/tld</code>.
             This setting is adhering to
             <a href="http://developer.java.sun.com/developer/technicalArticles/javaserverpages/code_convention/"
             >SUN Code Conventions for the JavaServer Pages</a>
          </td>
        </tr>
      </table>
    </section>
    <section name="Including artifact in the Webapp">
	  <p>
	    You must tell Maven what artifact you want included in the Webapp. This
	    is achieved by specifying meta-information in the POM, using the
	    following syntax:
	  </p>

<source><![CDATA[
  <dependency>
    <groupId>grpId</groupId>
    <artifactId>jarid</artifactId>
    <version>jarversion</version>
    <type>jar</type>
    <properties>
      <war.bundle>true</war.bundle>
    </properties>
  </dependency>
  
  <dependency>
    <groupId>grpId</groupId>
    <artifactId>tldid</artifactId>
    <version>tldversion</version>
    <type>tld</type>
    <properties>
      <war.bundle>true</war.bundle>
    </properties>
  </dependency>
]]></source>
 
  <p>
    This process in type senstive.
    Currently following types are supported: 
    <ol>
       <li>jar</li>
       <li>tld (see: <a href="#tld_dir">maven.war.tld.dir</a>)</li>
    </ol>
  </p>
    </section>
  </body>
</document>
