Updates to readme, javadoc, and sample poms.
Issues: SWF-1507
This commit is contained in:
@@ -78,97 +78,82 @@ For an exact list of project dependencies, see each project's ivy file at "proje
|
||||
------------------
|
||||
This distribution contains documentation and sample applications demonstrating the features of the Spring Web Flow projects.
|
||||
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.
|
||||
All projects are directly importable into Eclipse as "Dynamic Web Projects".
|
||||
See http://www.springframework.org/webflow-samples for more information.
|
||||
To build deployable .war files for the samples, access the projects/spring-webflow-samples directory and run "mvn package".
|
||||
Sample projects can be imported into an IDE as Maven projects or by generating IDE settings (e.g. "mvn eclipse:eclipse").
|
||||
|
||||
5. OBTAINING RELEASE JARS FROM THE SPRINGSOURCE BUNDLE REPOSITORY
|
||||
-----------------------------------------------------------------
|
||||
Each jar in the Web Flow distribution is available in the SpringSource release repository.
|
||||
These jars may be accessed using Maven or Ivy dependency managers.
|
||||
Browse the contents of the repository by accessing http://www.springsource.com/repository.
|
||||
5. OBTAINING RELEASE JARS WITH MAVEN OR IVY
|
||||
-------------------------------------------
|
||||
Release versions of Spring Web Flow artifacts are available via Maven Central.
|
||||
|
||||
To access jars using Maven, add the following repositories to your Maven pom:
|
||||
For milestones and snapshots only (and for Ivy dependencies) you'll need to use the
|
||||
SpringSource repository. Add the following repository to your Maven pom.xml:
|
||||
|
||||
<repository>
|
||||
<id>com.springsource.repository.bundles.release</id>
|
||||
<name>SpringSource Enterprise Bundle Repository - SpringSource Releases</name>
|
||||
<url>http://repository.springsource.com/maven/bundles/release</url>
|
||||
<id>spring-repository</id>
|
||||
<name>Spring project snapshots, milestones, and releases</name>
|
||||
<url>http://repo.springsource.org/snapshot</url>
|
||||
</repository>
|
||||
|
||||
<repository>
|
||||
<id>com.springsource.repository.bundles.external</id>
|
||||
<name>SpringSource Enterprise Bundle Repository - External Releases</name>
|
||||
<url>http://repository.springsource.com/maven/bundles/external</url>
|
||||
</repository>
|
||||
|
||||
Then declare the following dependencies (note that many times it's sufficient to include
|
||||
org.springframework.webflow only, which will give you org.springframework.binding,
|
||||
org.springframework.js, and org.springframework.js via transitive dependencies):
|
||||
Then declare the following dependencies (note that many times it's sufficient
|
||||
to include spring-webflow only, which will give you spring-binding and spring-js
|
||||
via transitive dependencies):
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.webflow</groupId>
|
||||
<artifactId>org.springframework.binding</artifactId>
|
||||
<artifactId>spring-binding</artifactId>
|
||||
<version>2.3.1.RELEASE</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.webflow</groupId>
|
||||
<artifactId>org.springframework.js</artifactId>
|
||||
<artifactId>spring-js</artifactId>
|
||||
<version>2.3.1.RELEASE</version>
|
||||
</dependency>
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.webflow</groupId>
|
||||
<artifactId>org.springframework.webflow</artifactId>
|
||||
<artifactId>spring-webflow</artifactId>
|
||||
<version>2.3.1.RELEASE</version>
|
||||
</dependency>
|
||||
|
||||
If using JavaServerFaces all you need to include is:
|
||||
If using JSF all you need to include is:
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.webflow</groupId>
|
||||
<artifactId>org.springframework.faces</artifactId>
|
||||
<artifactId>spring-faces</artifactId>
|
||||
<version>2.3.1.RELEASE</version>
|
||||
</dependency>
|
||||
|
||||
To access jars using Ivy, add the following repositories to your Ivy config:
|
||||
|
||||
<url name="com.springsource.repository.bundles.release">
|
||||
<ivy pattern="http://repository.springsource.com/ivy/bundles/release/[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
||||
<artifact pattern="http://repository.springsource.com/ivy/bundles/release/[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
||||
<url name="spring-project-releases">
|
||||
<ivy pattern="http://repo.springsource.org/release/[organization]/[module]/[revision]/[type]s/ivy-[revision].xml" />
|
||||
<artifact pattern="http://repo.springsource.org/release/[organization]/[module]/[revision]/[type]s/[module](-[classifier])-[revision].[ext]" />
|
||||
</url>
|
||||
|
||||
<url name="com.springsource.repository.bundles.external">
|
||||
<ivy pattern="http://repository.springsource.com/ivy/bundles/external/[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
||||
<artifact pattern="http://repository.springsource.com/ivy/bundles/external/[organisation]/[module]/[revision]/[artifact]-[revision].[ext]" />
|
||||
<url name="spring-project-releases-milestones-snapshots">
|
||||
<ivy pattern="http://repo.springsource.org/snapshot/[organization]/[module]/[revision]/[type]s/ivy-[revision].xml" />
|
||||
<artifact pattern="http://repo.springsource.org/snapshot/[organization]/[module]/[revision]/[type]s/[module](-[classifier])-[revision].[ext]" />
|
||||
</url>
|
||||
|
||||
Then declare the following dependencies in your ivy.xml:
|
||||
|
||||
<dependency org="org.springframework.webflow" name="org.springframework.binding" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
<dependency org="org.springframework.webflow" name="org.springframework.js" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
<dependency org="org.springframework.webflow" name="org.springframework.webflow" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
<dependency org="org.springframework.webflow" name="spring-binding" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
<dependency org="org.springframework.webflow" name="spring-js" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
<dependency org="org.springframework.webflow" name="spring-webflow" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
|
||||
If using JavaServerFaces:
|
||||
|
||||
<dependency org="org.springframework.webflow" name="org.springframework.faces" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
<dependency org="org.springframework.webflow" name="spring-faces" rev="2.3.1.RELEASE" conf="compile->runtime" />
|
||||
|
||||
Refer to the reference documentation for more coverage on obtaining Web Flow jars using Maven or Ivy.
|
||||
For more information see the SpringSource Repository FAQ:
|
||||
https://github.com/SpringSource/spring-framework/wiki/SpringSource-repository-FAQ
|
||||
|
||||
6. ADDITIONAL RESOURCES
|
||||
-----------------------
|
||||
The Spring Web Flow homepage is located at:
|
||||
http://www.springframework.org/webflow
|
||||
|
||||
There you will find resources such as a 'Quick Start' guide and a 'Frequently Asked Questions' section.
|
||||
http://www.springsource.org/spring-web-flow
|
||||
|
||||
The Spring Web Flow community forums are located at:
|
||||
http://forum.springframework.org
|
||||
|
||||
There you will find an active community of users collaborating about the project.
|
||||
|
||||
The Spring Community portal is located at:
|
||||
http://www.springframework.org
|
||||
|
||||
There you will find links to many resources on Spring Portfolio projects, including on-line access to Spring documentation.
|
||||
|
||||
Reference in New Issue
Block a user