maven-plugins/j2ee/xdocs/dirlayout.xml

65 lines
2.0 KiB
XML

<?xml version="1.0"?>
<document>
<properties>
<author email="dion@multitask.com.au">dIon Gillard</author>
<title>Maven J2EE Plug-in Directory Layout</title>
</properties>
<body>
<section name="Rationale">
<p>
Having a common directory layout would allow for users familiar
with one Maven project to immediately feel at home in another
Maven project. The advantages are analogous to adopting a
site-wide look-and-feel. Common Maven procedures strengthen the
Maven brand.
</p>
<p>
The next two sections document the directory layout expected by
Maven and the directory layout created by Maven. Please try to
conform to this structure as much as possible; however, if you
must these settings can be overridden via properties as
documented in the <a
href="http://maven.apache.org/start/integrate.html#Properties">Integration</a> document.
</p>
</section>
<section name="Common Directory Layout">
<table>
<tr>
<th>Directory or file name</th>
<th>Content</th>
<th>Comment</th>
</tr>
<tr>
<td>src/webapp</td>
<td>The base directory under which web applications can be found.</td>
<td>
This directory contains the web application to
be built. The web application name is passed to maven as the
property ${maven.j2ee.war.name}
</td>
</tr>
</table>
</section>
<section name="Maven-Generated Layout">
<table>
<tr>
<th>Directory name</th>
<th>Content</th>
<th>Comment</th>
</tr>
<tr>
<td>target/</td>
<td>Contains compiled WARs and EARs.</td>
<td>
This directory is used by the J2EE Plug-in as the destination of the
built war and ear files
</td>
</tr>
</table>
</section>
</body>
</document>