From 4987be7f92ce5b8d0bb768184a542326ee089da1 Mon Sep 17 00:00:00 2001 From: dion Date: Sun, 18 Jul 2004 14:07:38 +0000 Subject: [PATCH] Revamp docs git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@115845 13f79535-47bb-0310-9956-ffa450edef68 --- struts/xdocs/futures.xml | 2 +- struts/xdocs/goals.xml | 41 ++++++++++++- struts/xdocs/index.xml | 35 +++-------- struts/xdocs/navigation.xml | 1 - struts/xdocs/properties.xml | 117 ++---------------------------------- 5 files changed, 55 insertions(+), 141 deletions(-) diff --git a/struts/xdocs/futures.xml b/struts/xdocs/futures.xml index 82da1be7..391cd995 100644 --- a/struts/xdocs/futures.xml +++ b/struts/xdocs/futures.xml @@ -32,7 +32,7 @@

  1. Validate forwards
    2. -
  2. Support Struts 1.1
    3. +
  3. More Support for Struts 1.1
  4. Generate struts-config using xdoclet
  5. Generate form beans from validation.xml
diff --git a/struts/xdocs/goals.xml b/struts/xdocs/goals.xml index a998bd9c..3f62867f 100644 --- a/struts/xdocs/goals.xml +++ b/struts/xdocs/goals.xml @@ -27,11 +27,48 @@ struts - Ensure a war file containing a Struts application is valid + Call struts:validate-war struts:validate-war - Ensure a war file containing a Struts application is valid + +

+ Ensure a war file containing a Struts application is valid. +

+

+ The validator checks the folowing: +

    +
  1. It's a valid war file as per the + J2EE War Validator +
    2. +
  2. The war file has a struts configuration, usually + WEB-INF/struts-config.xml +
    3. +
  3. + Form Beans defined by a <form-bean> tag + have a type that is loadable from the war file + and not the classpath. If the form bean has + a className, that class too must be loaded from + the war +
    4. +
  4. Actions defined by a <action> tag have + several validations: +
      +
    1. the className attribute must be a class loadable from the war
      2. +
    2. the name attribute, must match a <form-bean> name attribute.
      3. +
    3. the path attribute must start with a forward slash, i.e. '/'
      4. +
    4. the scope attribute must be one of request or sesssion
      5. +
    5. the type attribute must be a class loadable from the war
      6. +
    6. + the unknown and validate + attributes must be either true or + false +
      7. +
    +
    5. +
+

+ diff --git a/struts/xdocs/index.xml b/struts/xdocs/index.xml index efccd1b0..b661edd9 100644 --- a/struts/xdocs/index.xml +++ b/struts/xdocs/index.xml @@ -29,50 +29,35 @@

This document provides an overview of the Maven Struts Plug-in.

-

- The documents presented here are references, if you are looking - for more verbose usage material, please refer to the Getting Started section. -

The Struts Plug-in is the place where Struts tools are found + href="http://struts.apache.org/">Struts tools are found in Maven.

- 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

+ + +]]> - + - - - diff --git a/struts/xdocs/navigation.xml b/struts/xdocs/navigation.xml index 10f7f522..caafc530 100644 --- a/struts/xdocs/navigation.xml +++ b/struts/xdocs/navigation.xml @@ -29,7 +29,6 @@ - diff --git a/struts/xdocs/properties.xml b/struts/xdocs/properties.xml index 8aa28565..378734e1 100644 --- a/struts/xdocs/properties.xml +++ b/struts/xdocs/properties.xml @@ -1,119 +1,12 @@ - - + - - dIon Gillard - Maven Struts Plug-in Properties Documentation + Maven Struts Plugin Properties - -
-

- The following is an overview of the various properties (and - default values) used by the Maven Struts Plug-in build file. Most of these - properties are optional and have defaults; however, there are - mandatory properties that must be set as described in this document. -

-

- 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 Integration - document for the preferred method of setting properties in your project. -

-
DocumentDescription
Build File
Goals 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.
Properties The behavior of the Maven Struts Plug-in can be altered via properties. This document describes each property - available as the default used. -
Directory Layout - 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.
Futures
- - - - - - - - - -
SectionDescription
War - These properties specify various settings that control the validation - of a war file by the Struts Plug-in. -
Callbacks - These properties specify settings that allow you to pre or post-process - targets in the plug-in's build file. -
- - -
- - - - - - - -
PropertyOptional?Description
maven.j2ee.war.nameNo - Specifies the name of the web application to be validated. This - property is defined by the J2EE Plugin - . -
-
-
- - - - - - - - - - - - - - - - - - - - - - -
PropertyOptional?Description
- maven.struts.callback.pre-validate-struts-war.buildFileYes - Specifies the build file to be used when pre-processing a war file - validation. There is no default for this property. -
- maven.struts.callback.pre-validate-validate-struts-war.buildTargetYes - Specifies the target of the preprocess build file to be called as a - war is being validated. - There is no default for this property. -
- maven.struts.callback.post-validate-struts-war.buildFileYes - Specifies the build file to be used when post-processing a war file - validation. There is no default for this property. -
- maven.struts.callback.post-validate-struts-war.buildTargetYes - Specifies the target of the postprocess build file to be called after - a war has been validated. - There is no default for this property. -
+
+

There are no settings to customize this plugin

- + \ No newline at end of file