dist/
docs/
lib/
src/
src/java/template/
webapps/
README.txt
build.properties
build.xml
ivy.xml
osbuild.xml
pom.xml
webwork-(VERSION).jar
webwork-(VERSION).zip
webwork-(VERSION)-src.jar

lib/
      ajax
      bootstrap
      build
      cewolf
      default
      fileupload
      fileupload-cos
      fileupload-pell
      hibernate
      jasperreports
      jfree
      pico
      plexus
      portlet
      quickstart
      sitemesh
      source
      spring
      tiger
      tiles
      velocity
      xslt

java -jar webwork.jar quickstart:<application-name>

java -jar webwork.jar quickstart:shopping-cart

The previous section described the Quickstart mechanism for trying the supplied example webapps, but Quickstart is also a handy tool for development of your own WebWork based applications. We recommend you using the said mechanism unless you are familiar with standalone servlet containers and have good reasons to switch, such as preparing a production system etc.

ant build -Dwebapp=XXX

 you have some knowledge of the supporting technologies.

{panel:title=Supporting Technologies}
- Java
- Servlets, JSP, and Tag Libraries
- JavaBeans
- HTML and HTTP
- Web Containers (such as Tomcat)
- XML
{panel}

For more about any of the supporting technologies, visit the [Key Technologies page|http://struts.apache.org/struts-action/userGuide/preface.html] on the Apache Struts website.

h2. Downloads and Resources {anchor:Website&downloads}

To get started with the framework, download the distribution and browse some of the online resources.

h3. Download the Distribution

{note}A release of SAF 2 may not yet be available.{note}

The full distribution can be downloaded form the [Apache Struts website|http://struts.apache.org/downloads.html]. The distribution contains the {{struts-action2.jar}} file, a copy of all the documentation, sources, all [required and optional dependencies|Dependencies],and example applications. For more information on how to build the framework from source or even from a clean checkout, please refer to [Building the Framework from Source].

h2. Browse the Resources

There are many online resources available. Here are links to help you find your way:
- [Download SAF2|http://struts.apache.org/downloads.html] \- download the framework distribution
- [Join the Forums|http://forums.opensymphony.com/category.jspa?categoryID=5] \- The forums are full of active developers, contributors, and power users - often even available for chat. This is the best and quickest way to get a question answered.
- [Subscribe to Mailing List and post a question, or browse Mail Archive|http://struts.apache.org/mail.html]. (You probably want to browse the archive or forum first. All posts from the forum are posted to the mailing lists, and vice versa.
- [Subversion Repository|http://svn.apache.org/viewcvs.cgi/struts/action2/] \- Browse the source.
- [Confluence Wiki|http://confluence.twdata.org/] \- Read it here first! The project documentation is created on the wiki and then posted as HTML to the website. 
- [JIRA Issue Tracker|http://issues.apache.org/struts/] \- Browse or file enhancements requests and defect reports.
- [Apache Struts Home|http://struts.apache.org/]

h2. Distribution Quickstart


h3. Overview

The distribution contains the following directory layout:
{noformat}
dist/
docs/
lib/
src/
src/java/template/
webapps/
README.txt
build.properties
build.xml
ivy.xml
osbuild.xml
pom.xml
struts-action-(VERSION).jar
struts-action-(VERSION).zip
struts-action-(VERSION)-src.jar
{noformat}
The {{docs}} directory contains the current Javadocs, the full user documentation including the document you are reading, and taglib documentation, as well as Clover, JUnit and dependency reports for the build.

The {{dist}} directory contains framework files with different packaging:
- struts-action-nostatic-<version>.jar: containing only the framework without the static content
- struts-action-static-<version>.zip: containing the required framework static dependencies

The {{lib}} directory contains the required as well as optional [Dependencies] for the framework, organized in subdirectories to represent different optional configurations:
{noformat}
lib/
      ajax
      bootstrap
      build
      cewolf
      default
      fileupload
      fileupload-cos
      fileupload-pell
      hibernate
      jasperreports
      jfree
      pico
      plexus
      portlet
      quickstart
      sitemesh
      source
      spring
      tiger
      tiles
      velocity
      xslt
{noformat}
Note that none of the _optional_ packages are required to use the framework. If you wish to use certain features such as JasperReports or Java 5 (Tiger) generics and annotation support, then you must include the optional packages.

The framework also comes packaged with all the source files and templates for the JSP tags.

h2. Running demos with QuickStart{anchor:Running demos}

The framework provides a slick way to jump into web development called QuickStart. Essentally, QuickStart is combination of technologies and conventions. The key technology is the ability to run web applications "out of the box" with a stripped-down [Jetty|http://jetty.mortbay.org/jetty/] container.

With QuickStart, running the demos is as easy as can be. You just need to run:
{code}
> java -jar webwork.jar quickstart:<application-name>
{code}
from the distribution's top directory, where {{<application-name>}} is one of the subdirectory names under {{webapps/}}. Each subdirectoy hosts a demo application. 

If you want to start the shopping-cart webapp, the startup command would be:
{code}
> java -jar webwork.jar quickstart:shopping-cart
{code}
One the application starts up, point your browser to {{[http://localhost:8080/shopping-cart/]}}, and you should be ready to go. 

Several example appliations are included in the distribution. 
|| blank | Not really an example application, but a _blank_ web application template to use as the base for your own applications |
|| cookbook | A "how to" application that displays the full source code for each "recipe". |
|| mailreader | The infamous Struts MailReader application.
|| portlet | Demonstration of our porlet integration (to be deployed in a Portal Server) - see [Portlet Tutorial] to read more about portlets |
|| shopping-cart | Simple example application demonstrating various aspects of the framework |
|| showcase | Extensive demonstration of all tag and AJAX features, along with other examples and some best practices |
|| starter | Basic web application that you can use as a starting point for experimenting with framework features - one could almost call it a "playground" application |

You can review the [QuickStart documentation|QuickStart] to learn more about how it works and how you can utilize QuickStart with your own applications.

See below for a more detailed description of how the blank application helps you to easily create your own WebWork-based applications.

h2. Running Demos with Your Favorite Web Container {anchor:Running demos}

In order to deploy applications and demos to your favorite servlet container (also called web container) such as [Apache Tomcat|http://jakarta.apache.org/tomcat/] or [Caucho Resin|http://www.caucho.com/], you will need to build WAR files from the webapps directory. You will find an Antbuild file there which will provide you with an easy way to build your own WARs.

{note:title=To Quickstart or not to Quickstart?}
Quickstart is a handy tool for development of your applications. We recommend that you give QuickStart a try, to see if it meets your development needs. However, QuickStart is not meant to be your sole environment for web application development. QuickStart is meant to help you rapidily create proof-of-concepts and so that you can see the result. We recommend you always at least test your work under other applications servers, such as Tomcat, Resin, or even the standard, standalone version of Jetty.
{note}

To build a web application archive (WAR), simply run:
{code}
> ant build -Dwebapp=$APP
{code}
where {{$APP}} is the name of the web application you want to build. After the build is finished, the fully-built WAR file can be found in the {{dist}} directory. You may deploy this file to any servlet container.

To build the {{showcase}] aplication, substite "showcase" for $ID.

{code}
> ant build -Dwebapp=showcase
{code}

To deploy the built {{showcase.war}} to Tomcat, move or copy the WAR to {{$TOMCAT_HOME/webapps/}} or use the Tomcat Manager Application to upload and deploy the WAR. After the WAR is deployed (and your server is started), point your browser to 

{code}
> http://localhost/showcase
{code}

Of course, if the server is not local, substitute the IP or hostname for "localhost", including a port designation if needed.  If you are not deploying the Showcase application, then substitute the appropriate application name for "showcase"

{info:title=Deploying the Examples}
The framework build copies the sources of each bundled web application to {{dist/webapps/$APP}}. The build also compiles the sources for each appolication and creates a WAR at {{dist/webapps/$APP.war}}. However, these WAR files are NOT ready to be deployed. These WARs do not include any of the JAR files. (Omitting the JARS reduces the size of the download by almost 200mb.) To include the dependant JARs, run Ant in the {{dist/webapps}} directory, and new WARs, with all the JARs, are placed in {{dist/webapps/dist}}.
{info}

h2. Your First SAF2 Application {anchor:Installing}

To get started on your own application, you can utilize the blank template, run the Ant task, or just setup your own from scratch.

h3. Using the Blank template

The blank web application in the distribution's {webapp} directory is meant as a template. Make a copy of "blank" and use the copy as the basis for your application. 

h3. Run the Ant task

While it's simple enough to copy a directory tree, there is an even easier way to get started. In the {{webapps}} directory, there is a {{build.xml}} file. The {{new}} task of this Ant build file can create fresh, empty web application for you. Just add content! 

{code}
> cd /projects/Apache/struts-current/action2/webapps
> ant new
{code}

The Ant buildfile will prompt you for a the name of your new application.

h3. Setting up from Scratch

If for some reason the blank template doesn't work for you, it's not so hard to setup a SAF-based application from scratch.

h4. Structure of your web application

* Setup a file structure for your application. 

{code}
/mywebapp/
/mywebapp/template/
/mywebapp/META-INF/
/mywebapp/WEB-INF/
/mywebapp/WEB-INF/classes/
/mywebapp/WEB-INF/lib/
/mywebapp/WEB-INF/lib/CORE&OPTIONAL *.jar
/mywebapp/WEB-INF/web.xml

Before WebWork 2.2, the builtin Dependency Injection (IoC) container was default. Since Spring has been found to do this job better, the container integrated in WebWork / XWork was deprecated. If you would like to follow our recommendation to use Spring as the default IoC container, please make sure to include all jars found in lib/spring in the WEB-INF/lib directory of your application.

{code:title=action.xml}
<!DOCTYPE xwork PUBLIC "-//OpenSymphony Group//XWork 1.1.1//EN"
"http://www.opensymphony.com/xwork/xwork-1.1.1.dtd">

<xwork>
	<!-- Include webworkframework defaults (from Struts WebWorkAction JAR). -->
	<include file="webworkaction-default.xml" />

	<!-- Configuration for the default package. -->
	<package name="default" extends="webworkaction-default">
	</package>
</xwork>