dion 02/05/22 00:23:46
Added: xdocs/ref/struts properties.xml navigation.xml index.xml
futures.xml dirlayout.xml build-file.xml
Log:
no message
Revision Changes Path
1.1 jakarta-turbine-maven/xdocs/ref/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>
</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-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-struts-validate-war.buildFile">
maven.struts.callback.post-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.1 jakarta-turbine-maven/xdocs/ref/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="Project Descriptor" href="/ref/project-descriptor.html"/>
<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="Build File" href="/ref/struts/build-file.html"/>
<item name="Properties" href="/ref/struts/properties.html"/>
<item name="Directory Layout" href="/ref/struts/dirlayout.html"/>
<item name="Futures" href="/ref/struts/futures.html"/>
</item>
<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="Powered By" href="/powered.html"/>
</menu>
</body>
</project>
1.1 jakarta-turbine-maven/xdocs/ref/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 reference section
for the Maven Struts 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 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/ref/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 action mappings</li>
<li>Validate forwards</li>
</ol>
</section>
</body>
</document>
1.1 jakarta-turbine-maven/xdocs/ref/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 and EARs.</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/ref/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>
</ol>
</p>
</subsection>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
