Author: wsmoak
Date: Sat May 6 10:02:20 2006
New Revision: 400336
URL: http://svn.apache.org/viewcvs?rev=400336&view=rev
Log:
Move README into the website and remove mention of release structure and
example apps.
Modify NOTICE and remove LICENSE-JSF.txt-- the JSF RI is not included in
Struts-Faces.
Include LICENSE and NOTICE in the jar.
Issue: STR-2846
Added:
struts/action/trunk/faces/src/site/resources/
struts/action/trunk/faces/src/site/resources/README.txt
- copied, changed from r399940, struts/action/trunk/faces/README.txt
Removed:
struts/action/trunk/faces/LICENSE-JSF.txt
struts/action/trunk/faces/README.txt
Modified:
struts/action/trunk/faces/NOTICE.txt
struts/action/trunk/faces/pom.xml
struts/action/trunk/faces/src/site/xdoc/index.xml (contents, props
changed)
Modified: struts/action/trunk/faces/NOTICE.txt
URL:
http://svn.apache.org/viewcvs/struts/action/trunk/faces/NOTICE.txt?rev=400336&r1=400335&r2=400336&view=diff
==============================================================================
--- struts/action/trunk/faces/NOTICE.txt (original)
+++ struts/action/trunk/faces/NOTICE.txt Sat May 6 10:02:20 2006
@@ -1,9 +1,2 @@
This product includes software developed by
The Apache Software Foundation (http://www.apache.org/).
-
-This product includes the JavaServer Faces reference
-implementation, developed by Sun Microsystems
-(http://java.sun.com/j2ee/javaserverfaces/) and
-redistributed in accordance with license terms found
-in LICENSE-JSF.txt.
-
Modified: struts/action/trunk/faces/pom.xml
URL:
http://svn.apache.org/viewcvs/struts/action/trunk/faces/pom.xml?rev=400336&r1=400335&r2=400336&view=diff
==============================================================================
--- struts/action/trunk/faces/pom.xml (original)
+++ struts/action/trunk/faces/pom.xml Sat May 6 10:02:20 2006
@@ -54,6 +54,13 @@
<include>**/*.properties</include>
</includes>
</resource>
+ <resource>
+ <directory>${basedir}</directory>
+ <includes>
+ <include>*.txt</include>
+ </includes>
+ </resource>
+
</resources>
<testResources>
<testResource>
Copied: struts/action/trunk/faces/src/site/resources/README.txt (from r399940,
struts/action/trunk/faces/README.txt)
URL:
http://svn.apache.org/viewcvs/struts/action/trunk/faces/src/site/resources/README.txt?p2=struts/action/trunk/faces/src/site/resources/README.txt&p1=struts/action/trunk/faces/README.txt&r1=399940&r2=400336&rev=400336&view=diff
==============================================================================
--- struts/action/trunk/faces/README.txt (original)
+++ struts/action/trunk/faces/src/site/resources/README.txt Sat May 6 10:02:20
2006
@@ -8,11 +8,7 @@
This package contains an add-on library that supports the use of
JavaServer Faces (JSF) user interface technology in a Struts based web
-application, in place of the Struts custom tag libraries. As a proof of
-concept, it also includes the canonical "struts-example" example
-web application, converted to use JSF tags, as well as tags from the
-JSP Standard Tag Library (JSTL), version 1.0 or later. It also includes
-a very basic Tiles based application, modified in a similar manner.
+application, in place of the Struts custom tag libraries.
The Struts-Faces Integration Library should work with any implementation
of JavaServer Faces, version 1.0 or later. It has primarily been tested
@@ -26,13 +22,6 @@
NEW AND REVISED FEATURES:
========================
-
-Struts-Faces Integration Library (Version 1.0):
-----------------------------------------------
-
-This release of the Struts-Faces Integration Library (Version 1.0) has the
-following new features relative to the previous (0.4) release:
-
* As of the nightly build 20040902, the URI for the struts-faces tag library
has changed. You should now be using:
@@ -103,250 +92,6 @@
* Integration with the Validator Framework should work properly
in all cases now.
-
-========================
-CONTENTS OF THIS RELEASE:
-========================
-
-
-Top Level Directory:
--------------------
-
- build.xml -- Ant build script (only required for building from
- source).
-
- build.properties.sample
- -- Sample "build.properties" file that may be customized
- (only required for building from source).
-
- LICENSE.txt -- The Apache Software License, under which all software
- included in this bundle is licensed.
-
- LICENSE-JSF.txt -- The license for the JavaServer Faces reference
- impementation, which applies to the included
- jsf-api.jar and jsf-impl.jar files.
-
- NOTICE.txt -- Attribution notices for software included in this
- distribution.
-
- README.txt -- This README file.
-
-
-Directory "conf":
-----------------
-
- struts-faces.tld -- The JSP tag library descriptor file for the
- Struts-Faces integration tag library.
-
-
-Directory "docs":
-----------------
-
- struts-faces.html -- Reference documentation for the Struts-Faces
- integration tag library.
-
- api/ -- Javadocs for the classes included in the Struts-Faces
- integration library (org.apache.struts.faces.*).
-
-
-Directory "lib":
----------------
-
- struts-faces.jar -- The compiled classes (and embedded tag library
- descriptor) for the Struts-Faces integration library.
-
-
-Directory "src":
----------------
-
- conf/ -- Source files for the generated TLD and tag library
- documentation (only required for building from source),
- as well as the faces-config.xml file used to register
- custom components and renderers.
-
- example/ -- Source files for the "struts-example" application that
- has been converted to use JavaServer Faces components.
- You can compare this to the corresponding sources in a
- standard Struts release to see what had to be changed.
-
- example2/ -- Source files for a Tiles-based example application
- that has been converted to use JavaServer Faces
- components.
-
- java/ -- Source files for the Struts-Faces integration library
- classes (only required for building from source). The
- following packages (under org.apache.struts.faces)
- contain the necessary code:
-
- application -- Integrate with ActionListener,
- custom PropertyResolver,
- custom RequestProcessors
-
- component -- Custom JavaServer Faces component
- implementations (only Form for now)
-
- renderer -- Custom JavaServer Faces renderer
- implementations
-
- taglib -- Custom JavaServer Faces component tag
- implementations
-
- util -- Miscellaneous utility classes
-
-
-Directory "web":
----------------
-
- example/ -- JSP and web application configuration files for the
- "struts-example" application that has been converted
- to use JavaServer Faces components. You can compare
- this to the corresponding sources in a standard Struts
- release to see what had to be changed.
-
- example2/ -- JSP and web application configuration files for a
- Tiles-based example application.
-
-
-Directory "webapps":
--------------------
-
- struts-faces.war -- The converted example application, ready to be
- deployed on a Servlet 2.3 / JSP 1.2 container.
-
- struts-faces2.war -- The Tiles-based example application, ready to be
- deployed on a Servlet 2.3 / JSP 1.2 container.
-
-
-================================
-RUNNING THE EXAMPLE APPLICATIONS:
-================================
-
-The following steps are required to deploy and run the example application
-(struts-faces.war) included in this distribution. A similar process is
-necessary to run the second (struts-faces2.war) example as well.
-
-
-Install A Java Development Kit:
-------------------------------
-
-The Struts-Faces integration library requires a Java Development Kit (not
-the Java Runtime Environment), version 1.3 or later. It was tested against
-Sun's JDK 1.4.2 release, available at:
-
- http://java.sun.com/j2se/
-
-
-Install a Servlet Container:
----------------------------
-
-The Struts-Faces integration library has been tested against Tomcat 4.1.29
-and 5.0.25, but should run in any container that supports
-the Servlet 2.3 (or later) and JSP 1.2 (or later) specifications. Note that
-these version levels are higher than what Struts requires for itself -- they
-correspond to the minimum requirements specified by JSF 1.0.
-
-If you attempt to run the example programs in a servlet container that has an
-early access or beta version of JavaServer Faces installed already (such as
-the Java Web Services Developer Pack, version 1.2 or 1.3), you must take one
-of the following two actions before you can successfully use the new
-Struts-Faces Integration Library and the corresponding final release of
-JavaServer Faces. Either:
-
-* Replace any existing version of JavaServer Faces in your container,
- following the container's specific instructions for this process (and leave
- the JavaServer Faces JARs out of your web application); or
-
-* Remove any existing version of JavaServer Faces in your container,
- following the container's specific instructions for this process, and plan
- on including the JavaServer Faces JARs with your webapp. If you plan to
- build the example application from scratch, be sure to include the property
- setting "build.standalone=true" in your local "build.properties" file.
-
-
-Install The Struts-Faces Integration Library Distribution:
----------------------------------------------------------
-
-Stable releases of the Struts-Faces integration library (when released)
-will be available at:
-
- http://jakarta.apache.org/site/binindex.cgi
-
-You can also download nightly builds from:
-
- http://jakarta.apache.org/builds/jakarta-struts/nightly/struts-faces/
-
-In either case, source code is included in the distribution, so no separate
-source distribution is needed.
-
-
-Deploy The Example Application:
-------------------------------
-
-Follow the standard instructions for your container to deploy the
-struts-faces.war web application archive. For the JWSDP 1.2 or 1.3 release,
-or for any standard Tomcat 4.1.x or 5.0.x release, you have the following
-choices:
-
-* Drop the "struts-faces.war" file into the "webapps" subdirectory
- of the servlet container release, and wait a few moments for the container
- to recognize the new application and deploy it for you.
-
-* Use the dynamic deployment Ant commands, as described below.
-
-
-Execute The Example Application:
--------------------------------
-
-By default, the application will be installed at context path "/struts-faces",
-so the URL to access it will typically be something like:
-
- http://localhost:8080/struts-faces/
-
-The example application is functionally identical to the canonical
-struts-example.war application included in standard Struts 1.1 releases.
-When first started, the only valid username/password combination is
-"user" and "pass".
-
-
-====================
-BUILDING FROM SOURCE:
-====================
-
-If you wish, you can build the Struts-Faces integration library, and the
-sample application, from the source code included in this distribution.
-Follow these steps:
-
-
-Install An Ant Distribution:
----------------------------
-
-If you have downloaded the JWSDP 1.2 or 1.3 release described above, Ant is
-already included. Otherwise, download Apache Ant, version 1.5.4 or later,
from:
-
- http://ant.apache.org/bindownload.cgi
-
-Install this environment as described in the Ant documentation, and ensure
-that Ant's "bin" directory is on your PATH.
-
-
-Configure Your Build Properties:
--------------------------------
-
-Copy the "build.properties.sample" file in the top level directory to a file
-named "build.properties", and customize the settings that are specified there.
-
-
-Build The Sources:
------------------
-
-The simplest way to build is to execute:
-
- ant clean dist
-
-to recreate the entire distribution in the "dist" subdirectory. Use the
-"ant -projecthelp" command to see what other targets are available.
-
-
=======================================================
USING THE STRUTS-FACES LIBRARY IN YOUR OWN APPLICATIONS:
=======================================================
@@ -545,36 +290,4 @@
combining JSF component tags and other JSP source elements (including
custom tags from other tag libraries) on the same page. See
Section 9.2.8 of the JSF spec for more information.
-
-
-===============
-DEVELOPER NOTES:
-===============
-
-The CVS sources for the Struts-Faces integration library include a System
-Integration test suite that is comprised of a test web application (default
-context path is "/struts-faces-systest") and a client application based on
-the HtmlUnit package from SourceForge. To execute the test suite:
-
-* Update your build.properties file as needed to declare appropriate values
- for the "htmlunit.home" and "junit.home" properties.
-
-* Update your build.properties file as necessary for deploying applications
- to a standalone Tomcat instance. You should be able to successfully use
- the "example.install" and "example2.install" targets.
-
-* Compile and deploy the system integration application by executing the
- Ant target "systest.install".
-
-* Execute the test client by executing the Ant target "sysclient.execute".
-
-* When you have finished testing, you can remove the test application by
- executing the Ant target "systest.remove".
-
-* Before committing any changes to the integration library, be sure that the
- system integration tests can be succesfully executed.
-
-* If you add new functionality to the integration library, you should also
- add or enhance the system integration tests to catch potential future
- regressions as the library is updated by you, or others, in the future.
Modified: struts/action/trunk/faces/src/site/xdoc/index.xml
URL:
http://svn.apache.org/viewcvs/struts/action/trunk/faces/src/site/xdoc/index.xml?rev=400336&r1=400335&r2=400336&view=diff
==============================================================================
--- struts/action/trunk/faces/src/site/xdoc/index.xml (original)
+++ struts/action/trunk/faces/src/site/xdoc/index.xml Sat May 6 10:02:20 2006
@@ -29,11 +29,7 @@
<p>The "Struts-Faces" package contains an add-on library that supports
the use of
JavaServer Faces (JSF) user interface technology in a Struts based web
- application, in place of the Struts custom tag libraries. As a proof of
- concept, it also includes the canonical "struts-example" example
- web application, converted to use JSF tags, as well as tags from the
- JSP Standard Tag Library (JSTL), version 1.0 or later. It also includes
- a very basic Tiles based application, modified in a similar manner.</p>
+ application, in place of the Struts custom tag libraries.</p>
<p>The Struts-Faces Integration Library should work with any implementation
of JavaServer Faces, version 1.0 or later. It has primarily been tested
@@ -43,15 +39,10 @@
http://java.sun.com/j2ee/javaserverfaces/
</a>
</p>
- </section>
-
- <section name="Struts-Faces Download">
- <a name="download"/>
-
- <p>Nightly builds of the Struts-Faces Integration Library are available
from
- <a href="http://cvs.apache.org/builds/struts/nightly/struts-faces/";>
- http://cvs.apache.org/builds/struts/nightly/struts-faces/</a>.</p>
+ <p>For more information, consult the
+ <a href="README.txt" target="_blank">README</a> file.
+ </p>
</section>
<section name="Struts-Faces Issue Tracking">
Propchange: struts/action/trunk/faces/src/site/xdoc/index.xml
------------------------------------------------------------------------------
svn:eol-style = native
