Spring/spring-webflow
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updating readme text

Browse Source
This commit is contained in:
Keith Donald
2008-04-02 15:03:25 +00:00
parent 4b35fe9555
commit 765f520b6f
5 changed files with 80 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
build-spring-webflow/readme.txt
View File

@@ -1,38 +1,27 @@
This is where the master build that creates releases of Spring Web Flow resides.
This is where the master build that creates releases of Spring Web Flow resides. The build system is based on spring-build, which is linked in using an SVN external to https://src.springframework.org/svn/spring-build.
USERS
- To build all Spring Web Flow related projects:
- To build all Spring Web Flow projects:
1. From this directory, run:
ant dist
1. From this directory, run:
ant
Build Pre-requisites:
- javac 1.5 or > must be in your system path
- ant 1.6 or > must be in your system path
- ivy 1.3 or > (Note: a version of Ivy is included and will be used automatically if you do not already have
Ivy installed in your ANT_HOME/lib directory.
If you have Ivy already installed in %ANT_HOME%/lib make sure it is 1.3 or >. 1.2 won't work.)
- ant 1.7 or > must be in your system path
DEVELOPERS
- To build a new Spring Web Flow product release:
- To build a new Spring Web Flow distribution for release:
1. Update the files containing the version number to reflect the new release version, if necessary.
build-spring-webflow/project.properties
spring-binding/pom.xml
spring-binding/project.properties
spring-faces/pom.xml
spring-faces/project.properties
spring-webflow/changelog.txt
spring-webflow/pom.xml
spring-webflow/project.properties
spring-webflow/readme.txt
spring-webflow/docs/reference/src/index.xml
build.properties
build-spring-webflow/resources/readme.txt
spring-webflow-reference/src/spring-webflow-reference.xml
2. From this directory, run:
ant release
ant jar package
The release archive will be created and placed in:
target/release
Questions? See http://forum.springframework.org.
target/artifacts
Questions? See http://forum.springframework.org

2
build-spring-webflow/resources/changelog.txt
View File

@@ -2,7 +2,7 @@ SPRING WEB FLOW (SWF) CHANGELOG
===============================
http://www.springframework.org/webflow
Changes in version 2.0 RC1 (18.03.2008)
Changes in version 2.0 RC1 (04.04.2008)
-------------------------------------
Changes in version 2.0 M4 (06.03.2008)

84
build-spring-webflow/resources/readme.txt
View File

@@ -1,96 +1,98 @@
SPRING WEB FLOW 2.0 RC1 (March 2008)
SPRING WEB FLOW 2.0 RC1 (April 2008)
----------------------------------
http://www.springframework.org/webflow
http://forum.springframework.org
1. INTRODUCTION
---------------
Spring Web Flow (SWF) is the module of Spring that allows you to implement the "flows" of your web application.
Spring Web Flow (SWF) is a component of the Spring Framework's web stack focused on the definition
and execution of user interface (UI) flow within a web application.
A flow is an application module that encapsulates a sequences of steps that can execute in different contexts.
Flows typically guides a single user through the execution of some business task.
They often execute across HTTP requests, have state, exhibit transactional characteristics, are reused, and may be dynamic and/or long-running in nature.
The system allows you to capture a logical flow of your web application as a self-contained module
that can be reused in different situations. Such a flow guides a single user through the implementation
of a business task, and represents a single user conversation. Flows often execute across HTTP requests,
have state, exhibit transactional characteristics, and may be dynamic and/or long-running in nature.
Spring Web Flow exists at a higher level of abstraction, and provides you a declarative flow definition language for authoring flows.
SWF also integrates as a self-contained flow engine within base web frameworks such as Spring MVC. It allows different UI technologies to be integrated, including UI component technologies such as JavaServerFaces.
Spring Web Flow exists at a higher level of abstraction, integrating as a self-contained flow engine
within base frameworks such as Spring MVC and JSF. SWF provides you the capability to capture your
application's UI flow explicitly in a declarative, portable, and manageable fashion.
SWF is a controller framework that addresses the "C" in MVC.
2. RELEASE INFO
Spring Web Flow provides you the capability to capture reusable application UI flow in a declarative, portable, and manageable fashion.
It is a powerful controller engine that addresses the "C" in MVC.
2. RELEASE NOTES
----------------
Spring Web Flow 2.0 requires J2SE 1.4 and J2EE 1.4 (Servlet 2.4) or > to run.
J2SE 5.0 with Ant 1.6 and Ivy 2.0 or > is required to build. A compatible version of Ivy is shipped with this release.
J2SE 5.0 with Ant 1.7 is required to build.
SWF release contents:
"." contains Spring Web Flow distribution units (jars and source zip archives), readme, and copyright
"." contains Web Flow distribution readme and copyright
"dist" contains the Web Flow distribution jar files
"src" contains the Web FLow distribution source jar files
"docs" contains the Spring Web Flow reference manual and API Javadocs
"ivys" contains Ivy dependency descriptors for the Spring Web Flow and Spring Data Binding projects
"projects" contains all buildable projects, including sample applications (each importable into Eclipse)
"projects/common-build" contains the Ant-based "common build system" used by all projects to compile/build/test
"projects/repository" contains Spring Web Flow dependencies (dependent jars)
"projects/spring-webflow/build-spring-webflow" contains the master build file used to build all Spring Web Flow projects
"projects/spring-webflow/spring-binding" contains buildable Spring Data Binding project sources, an internal library used by SWF
"projects/spring-webflow/spring-faces" contains buildable Spring Faces project sources, a library containing SWF's JSF integration
"projects/spring-webflow/spring-webflow" contains buildable Spring Web Flow project sources
"projects/spring-webflow/spring-webflow-samples" contains buildable Spring Web Flow sample application sources
"projects/build-spring-webflow" the directory to access to build the Web Flow distribution
"projects/spring-build" The master build system used by all Spring projects, including Spring Web Flow
"projects/spring-binding" contains buildable Spring Data Binding project sources, an internal library used by SWF
"projects/spring-faces" contains buildable Spring Faces project sources, a library containing SWF's JSF integration
"projects/spring-javascript" contains buildable Spring JavaScript project sources, a library containing SWF's Dojo integration
"projects/spring-webflow" contains buildable Spring Web Flow project sources
"projects/spring-webflow-samples" contains buildable Spring Web Flow sample application sources
See the readme.txt within the above directories for additional information.
Spring Web Flow is released under the terms of the Apache Software License (see license.txt).
3. DISTRIBUTION JAR FILES
-------------------------
The following distinct jar files are included in the distribution.
This list specifies the respective contents and third-party dependencies.
Libraries in [brackets] are optional, i.e. just necessary for certain functionality.
The following distinct jar files are included in the distribution. This list
specifies the respective contents and third-party dependencies. Libraries in [brackets] are
optional, i.e. just necessary for certain functionality.
* spring-webflow-2.0-m4.jar
* spring-webflow-2.0.0-rc1.jar
- Contents: The Spring Web Flow system
- Dependencies: Commons Logging, spring-core, spring-beans, spring-context, spring-binding, spring-web, spring-webmvc
[Log4J, Xerces, XML APIs, OGNL, EL API, JPA API, Servlet API, Portlet API, Struts, JUnit]
* spring-binding-2.0-m4.jar
* spring-binding-2.0.0-rc1.jar
- Contents: The Spring Data Binding framework, an internal library used by SWF
- Dependencies: Commons Logging, spring-beans, spring-core, spring-context
[Log4J]
* spring-faces-2.0-m4.jar
* spring-javascript-2.0.0-rc1.jar
- Contents: The Spring JavaScript module, containing Spring Web Flow's integration with Dojo and additional JavaScript functionality.
- Dependencies: Dojo Toolkit 1.1
* spring-faces-2.0.0-rc1.jar
- Contents: The Spring Faces module, containing Spring Web Flow's integration with Java Server Faces (JSF) and additional JSF functionality.
- Dependencies: spring-webflow, JSF API
- Dependencies: spring-webflow, spring-javascript, JSF API
For an exact list of Spring Web Flow project dependencies see "projects/spring-webflow/ivy.xml".
4. WHERE TO START
-----------------
This distribution contains extensive documentation and sample applications illustrating the features of Spring Web Flow and its projects.
This distribution contains extensive documentation and sample applications illustrating the features of Spring Web Flow.
*** A great way to get started is to review and run the sample applications, supplementing with
reference manual material as needed. To build deployable .war files for all samples, simply
access the projects/spring-webflow/build-spring-webflow directory and execute the "dist" target.
[**] A great way to get started is to review and run the sample applications, supplementing with reference manual material as you go.
To build deployable .war files for all samples, simply access the projects/build-spring-webflow directory and run ant.
Also, all projects are directly importable into Eclipse as "Dynamic Web Projects".
5. ADDITIONAL RESOURCES
-----------------------
The Spring Web Flow homepage is located at:
http://www.springframework.org/webflow
http://www.springframework.org/webflow
There you will find resources such as a 'Quick Start' guide and a 'Frequently Asked Questions' section.
The Spring Web Flow support forums are located at:
http://forum.springframework.org
http://forum.springframework.org
There you will find an active community supporting the use of the product.
The Spring Community portal is located at:
http://www.springframework.org
http://www.springframework.org
There you will find links to many resources related to the Spring Framework, including on-line access
to Spring and Spring Web Flow documentation.

30
readme.txt
View File

@@ -2,25 +2,33 @@ Contained in this directory are the Spring Web Flow (SWF) related project source
DIRECTORIES
1. build-spring-webflow - Contains the build scripts needed to build all SWF projects.
To build all, simply execute the 'dist' ant target.
1. build-spring-webflow - Contains the metadata needed to build the SWF projects using spring-build.
To build all projects, simply run 'ant' (v1.7 or >) in this directory.
2. spring-build - A linked in SVN external to Spring's master build system.
Used to power the build for all Spring projects.
2. spring-binding - the data binding and mapping project, a Spring Web Flow driven internal library.
3. spring-binding - the data binding and mapping project, a Spring Web Flow driven internal library.
4. spring-webflow - The Spring Web Flow project. Contains the Web Flow engine.
5. spring-javscript - Spring's JavaScript abstraction framework, which includes Dojo integration.
6. spring-faces - Spring's JavaServerFaces integration module, which includes Web Flow & JavaScript support.
3. spring-webflow - The core Spring Web Flow project.
4. spring-webflow-samples - The Spring Web Flow sample applications, illustrating the framework in action.
7. spring-webflow-samples - The Spring Web Flow sample applications, illustrating the framework in action.
ARCHITECTURE DOCUMENTS
Also contained in this directory are two SonarJ files
1. webflow-architecture.xml
2. webflow-workspace.xml
When opened from SonarJ these provide an architectural breakdown of the Spring Web Flow projects.
It is recommended that you view this breakdown to familiarize yourself with the Spring Web Flow system
architecture, including its layers, subsystems, dependencies, and various architectural metrics such
as total lines of code and average component dependency.
SonarJ is an architecture analysis tool.
When opened in SonarJ, these files provide an architectural breakdown of the Spring Web Flow projects.
This can be a good way to familiarize yourself with the Spring Web Flow system architecture,
including its layers, subsystems, dependencies, and various architectural metrics such as total lines of code
and average component dependency.
To use SonarJ:
1. Download it from http://www.hello2morrow.com/en/sonarj/sonarj.php

14
spring-webflow-samples/readme.txt
View File

@@ -9,23 +9,17 @@ Sample pre-requisites:
----------------------
* JDK 1.5 or > must be installed with the JAVA_HOME variable set
* Ant 1.6 or > must be installed and in your system path
* Ivy 1.3 or >; if you already have Ivy installed into your ant lib path, it must be Ivy 1.3 or >. Ivy 1.2 or < won't work.
If you do not have Ivy installed, a compatible version will be picked up automatically from ../../common-build/lib
* A Servlet 2.4 and JSP 2.0-capable servlet container must be installed for sample app deployment
- The samples all use jsp 2.0 to take advantage of EL ${expressions} for elegance.
* Ant 1.7 or > must be installed and in your system path
To build all samples:
---------------------
1. cd to the ../build-spring-webflow directory
2. run 'ant dist' to produce deployable .war files for all samples
Built .war files are placed in target/artifacts/war within each sample directory.
2. run 'ant' to produce deployable .war files for all samples
Built .war files are placed in target/artifacts within each sample directory.
To build an individual sample:
---------------------
1. cd to the sample root directory
2. run 'ant dist' to produce a deployable .war file within target/artifacts/war
2. run 'ant dist' to produce a deployable .war file within target/artifacts