dion 2004/07/18 07:07:38
Modified: struts/xdocs navigation.xml goals.xml futures.xml
properties.xml index.xml
Log:
Revamp docs
Revision Changes Path
1.4 +0 -1 maven-plugins/struts/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven-plugins/struts/xdocs/navigation.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- navigation.xml 4 Mar 2004 18:38:56 -0000 1.3
+++ navigation.xml 18 Jul 2004 14:07:38 -0000 1.4
@@ -29,7 +29,6 @@
<menu name="Overview">
<item name="Goals" href="/goals.html"/>
<item name="Properties" href="/properties.html"/>
- <item name="Directory Layout" href="/dirlayout.html"/>
<item name="Futures" href="/futures.html"/>
</menu>
</body>
1.3 +39 -2 maven-plugins/struts/xdocs/goals.xml
Index: goals.xml
===================================================================
RCS file: /home/cvs/maven-plugins/struts/xdocs/goals.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- goals.xml 4 Mar 2004 18:38:56 -0000 1.2
+++ goals.xml 18 Jul 2004 14:07:38 -0000 1.3
@@ -27,11 +27,48 @@
<goals>
<goal>
<name>struts</name>
- <description>Ensure a war file containing a Struts application is
valid</description>
+ <description>Call <code>struts:validate-war</code></description>
</goal>
<goal>
<name>struts:validate-war</name>
- <description>Ensure a war file containing a Struts application is
valid</description>
+ <description>
+ <p>
+ Ensure a war file containing a Struts application is valid.
+ </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>
+ </description>
</goal>
</goals>
</body>
1.3 +1 -1 maven-plugins/struts/xdocs/futures.xml
Index: futures.xml
===================================================================
RCS file: /home/cvs/maven-plugins/struts/xdocs/futures.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- futures.xml 4 Mar 2004 18:38:56 -0000 1.2
+++ futures.xml 18 Jul 2004 14:07:38 -0000 1.3
@@ -32,7 +32,7 @@
</p>
<ol>
<li>Validate forwards</li>
- <li>Support Struts 1.1</li>
+ <li>More Support for Struts 1.1</li>
<li>Generate struts-config using xdoclet</li>
<li>Generate form beans from validation.xml</li>
</ol>
1.3 +5 -112 maven-plugins/struts/xdocs/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven-plugins/struts/xdocs/properties.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- properties.xml 4 Mar 2004 18:38:56 -0000 1.2
+++ properties.xml 18 Jul 2004 14:07:38 -0000 1.3
@@ -1,119 +1,12 @@
-<?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.
- */
- -->
+<?xml version="1.0" encoding="UTF-8"?>
<document>
-
<properties>
- <author email="[EMAIL PROTECTED]">dIon Gillard</author>
- <title>Maven Struts Plug-in Properties Documentation</title>
+ <title>Maven Struts Plugin Properties</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 name="Maven Struts Plugin Settings">
+ <p>There are no settings to customize this plugin</p>
</section>
</body>
-</document>
+</document>
\ No newline at end of file
1.3 +10 -25 maven-plugins/struts/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/maven-plugins/struts/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 4 Mar 2004 18:38:56 -0000 1.2
+++ index.xml 18 Jul 2004 14:07:38 -0000 1.3
@@ -29,50 +29,35 @@
<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
+ href="http://struts.apache.org/";>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.
+ At the moment it provides a validator to ensure a war file is valid. To
+ use this validator, simply add the following snippet to your maven.xml
</p>
+ <source><![CDATA[
+<postGoal name="war">
+ <attainGoal name="struts"/>
+</postGoal>]]></source>
</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>
+ <tr><td><a href="goals.html">Goals</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.
+ goals that are available as part of the Maven Struts Plug-in.
</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.
+ available and the default used.
</td>
</tr>
<tr><td><a href="futures.html">Futures</a></td>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
