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

Formatting changes in README.md

Browse Source
This commit is contained in:
rstoyanchev
2023-03-30 12:25:43 +01:00
parent 43dc24af4f
commit 77410d70ea
1 changed files with 40 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@@ -1,10 +1,21 @@
# Overview
Spring Web Flow facilitates building web applications that require guided navigation -- e.g. a shopping cart, flight check-in, a loan application, and many others. In contrast to stateless, free-form navigation such use cases have a clear start and end point, one or more screens to go through in a specific order, and a set of changes that are not finalized to the end.
Spring Web Flow facilitates building web applications that require guided navigation --
e.g. a shopping cart, flight check-in, a loan application, and many others.
In contrast to stateless, free-form navigation such use cases have a clear start and end
point, one or more screens to go through in a specific order, and a set of changes
that are not finalized to the end.
A distinguishing feature is the ability to define a **flow definition** consisting of *states*, *transitions*, and *data*. For example, view states correspond to the individual screens of the flow while transitions are caused by events resulting from the click of a button or a link. Data may be stored in scopes such as *flash*, *view*, *flow*, and others. Scoped data is cleared when it is no longer in scope.
A distinguishing feature is the ability to define a **flow definition** consisting of
*states*, *transitions*, and *data*. For example, view states correspond to the
individual screens of the flow while transitions are caused by events resulting from
the click of a button or a link. Data may be stored in scopes such as
*flash*, *view*, *flow*, and others. Scoped data is cleared when it is no longer in scope.
In REST terms a flow represents as a single resource. The same URL used to start the flow is also the URL used to step through the flow (there is also an execution key uniquely identifying the current flow instance). As a result of this approach navigation remains encapsulated in the flow definition.
In REST terms a flow represents as a single resource.
The same URL used to start the flow is also the URL used to step through the flow
(there is also an execution key uniquely identifying the current flow instance).
As a result of this approach navigation remains encapsulated in the flow definition.
Some key benefits of using Spring Web Flow:
@@ -20,27 +31,37 @@ Some key benefits of using Spring Web Flow:
# Documentation
See the current [Javadoc](https://docs.spring.io/spring-webflow/docs/current/api/) and [Reference](https://docs.spring.io/spring-webflow/docs/current/reference/html/) docs.
See the current
[Javadoc](https://docs.spring.io/spring-webflow/docs/current/api/) and
[Reference](https://docs.spring.io/spring-webflow/docs/current/reference/html/) docs.
# Samples
Samples can be found in the spring-webflow-samples [Github repository](https://github.com/SpringSource/spring-webflow-samples).
Samples can be found in the spring-webflow-samples
[Github repository](https://github.com/SpringSource/spring-webflow-samples).
## Code of Conduct
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.adoc).
By participating, you are expected to uphold this code. Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
By participating, you are expected to uphold this code.
Please report unacceptable behavior to spring-code-of-conduct@pivotal.io.
# Downloading artifacts
Instructions on [downloading Spring Web Flow](https://github.com/SpringSource/spring-webflow/wiki/Downloading-Spring-Web-Flow-Artifacts) artifacts via Maven and other build systems are available via the project wiki.
Download [instructions](https://github.com/SpringSource/spring-webflow/wiki/Downloading-Spring-Web-Flow-Artifacts)
for Spring Web Flow artifacts via Maven and other build systems are available via the project wiki.
# Issue Tracking
Spring Web Flow's JIRA issue tracker can be found [here](https://jira.springsource.org/browse/SWF). If you think you've found a bug, please consider helping to reproduce it by submitting an issue reproduction project via the [spring-webflow-issues](https://github.com/springsource/spring-webflow-issues) repository. The [readme](https://github.com/springsource/spring-webflow-issues#readme) provides simple step-by-step instructions.
Spring Web Flow's JIRA issue tracker can be found [here](https://jira.springsource.org/browse/SWF).
If you think you've found a bug, please consider helping to reproduce it by submitting an issue
reproduction project via the [spring-webflow-issues](https://github.com/springsource/spring-webflow-issues) repository.
The [readme](https://github.com/springsource/spring-webflow-issues#readme) provides simple step-by-step instructions.
# Getting support
Check out the [Spring forums](https://forum.spring.io/forumdisplay.php?36-Web-Flow) and the [spring-webflow tag](https://stackoverflow.com/questions/tagged/spring-webflow) on StackOverflow. [Commercial support](https://springsource.com/support/springsupport) is available too.
Check out the [Spring forums](https://forum.spring.io/forumdisplay.php?36-Web-Flow) and the
[spring-webflow tag](https://stackoverflow.com/questions/tagged/spring-webflow) on StackOverflow.
[Commercial support](https://springsource.com/support/springsupport) is available too.
# Building from source
@@ -64,11 +85,19 @@ Generate Eclipse settings and then manually import projects:
./import-into-eclipse.sh
````
The Spring Framework and Spring Web Flow use a very similar build system. For this reason the following [Gradle build FAQ](https://github.com/SpringSource/spring-framework/wiki/Gradle-build-and-release-FAQ) would be a very useful read.
The Spring Framework and Spring Web Flow use a very similar build system.
For this reason the following
[Gradle build FAQ](https://github.com/SpringSource/spring-framework/wiki/Gradle-build-and-release-FAQ)
would be a very useful read.
# Contributing
[Pull requests](https://help.github.com/send-pull-requests) are welcome. You'll be asked to sign our contributor license agreement ([CLA](https://support.springsource.com/spring_committer_signup)). Trivial changes like typo fixes are especially appreciated (just [fork and edit](https://github.com/blog/844-forking-with-the-edit-button)!). For larger changes, please search through JIRA for similiar issues, creating a new one if necessary, and discuss your ideas with the Spring Web Flow team.
[Pull requests](https://help.github.com/send-pull-requests) are welcome.
You'll be asked to sign our contributor license agreement ([CLA](https://support.springsource.com/spring_committer_signup)).
Trivial changes like typo fixes are especially appreciated
(just [fork and edit](https://github.com/blog/844-forking-with-the-edit-button)!).
For larger changes, please search through JIRA for similiar issues,
creating a new one if necessary, and discuss your ideas with the Spring Web Flow team.
# License