kaz 02/05/30 05:55:23 Modified: xdocs navigation.xml xdocs/ref navigation.xml xdocs/start integrate.xml navigation.xml Added: xdocs/plugins index.xml navigation.xml xdocs/plugins/j2ee build-file.xml dirlayout.xml futures.xml index.xml navigation.xml properties.xml xdocs/plugins/struts build-file.xml dirlayout.xml futures.xml index.xml navigation.xml properties.xml Removed: xdocs/ref/j2ee build-file.xml dirlayout.xml futures.xml index.xml navigation.xml properties.xml xdocs/ref/struts build-file.xml dirlayout.xml futures.xml index.xml navigation.xml properties.xml Log: Patch from Peter Lynch <[EMAIL PROTECTED]>. Basically moves the plugin stuff out of the Reference section into their own section, struts and j2ee have been moved here as well. Revision Changes Path 1.2 +1 -0 jakarta-turbine-maven/xdocs/navigation.xml Index: navigation.xml =================================================================== RCS file: /home/cvs/jakarta-turbine-maven/xdocs/navigation.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- navigation.xml 1 May 2002 22:03:11 -0000 1.1 +++ navigation.xml 30 May 2002 12:55:22 -0000 1.2 @@ -23,6 +23,7 @@ <item name="News and Status" href="/status.html"/> <item name="Getting Started" href="/start/index.html"/> <item name="Reference" href="/ref/index.html"/> + <item name="Plugins" href="/plugins/index.html"/> <item name="Powered By" href="/powered.html"/> </menu> </body> 1.1 jakarta-turbine-maven/xdocs/plugins/index.xml Index: index.xml =================================================================== <?xml version="1.0"?> <document> <properties> <title>Maven Plugins</title> <author email="[EMAIL PROTECTED]">Peter Lynch</author> </properties> <body> <section name="Plugin Reference"> <p> Here is the list of plugins we currently have documentation for. </p> <table> <tr><th>Name</th><th>Description</th></tr> <tr> <td><a href="./j2ee/index.html">J2EE</a></td> <td> Perform <a href="http://java.sun.com/j2ee/">J2EE</a> related build processes. </td> </tr> <tr> <td><a href="./struts/index.html">Struts</a></td> <td> Perform struts related build processes for <a href="http://jakarta.apache.org/struts/">Jakarta Struts</a> applications. </td> </tr> </table> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/navigation.xml Index: navigation.xml =================================================================== <?xml version="1.0" encoding="ISO-8859-1"?> <project name="Maven"> <title>Maven</title> <logo href="/images/maven.jpg">Maven</logo> <organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo> <body> <links> <item name="Turbine" href="http://jakarta.apache.org/turbine/"/> <item name="Turbine-2" href="http://jakarta.apache.org/turbine/turbine-2/"/> <item name="Turbine-3" href="http://jakarta.apache.org/turbine/turbine-3/"/> <item name="Torque" href="http://jakarta.apache.org/turbine/torque/"/> <item name="Fulcrum" href="http://jakarta.apache.org/turbine/fulcrum/"/> <item name="TDK" href="http://jakarta.apache.org/turbine/tdk/"/> <item name="Stratum" href="http://jakarta.apache.org/turbine/stratum/"/> <item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/> <item name="JCS" href="http://jakarta.apache.org/turbine/jcs/"/> </links> <menu name="Overview"> <item name="Goals" href="/goals.html"/> <item name="Features" href="/features.html"/> <item name="News and Status" href="/status.html"/> <item name="Getting Started" href="/start/index.html"/> <item name="Reference" href="/ref/index.html"/> <item name="Plugins" href="/plugins/index.html"> <item name="J2EE Plugin" href="/plugins/j2ee/index.html" /> <item name="Struts Plugin" href="/plugins/struts/index.html" /> </item> <item name="Powered By" href="/powered.html"/> </menu> </body> </project> 1.1 jakarta-turbine-maven/xdocs/plugins/j2ee/build-file.xml Index: build-file.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">dIon Gillard</author> <author email="[EMAIL PROTECTED]">Kevin O'Neill</author> <title>Maven J2EE Plug-in Build File Documentation</title> </properties> <body> <section name="Maven J2EE Plug-in Build File"> <p> Maven utilizes <a href="http://jakarta.apache.org/ant/">Ant</a> to provide users with an easy-to-use and familiar interface to manage projects that have been described with a valid Maven <a href="../project-descriptor.html">project descriptor</a>. The build files that Maven <a href="../../start/index.html"> installs</a> are stored in <code>${maven.home}</code> directory. </p> <p> This document describes the Ant build file and targets that are available when using the J2EE Plug-in with Maven. </p> <p> The current recommended approach to using Maven is to add delegators to these Maven-provided targets in your project's main build file. This will enable you to use your existing build file with the additional Maven functionality. In addition, it is also recommended that you load a standard set of property files. The property files will setup your environment, <code>${lib.repo}</code> and <code>${maven.home}</code>, and allow you to override Maven defaults properties. Please refer to the <a href="../../start/integrate.html">Integration</a> document for more information on how to integrate these build targets into your project. </p> <p> The following table contains a brief overview of the build file that is installed as part of the Maven J2EE Plug-in in the <code>${maven.home}/plugin/j2ee</code> directory. In addition, the various Ant targets in this file is discussed. </p> <table> <tr><th>Build File</th><th>Description</th></tr> <tr> <td><a href="#j2ee/build.xml">j2ee-build.xml</a></td> <td> Contains targets to create and validate J2EE <code>WAR</code> and <code>EAR</code> files. Creates <code>EJB</code> jar files. </td> </tr> </table> <p> The build file utilizes various properties for default and user-configurable settings. All J2EE Plug-in properties are described in the <a href="./properties.html">Properties</a> document. The rest of this document assumes your project follows the standard <a href="dirlayout.html">Directory Layout</a>; however, it is possible to override many of these defaults. </p> </section> <section name="j2ee/build.xml"> <table> <tr><th>Target</th><th>Description</th></tr> <tr> <td><a href="#maven:war">maven:war</a></td> <td>Creates a <code>WAR</code> file.</td> </tr> <tr> <td><a href="#maven:validate-war">maven:validate-war</a></td> <td>Validate a <code>WAR</code> file.</td> </tr> <tr> <td><a href="#maven:ejb">maven:ejb</a></td> <td>Creates an <code>EJB</code>jar file.</td> </tr> <tr> <td><a href="#maven:ear">maven:ear</a></td> <td>Creates an <code>EAR</code> file.</td> </tr> </table> <p/> <subsection name="maven:war"> <p> The <code>maven:war</code> target generates the project's war file. This is the default target of the build file. The war file is produced in the <code><a href="../properties.html#Directory Layout Settings"> ${maven.build.dir}</a></code> directory and has a name defined by the <code><a href="properties.html#maven.j2ee.war.name">${maven.j2ee.war.name}</a></code> property. </p> <p> This target calls the <code><a href="../build-file.html#maven:jar">maven:jar</a></code> target of the maven build file so that any jar files, classes and resources created by the project during compilation are available to the war process. </p> <p> Maven also includes the license file, LICENSE.txt, if it exists, under the directory META-INF. </p> <p> The contents of the war file include: </p> <table> <tr><th>Item</th><th>Description</th></tr> <tr> <td>Web Content</td> <td> HTML, images, JavaScript, stylesheets, JSP pages and other files, as defined by the <code><a href="properties.html#maven.j2ee.war.content">${maven.j2ee.war.content}</a></code> property. </td> </tr> <tr> <td>Jar files</td> <td> Any jar files that the war is dependent on to execute. These jar files are placed into the <code>/WEB-INF/lib</code> of the resulting war. Currently this is all of the jar files defined in the <a href="../project-descriptor.html#dependencies"> project dependencies</a>. </td> </tr> <tr> <td>Java classes</td> <td> Class files in the <code><a href="../properties.html#Directory Layout Settings">${maven.build.dest}</a></code> directory. The properties <code><a href="properties.html#maven.j2ee.war.classes.includes">${maven.j2ee.war.classes.includes}</a></code> and <code><a href="properties.html#maven.j2ee.war.classes.excludes">${maven.j2ee.war.classes.excludes}</a></code> determine how to filter the directory contents for inclusion in the war. These files are placed in the <code>/WEB-INF/classes</code> of the resulting war file. </td> </tr> <tr> <td>web.xml</td> <td> A J2EE web application deployment descriptor, which is placed in the <code>/WEB-INF</code> of the resulting war file. The <code><a href="properties.html#maven.j2ee.war.webxml">${maven.j2ee.war.webxml}</a></code> property defines the location of this file </td> </tr> </table> </subsection> <subsection name="maven:validate-war"> <p> The <code>maven:validate-war</code> target validates the newly produced war file. </p> <p> The validator checks the folowing: <ol> <li>The war file exists</li> <li>It is readable</li> <li>The war file has a web.xml (it's only a warning if it doesn't exist)</li> <li>Servlets defined by a <code><servlet></code> tag are loadable from the war file and <strong>not</strong> the classpath</li> <li>JSPs defined by a <code><servlet></code> tag exist in the war </li> <li>Taglibs defined by a <code><taglib></code> have a <code> <taglib-location></code> that exists in the war</li> <li>Error pages specified by a <code><location></code> nested within an <code><error-page></code> element must exist in the war file</li> <li>Login and error pages specified in the <code><form-login-config ></code> element must exist in the war file</li> </ol> </p> </subsection> <subsection name="maven:ejb"> <p> The <code>maven:ejb</code> target generates the <code>ejb</code> jar file for the project. Optionally it can also create jars containing the local and remote interfaces. The files are produced in the <code><a href="../properties.html#Directory Layout Settings">${maven.build.dir}</a>/ejb</code> directory and have a name based on the <code><a href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a></code> property. </p> <p>The files generated are: <ul> <li><code>${maven.j2ee.ejb.name}.jar</code></li> <li><code>${maven.j2ee.ejb.name}-remote.jar</code> <emp>(optional)</emp></li> <li><code>${maven.j2ee.ejb.name}-local.jar</code> <emp>(optional)</emp></li> </ul> </p> <p> Maven also includes the license file, LICENSE.txt, if it exists, in the META-INF directory. </p> <p> The contents of the ejb file include: </p> <table> <tr><th>Item</th><th>Description</th></tr> <tr> <td>ejb-jar.xml</td> <td> A J2EE enterprise bean deployment descriptor, which is placed in the root of the resulting ear file. The <code><a href="properties.html#maven.j2ee.ejb.conf.dir"> ${maven.j2ee.ejb.conf.dir}</a></code> and associated includes and excludes properties defines the location of this file. </td> </tr> <tr> <td>Classes</td> <td> The files in the <code><a href="../properties.html#Directory Layout Settings">${maven.build.dest}</a></code> directory to be included is specified using the <code><a href="properties.html#maven.j2ee.ejb.includes">${maven.j2ee.ejb.includes}</a></code> and <code><a href="properties.html#maven.j2ee.ejb.excludes">${maven.j2ee.ejb.excludes}</a></code> properties. </td> </tr> <tr> <td>Meta-Inf</td> <td> Files to be included the <code>META-INF</code> directory of the ejb jar file may be specified using the <code><a href="properties.html#maven.j2ee.ejb.conf.dir"> ${maven.j2ee.ejb.conf.dir}</a></code>, <code><a href="properties.html#maven.j2ee.ejb.conf.includes"> ${maven.j2ee.ejb.conf.includes}</a></code> and <code><a href="properties.html#maven.j2ee.ejb.conf.excludes"> ${maven.j2ee.ejb.conf.excludes}</a></code> properties. </td> </tr> </table> </subsection> <subsection name="maven:ear"> <p> The <code>maven:ear</code> target generates an ear file for the project. The ear file is produced in the <code><a href="../properties.html#Directory Layout Settings">${maven.build.dir}</a></code> directory and has a name defined by the <code><a href="properties.html#maven.j2ee.ear.name">${maven.j2ee.ear.name}</a></code> property. </p> <p> This target automatically invokes the <code><a href="#maven:war">maven:war</a></code> target to ensure any war generated by the project is included in the ear. </p> <p> Maven also includes the license file, LICENSE.txt, if it exists, under the directory META-INF. </p> <p> The contents of the ear file include: </p> <table> <tr><th>Item</th><th>Description</th></tr> <tr> <td>application.xml</td> <td> A J2EE enterprise application deployment descriptor, which is placed in the root of the resulting ear file. The <code><a href="properties.html#maven.j2ee.ear.appxml">${maven.j2ee.ear.appxml}</a></code> property defines the location of this file. </td> </tr> <tr> <td>Other Content</td> <td> Files in the <code><a href="../properties.html#Directory Layout Settings">${maven.build.dir}</a></code> directory may be included using the <code><a href="properties.html#maven.j2ee.ear.includes">${maven.j2ee.ear.includes}</a></code> and <code><a href="properties.html#maven.j2ee.ear.excludes">${maven.j2ee.ear.excludes}</a></code> properties. </td> </tr> </table> </subsection> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/j2ee/dirlayout.xml Index: dirlayout.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">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="../../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/webapps</td> <td>The base directory under which web applications can be found.</td> <td> This directory contains other directories, one per web application to be built. The web application name is passed to maven as the property ${maven.j2ee.war.name} </td> </tr> <tr> <td><a href="../properties.html#Directory Layout Settings">maven.conf.dir</a></td> <td>Configuration files such as deployment descriptors.</td> <td> This directory is <a href="../properties.html#Directory Layout Settings"> defined by Maven</a>, and used by the J2EE Plug-in to store the J2EE deployment descriptors. </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> 1.1 jakarta-turbine-maven/xdocs/plugins/j2ee/futures.xml Index: futures.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">dIon Gillard</author> <title>Futures for the J2EE Plug-in</title> </properties> <body> <section name="Futures"> <p> The following is a list of things that are being contemplated for the Maven J2EE Plug-in. </p> <ol> <li> Add back the war lib excludes and includes </li> <li> Add HTML validation. </li> <li> Add EAR validation. </li> <li> Add technology specific validators, e.g. JSP/Turbine/Velocity/Struts etc </li> </ol> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/j2ee/index.xml Index: index.xml =================================================================== <?xml version="1.0"?> <document> <properties> <title>J2EE Plug-in Reference Documentation</title> <author email="[EMAIL PROTECTED]">dIon Gillard</author> </properties> <body> <section name="J2EE Reference Documentation"> <p> This document provides an overview of the reference section for the Maven J2EE Plug-in. The documents presented here are references, if you are looking for more verbose usage material, please refer to the <a href="../../start/index.html">Getting Started</a> section. </p> <subsection name="Overview of the J2EE Plug-in Reference Documentation"> <table> <tr><th>Document</th><th>Description</th></tr> <tr><td><a href="build-file.html">Build File</a></td> <td> This document provides detailed information on the various targets that are available as part of the Maven J2EE Plug-in. These targets can be delegated to by your project's local build file. </td> </tr> <tr><td><a href="properties.html">Properties</a></td> <td> The behavior of the Maven J2EE Plug-in can be altered via numerous properties. This document describes each property available as the default used. </td> </tr> <tr><td><a href="dirlayout.html">Directory Layout</a></td> <td> The preferred directory layout structure is documented here. This is a useful document if you are trying to determine what a particular component of your directory hierarchy is used for. </td> </tr> <tr><td><a href="futures.html">Futures</a></td> <td> These are the current thoughts on additional items that could or should be added to the plug-in. They may or may not make it to an actual task list of a developer. </td> </tr> </table> </subsection> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/j2ee/navigation.xml Index: navigation.xml =================================================================== <?xml version="1.0" encoding="ISO-8859-1"?> <project name="Maven"> <title>Maven</title> <logo href="/images/maven.jpg">Maven</logo> <organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo> <body> <links> <item name="Turbine" href="http://jakarta.apache.org/turbine/"/> <item name="Turbine-2" href="http://jakarta.apache.org/turbine/turbine-2/"/> <item name="Turbine-3" href="http://jakarta.apache.org/turbine/turbine-3/"/> <item name="Torque" href="http://jakarta.apache.org/turbine/torque/"/> <item name="Fulcrum" href="http://jakarta.apache.org/turbine/fulcrum/"/> <item name="TDK" href="http://jakarta.apache.org/turbine/tdk/"/> <item name="Stratum" href="http://jakarta.apache.org/turbine/stratum/"/> <item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/> <item name="JCS" href="http://jakarta.apache.org/turbine/jcs/"/> </links> <menu name="Overview"> <item name="Goals" href="/goals.html"/> <item name="Features" href="/features.html"/> <item name="News and Status" href="/status.html"/> <item name="Getting Started" href="/start/index.html"/> <item name="Reference" href="/ref/index.html"/> <item name="Plugins" href="/plugins/index.html"> <item name="J2EE Plugin" href="/plugins/j2ee/index.html"> <item name="Build File" href="/plugins/j2ee/build-file.html"/> <item name="Properties" href="/plugins/j2ee/properties.html"/> <item name="Directory Layout" href="/plugins/j2ee/dirlayout.html"/> <item name="Futures" href="/plugins/j2ee/futures.html"/> </item> <item name="Struts Plugin" href="/plugins/struts/index.html"/> </item> <item name="Powered By" href="/powered.html"/> </menu> </body> </project> 1.1 jakarta-turbine-maven/xdocs/plugins/j2ee/properties.xml Index: properties.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">dIon Gillard</author> <author email="[EMAIL PROTECTED]">Kevin O'Neill</author> <title>Maven J2EE Plug-in Properties Documentation</title> </properties> <body> <section name="Maven J2EE Plug-in Properties"> <p> The following is an overview of the various properties (and default values) used by the Maven J2EE Plug-in <a href="build-file.html">build file</a>. These properties control various aspects of the J2EE build. Most of these properties are optional and have defaults; however, there are mandatory properties that must be set as described in this document. </p> <p> These properties can be overridden to change the default behavior of the Maven J2EE Plug-in. If you need to override any of these properties, please refer to the <a href="../../start/integrate.html">Integration</a> document for the preferred method of setting properties in your project. </p> <table> <tr><th>Section</th><th>Description</th></tr> <tr> <td><a href="#War Settings">War</a></td> <td> These properties specify various settings that control the build of a war file by the J2EE Plug-in. </td> </tr> <tr> <td><a href="#EJB Settings">EJB</a></td> <td> These properties specify various settings that control the build of a ejb jar by the J2EE Plug-in. </td> </tr> <tr> <td><a href="#Ear Settings">Ear</a></td> <td> These properties specify various settings that control the build of an ear file by the J2EE Plug-in. </td> </tr> <tr> <td><a href="#Callbacks">Callbacks</a></td> <td> These properties specify how you can tell the J2EE Plug-in you would like to perform pre or post-processing, e.g. perform certain tasks before or after a war or ear is built. </td> </tr> </table> </section> <section name="War Settings"> <table> <tr><th>Property</th><th>Optional?</th><th>Description</th></tr> <tr> <td><a name="maven.j2ee.war.name">maven.j2ee.war.name</a></td> <td>No</td> <td> Specifies the name of the web application to be built. </td> </tr> <tr> <td><a name="maven.j2ee.war.src">maven.j2ee.war.src</a></td> <td>Yes</td> <td> Specifies the directory in the local file system that is used as the base directory for finding web applications. It defaults to <code><a href="../properties.html#Directory Layout Settings">${maven.src.dir}</a>/webapps</code> </td> </tr> <tr> <td><a name="maven.j2ee.war.content">maven.j2ee.war.content</a></td> <td>Yes</td> <td> Specifies the directory in the local file system that holds web content to be placed in the war file. It defaults to ${maven.j2ee.war.src}/${maven.j2ee.war.name} </td> </tr> <tr> <td><a name="maven.j2ee.war.classes.includes">maven.j2ee.war.classes.includes</a></td> <td>Yes</td> <td> Specifies the pattern of files in the directory specified by <code><a href="../properties.html#Directory Layout Settings">${maven.build.dest}</a></code> to be included in the <code>/WEB-INF/classes</code> of the resulting war file. It defaults to <code>**</code>, that is, all files. </td> </tr> <tr> <td><a name="maven.j2ee.war.classes.excludes">maven.j2ee.war.classes.excludes</a></td> <td>Yes</td> <td> Specifies the pattern of files in the directory specified by <code><a href="../properties.html#Directory Layout Settings">${maven.build.dest}</a></code> that are <strong>not</strong> to be included in the <code>/WEB-INF/classes</code> of the resulting war file. It defaults to <code>**/package.html</code>. </td> </tr> <tr> <td><a name="maven.j2ee.war.lib.includes">maven.j2ee.war.lib.includes</a></td> <td>Yes</td> <td> <p>WARNING: This property is temporarily unused.</p> Specifies the pattern of files in the <a href="../project-descriptor.html#dependencies">project dependencies</a> to be included in the <code>/WEB-INF/lib</code> of the resulting war file. It defaults to <code>*.jar</code>, that is, all dependencies. </td> </tr> <tr> <td><a name="maven.j2ee.war.lib.excludes">maven.j2ee.war.lib.excludes</a></td> <td>Yes</td> <td> <p>WARNING: This property is temporarily unused.</p> Specifies the pattern of files in the <a href="../project-descriptor.html#dependencies">project dependencies</a> not to be included in the <code>/WEB-INF/lib</code> of the resulting war file. It defaults to blank, that is, no dependencies are excluded. </td> </tr> <tr> <td><a name="maven.j2ee.war.webxml">maven.j2ee.war.webxml</a></td> <td>Yes</td> <td> Specifies the deployment descriptor to be used when building the war file. It will be placed in <code>/WEB-INF/web.xml</code> of the resulting war file. It defaults to <code><a href="../properties.html#Directory Layout Settings">${maven.conf.dir}</a>/${maven.j2ee.war.name}-web.xml</code> </td> </tr> </table> </section> <section name="EJB Settings"> <table> <tr><th>Property</th><th>Optional?</th><th>Description</th></tr> <tr> <td><a name="maven.j2ee.ejb.name">maven.j2ee.ejb.name</a></td> <td>No</td> <td> Specifies the name of the ejb jar to be built. </td> </tr> <tr> <td><a name="maven.j2ee.ejb.conf.dir">maven.j2ee.ejb.conf.dir</a></td> <td>No</td> <td> Specifies the directory to be used to find the deployment descriptor and other files to be placed in <code>META-INF</code> directory of the resulting ejb jar. It defaults to <code><a href="../properties.html#Directory Layout Settings">${maven.conf.dir}</a>/<a href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a></code> </td> </tr> <tr> <td> <a name="maven.j2ee.ejb.conf.includes">maven.j2ee.ejb.conf.includes </a> </td> <td>Yes</td> <td> Specifies the a pattern of files to be included in the <code>META-INF</code> directory of the resulting ejb jar, relative to the <code>${maven.j2ee.ejb.conf.dir}</code>. It defaults to <code>ejb-jar.xml</code>. </td> </tr> <tr> <td> <a name="maven.j2ee.ejb.conf.excludes">maven.j2ee.ejb.conf.excludes </a> </td> <td>Yes</td> <td> Specifies the a pattern of files to be excluded from the <code>META-INF</code> directory of the resulting ejb jar, relative to the <code>${maven.j2ee.ejb.conf.dir}</code>. It defaults to blank. </td> </tr> <tr> <td><a name="maven.j2ee.ejb.includes">maven.j2ee.ejb.includes</a></td> <td>Yes</td> <td> Specifies the pattern of files in the <a href="../properties.html#Directory Layout Settings">${maven.build.dest}</a> directory to be included in the generated ejb jar. Defaults to <code>**/*</code>. </td> </tr> <tr> <td><a name="maven.j2ee.ejb.excludes">maven.j2ee.ejb.includes</a></td> <td>Yes</td> <td> Specifies the pattern of compiled class files to be <strong>excluded</strong> from the generated ejb jar. Defaults to <code>**/package.html</code>. </td> </tr> <tr> <td><a name="maven.j2ee.ejb.local.includes">maven.j2ee.ejb.local.includes</a></td> <td>Yes</td> <td> If this property exists then a jar file with the name <code><a href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-local.jar</code> containing the matching files will be generated in <code><a href="../properties.html#Directory Layout Settings">${maven.build.dir}</a>/ejb</code>. </td> </tr> <tr> <td><a name="maven.j2ee.ejb.local.excludes">maven.j2ee.ejb.local.excludes</a></td> <td>Yes</td> <td> Files to be <strong>excluded</strong> from the <code><a href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-local.jar</code> </td> </tr> <tr> <td><a name="maven.j2ee.ejb.remote.includes">maven.j2ee.ejb.remote.includes</a></td> <td>Yes</td> <td> If this property exists then a jar file with the name <code><a href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-remote.jar</code> containing the matching files will be generated in <code><a href="../properties.html#Directory Layout Settings">${maven.build.dir}</a>/ejb</code>. </td> </tr> <tr> <td><a name="maven.j2ee.ejb.remote.excludes">maven.j2ee.ejb.remote.excludes</a></td> <td>Yes</td> <td> Files to be <strong>excluded</strong> from the <code><a href="properties.html#maven.j2ee.ejb.name">${maven.j2ee.ejb.name}</a>-remote.jar</code> </td> </tr> </table> </section> <section name="Ear Settings"> <table> <tr><th>Property</th><th>Optional?</th><th>Description</th></tr> <tr> <td><a name="maven.j2ee.ear.name">maven.j2ee.ear.name</a></td> <td>No</td> <td> Specifies the name of the enterprise application to be built. </td> </tr> <tr> <td><a name="maven.j2ee.ear.includes">maven.j2ee.ear.includes</a></td> <td>Yes</td> <td> Specifies the pattern of files in the <code><a href="../properties.html#Directory Layout Settings">${maven.build.dir}</a></code> directory to be included in the resulting ear file. It defaults to <code>*.jar, *.war</code>, that is, all jar and war files. </td> </tr> <tr> <td><a name="maven.j2ee.ear.excludes">maven.j2ee.ear.excludes</a></td> <td>Yes</td> <td> Specifies the pattern of files in the <code><a href="../properties.html#Directory Layout Settings">${maven.build.dir}</a></code> directory that are not to be included in the resulting ear file. It defaults to blank, that is, nothing is excluded. </td> </tr> <tr> <td><a name="maven.j2ee.ear.appxml">maven.j2ee.ear.appxml</a></td> <td>Yes</td> <td> Specifies the deployment descriptor to be used when building the ear file. It will be placed in <code>/application.xml</code> of the resulting ear file. It defaults to <code><a href="../properties.html#Directory Layout Settings">${maven.conf.dir}</a>/${maven.j2ee.ear.name}-application.xml</code> </td> </tr> </table> </section> <section name="Callbacks"> <table> <tr><th>Property</th><th>Optional?</th><th>Description</th></tr> <tr> <td><a name="maven.j2ee.callback.pre-war.buildFile">maven.j2ee.callback.pre-war.buildFile</a></td> <td>Yes</td> <td> Specifies the build file to be used when pre-processing a war file. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.pre-war.buildTarget"> maven.j2ee.callback.pre-war.buildTarget</a></td> <td>Yes</td> <td> Specifies the target of the preprocess build file to be called as a war is being built. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.post-war.buildFile"> maven.j2ee.callback.post-war.buildFile</a></td> <td>Yes</td> <td> Specifies the build file to be used when post-processing a war file. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.post-war.buildTarget"> maven.j2ee.callback.post-war.buildTarget</a></td> <td>Yes</td> <td> Specifies the target of the postprocess build file to be called after a war has been built. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.pre-ejb.buildFile"> maven.j2ee.callback.pre-ejb.buildFile</a></td> <td>Yes</td> <td> Specifies the build file containing the target to call immediately before building the ejb jar. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.pre-ejb.buildTarget"> maven.j2ee.callback.pre-ejb.buildFile</a></td> <td>Yes</td> <td> Specifies the target to call immediately before building the ejb jar. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.post-ejb.buildFile"> maven.j2ee.callback.post-ejb.buildFile</a></td> <td>Yes</td> <td> Specifies the build file containing the target to call immediately after building the ejb jar. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.post-ejb.buildTarget"> maven.j2ee.callback.post-ejb.buildTarget</a></td> <td>Yes</td> <td> Specifies the target to call immediately after building the ejb jar. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.pre-ear.buildFile"> maven.j2ee.callback.pre-ear.buildFile</a></td> <td>Yes</td> <td> Specifies the build file to be used when pre-processing an ear file. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.pre-ear.buildTarget"> maven.j2ee.callback.pre-ear.buildTarget</a></td> <td>Yes</td> <td> Specifies the target of the preprocess build file to be called as an ear is being built. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.post-ear.buildFile"> maven.j2ee.callback.post-ear.buildFile</a></td> <td>Yes</td> <td> Specifies the build file to be used when post-processing an ear file. There is no default for this property. </td> </tr> <tr> <td><a name="maven.j2ee.callback.post-ear.buildTarget"> maven.j2ee.callback.post-ear.buildTarget</a></td> <td>Yes</td> <td> Specifies the target of the postprocess build file to be called after an ear has been built. There is no default for this property. </td> </tr> </table> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/struts/build-file.xml Index: build-file.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">dIon Gillard</author> <title>Maven Plug-in Build File Documentation</title> </properties> <body> <section name="Maven Struts Plug-in Build File"> <p> Maven utilizes <a href="http://jakarta.apache.org/ant/">Ant</a> to provide users with an easy-to-use and familiar interface to manage projects that have been described with a valid Maven <a href="../project-descriptor.html">project descriptor</a>. The build files that Maven <a href="../../start/index.html"> installs</a> are stored in <code>${maven.home}</code> directory. </p> <p> This document describes the Ant build file and targets that are available when using the Struts Plug-in with Maven. </p> <p> The current recommended approach to using Maven is to add delegators to these Maven-provided targets in your project's main build file. This will enable you to use your existing build file with the additional Maven functionality. In addition, it is also recommended that you load a standard set of property files. The property files will setup your environment, <code>${lib.repo}</code> and <code>${maven.home}</code>, and allow you to override Maven defaults properties. Please refer to the <a href="../../start/integrate.html">Integration</a> document for more information on how to integrate these build targets into your project. </p> <p> The following table contains a brief overview of the build file that is installed as part of the Maven Struts Plug-in in the <code>${maven.home}/plugin/struts</code> directory. In addition, the various Ant targets in this file is discussed. </p> <table> <tr><th>Build File</th><th>Description</th></tr> <tr> <td><a href="#struts/build.xml">build.xml</a></td> <td> Contains a target validate Struts <code>WAR</code> files. </td> </tr> </table> <p> The build file utilizes various properties for default and user-configurable settings. All Struts Plug-in properties are described in the <a href="properties.html">Properties</a> document. The rest of this document assumes your project follows the standard <a href="dirlayout.html">Directory Layout</a>; however, it is possible to override many of these defaults. </p> </section> <section name="struts/build.xml"> <table> <tr><th>Target</th><th>Description</th></tr> <tr> <td><a href="#maven:validate-struts-war">maven:validate-struts-war</a></td> <td>Validate a Struts <code>WAR</code> file.</td> </tr> </table> <p/> <subsection name="maven:validate-struts-war"> <p> The <code>maven:validate-struts-war</code> target validates the struts war file. </p> <p> The validator checks the folowing: <ol> <li>It's a valid war file as per the <a href="../j2ee/index.html"> J2EE War Validator</a></li> <li>The war file has a struts configuration, usually <code>WEB-INF/struts-config.xml</code></li> <li>Form Beans defined by a <code><form-bean></code> tag have a <code>type</code> that is loadable from the war file and <strong>not</strong> the classpath. If the form bean has a <code>className</code>, that class too must be loaded from the war</li> <li>Actions defined by a <code><action<</code> tag have several validations: <ol> <li>the <code>className</code> attribute must be a class loadable from the war</li> <li>the <code>name</code> attribute, must match a <code><form-bean> name</code> attribute.</li> <li>the <code>path</code> attribute must start with a forward slash, i.e. '/'</li> <li>the <code>scope</code> attribute must be one of <code>request</code> or <code>sesssion</code></li> <li>the <code>type</code> attribute must be a class loadable from the war</li> <li>the <code>unknown</code> and <code>validate</code> attributes must be either <code>true</code> or <code> false</code></li> </ol> </li> </ol> </p> </subsection> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/struts/dirlayout.xml Index: dirlayout.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">dIon Gillard</author> <title>Maven Struts 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="../../start/integrate.html#Properties">Integration</a> document. </p> </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.</td> <td> This directory is used by the Struts Plug-in as the source of the war to be validated. </td> </tr> </table> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/struts/futures.xml Index: futures.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">dIon Gillard</author> <title>Futures for the Struts Plug-in</title> </properties> <body> <section name="Futures"> <p> The following is a list of things that are being contemplated for the Maven Struts Plug-in. </p> <ol> <li>Validate forwards</li> <li>Support Struts 1.1</li> <li>Generate struts-config using xdoclet</li> <li>Generate form beans from validation.xml</li> </ol> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/struts/index.xml Index: index.xml =================================================================== <?xml version="1.0"?> <document> <properties> <title>Struts Plug-in Reference Documentation</title> <author email="[EMAIL PROTECTED]">dIon Gillard</author> </properties> <body> <section name="Struts Plug-in Reference Documentation"> <p> This document provides an overview of the Maven Struts Plug-in. </p> <p> The documents presented here are references, if you are looking for more verbose usage material, please refer to the <a href="../../start/index.html">Getting Started</a> section. </p> <subsection name="What it is"> <p> The Struts Plug-in is the place where <a href="http://jakarta.apache.org/struts/">Struts</a> tools are found in Maven. </p> <p> At the moment it provides a some useful, simple functionality for developers who use struts as their web application framework of choice. This is in no way a statement by the Maven developers that Struts is the best web application framework for your needs, as Maven is web app framework agnostic, and will be soon providing plug-ins for other frameworks. </p> </subsection> <subsection name="Overview of the Struts Plug-in Reference Documentation"> <table> <tr><th>Document</th><th>Description</th></tr> <tr><td><a href="build-file.html">Build File</a></td> <td> This document provides detailed information on the various targets that are available as part of the Maven Struts Plug-in. These targets can be delegated to by your project's local build file. </td> </tr> <tr><td><a href="properties.html">Properties</a></td> <td> The behavior of the Maven Struts Plug-in can be altered via properties. This document describes each property available as the default used. </td> </tr> <tr><td><a href="dirlayout.html">Directory Layout</a></td> <td> The preferred directory layout structure is documented here. This is a useful document if you are trying to determine what a particular component of your directory hierarchy is used for. </td> </tr> <tr><td><a href="futures.html">Futures</a></td> <td> These are the current thoughts on additional items that could or should be added to the plug-in. They may or may not make it to an actual task list of a developer. </td> </tr> </table> </subsection> </section> </body> </document> 1.1 jakarta-turbine-maven/xdocs/plugins/struts/navigation.xml Index: navigation.xml =================================================================== <?xml version="1.0" encoding="ISO-8859-1"?> <project name="Maven"> <title>Maven</title> <logo href="/images/maven.jpg">Maven</logo> <organizationLogo href="/images/jakarta-logo-blue.gif">Jakarta</organizationLogo> <body> <links> <item name="Turbine" href="http://jakarta.apache.org/turbine/"/> <item name="Turbine-2" href="http://jakarta.apache.org/turbine/turbine-2/"/> <item name="Turbine-3" href="http://jakarta.apache.org/turbine/turbine-3/"/> <item name="Torque" href="http://jakarta.apache.org/turbine/torque/"/> <item name="Fulcrum" href="http://jakarta.apache.org/turbine/fulcrum/"/> <item name="TDK" href="http://jakarta.apache.org/turbine/tdk/"/> <item name="Stratum" href="http://jakarta.apache.org/turbine/stratum/"/> <item name="Maven" href="http://jakarta.apache.org/turbine/maven/"/> <item name="JCS" href="http://jakarta.apache.org/turbine/jcs/"/> </links> <menu name="Overview"> <item name="Goals" href="/goals.html"/> <item name="Features" href="/features.html"/> <item name="News and Status" href="/status.html"/> <item name="Getting Started" href="/start/index.html"/> <item name="Reference" href="/ref/index.html"/> <item name="Plugins" href="/plugins/index.html"> <item name="J2EE Plugin" href="/plugins/j2ee/index.html"/> <item name="Struts Plugin" href="/plugins/struts/index.html"> <item name="Build File" href="/plugins/struts/build-file.html"/> <item name="Properties" href="/plugins/struts/properties.html"/> <item name="Directory Layout" href="/plugins/struts/dirlayout.html"/> <item name="Futures" href="/plugins/struts/futures.html"/> </item> </item> <item name="Powered By" href="/powered.html"/> </menu> </body> </project> 1.1 jakarta-turbine-maven/xdocs/plugins/struts/properties.xml Index: properties.xml =================================================================== <?xml version="1.0"?> <document> <properties> <author email="[EMAIL PROTECTED]">dIon Gillard</author> <title>Maven Struts Plug-in Properties Documentation</title> </properties> <body> <section name="Maven Struts Plug-in Properties"> <p> The following is an overview of the various properties (and default values) used by the Maven Struts Plug-in <a href="build-file.html">build file</a>. Most of these properties are optional and have defaults; however, there are mandatory properties that must be set as described in this document. </p> <p> These properties can be overridden to change the default behavior of the Maven Struts Plug-in. If you need to override any of these properties, please refer to the <a href="../../start/integrate.html">Integration</a> document for the preferred method of setting properties in your project. </p> <table> <tr><th>Section</th><th>Description</th></tr> <tr> <td><a href="#War Settings">War</a></td> <td> These properties specify various settings that control the validation of a war file by the Struts Plug-in. </td> </tr> <tr> <td><a href="#Callbacks">Callbacks</a></td> <td> These properties specify settings that allow you to pre or post-process targets in the plug-in's build file. </td> </tr> </table> </section> <section name="War Settings"> <table> <tr><th>Property</th><th>Optional?</th><th>Description</th></tr> <tr> <td><a name="maven.j2ee.war.name">maven.j2ee.war.name</a></td> <td>No</td> <td> Specifies the name of the web application to be validated. This property is defined by the <a href="../j2ee/index.html">J2EE Plugin </a>. </td> </tr> </table> </section> <section name="Callbacks"> <table> <tr><th>Property</th><th>Optional?</th><th>Description</th></tr> <tr> <td><a name="maven.struts.callback.pre-validate-struts-war.buildFile"> maven.struts.callback.pre-validate-struts-war.buildFile</a></td> <td>Yes</td> <td> Specifies the build file to be used when pre-processing a war file validation. There is no default for this property. </td> </tr> <tr> <td><a name="maven.struts.callback.pre-validate-struts-war.buildTarget"> maven.struts.callback.pre-validate-validate-struts-war.buildTarget</a></td> <td>Yes</td> <td> Specifies the target of the preprocess build file to be called as a war is being validated. There is no default for this property. </td> </tr> <tr> <td><a name="maven.struts.callback.post-validate-struts-war.buildFile"> maven.struts.callback.post-validate-struts-war.buildFile</a></td> <td>Yes</td> <td> Specifies the build file to be used when post-processing a war file validation. There is no default for this property. </td> </tr> <tr> <td><a name="maven.struts.callback.post-validate-struts-war.buildTarget"> maven.struts.callback.post-validate-struts-war.buildTarget</a></td> <td>Yes</td> <td> Specifies the target of the postprocess build file to be called after a war has been validated. There is no default for this property. </td> </tr> </table> </section> </body> </document> 1.4 +1 -2 jakarta-turbine-maven/xdocs/ref/navigation.xml Index: navigation.xml =================================================================== RCS file: /home/cvs/jakarta-turbine-maven/xdocs/ref/navigation.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -u -r1.3 -r1.4 --- navigation.xml 23 May 2002 01:36:35 -0000 1.3 +++ navigation.xml 30 May 2002 12:55:22 -0000 1.4 @@ -27,14 +27,13 @@ <item name="Build File" href="/ref/build-file.html"/> <item name="Properties" href="/ref/properties.html"/> <item name="Directory Layout" href="/ref/dirlayout.html"/> - <item name="J2EE Plugin" href="/ref/j2ee/index.html" /> - <item name="Struts Plugin" href="/ref/struts/index.html" /> <item name="FAQ" href="/ref/faq.html"/> <item name="Update Process" href="/ref/updating.html"/> <item name="JRCS" href="/ref/jrcs.html"/> <item name="Metrics" href="/ref/metrics.html"/> <item name="Musings" href="/ref/musings.html"/> </item> + <item name="Plugins" href="/plugins/index.html"/> <item name="Powered By" href="/powered.html"/> </menu> </body> 1.12 +1 -1 jakarta-turbine-maven/xdocs/start/integrate.xml Index: integrate.xml =================================================================== RCS file: /home/cvs/jakarta-turbine-maven/xdocs/start/integrate.xml,v retrieving revision 1.11 retrieving revision 1.12 diff -u -r1.11 -r1.12 --- integrate.xml 28 May 2002 16:15:19 -0000 1.11 +++ integrate.xml 30 May 2002 12:55:23 -0000 1.12 @@ -541,7 +541,7 @@ </li> <li> If you require the creation of J2EE distributions, please - refer to the <a href="../ref/j2ee/index.html">J2EE + refer to the <a href="../plugins/j2ee/index.html">J2EE Plugin</a> documentation for more information. </li> <li> 1.2 +1 -0 jakarta-turbine-maven/xdocs/start/navigation.xml Index: navigation.xml =================================================================== RCS file: /home/cvs/jakarta-turbine-maven/xdocs/start/navigation.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- navigation.xml 1 May 2002 22:03:12 -0000 1.1 +++ navigation.xml 30 May 2002 12:55:23 -0000 1.2 @@ -30,6 +30,7 @@ <item name="Anakia Users" href="/start/anakia.html"/> </item> <item name="Reference" href="/ref/index.html"/> + <item name="Plugins" href="/plugins/index.html"/> <item name="Powered By" href="/powered.html"/> </menu> </body>
-- To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]> For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>