Page History

 :)

h2. Vítor Souza's Suggestions

h3. Documentation:

One-paragraph description of what is WebWork. And then, an explanation of how the documentation is divided:

??If you're new to WebWork, please read the *Overview* and proceed to the *Tutorial* to get started. Experienced users can refer to the *Cookbook* for advanced topics. Use the *Reference* on an as-needed basis for more specific details. For detailed information about WebWork project, read the section *Project Information*. Information about many projects related to WebWork can be found in *Related

 Projects*??

??If you have any questions, you can ask them at the user forum/mailing list. Please be sure to read the *FAQ* before asking any questions.??

# Overview
# Project Information
# FAQ
# Tutorial
# Cookbook
# Reference
# Related Projects

_(details on each of the above follows)_

h4. Overview
# What is WebWork
# Comparison to Struts (Tapestry, VRaptor, JSF, etc.?)
# WebWork community
	#* Mailing lists / Forum
	#* Bug tracker
	#* Wiki
	#* How to contribute?
# Articles and press about WebWork
# Projects using WebWork / Testimonials

h4. Project Information
# License
# Deployment notes
# WebWork versions
	#* Current release
	#* Previous releases
	#* Migrating from WebWork 1.x;
# Dependencies

h4. FAQ
# Category 1
# Category 2
# Etc.

h4. Tutorial
# Downloading and installing WebWork
# Setting up the test environment (to test tutorial source code)
# Basic configuration and your first action (Hello WebWorld)
# Understanding actions _(includes note on getting date using Scriptlets)_
# Understanding results
# Meet WebWork tag library _(would also explain a little bit of ONGL)_
# Evaluating other view options: Velocity
# Evaluating other view options: FreeMarker
# Understanding interceptors
# Performing validation
# Performing dependency injection (IoC) through components
# Going i18n (internationalization)

h4. Cookbook
* Tips and tricks on Application Servers _(this was in "Overview")_
* Accessing application, session and request objects;
* How to format dates and numbers;
* Other stuff from the revised [Cookbook]...

_All the tips in the [Cookbook] should be revised. Some of them could belong to the tutorial instead (basic stuff). 3rd party integration tips could be separated from the rest._

_Also, it would be good if all of them also followed the same structure, kind of like a tutorial lesson, but on advanced topics. The differences between the Tutorial and the Cookbook would be:_

|| || Tutorial || Cookbook ||
| User level required: | Begginner | Intermediate |
| Availability of Source code: | In the documentation and in the {src} folder of the distribution (ready for deploy and test). | Only in the documentation, and may not be _complete_. |
| Should be read in sequence? | Yes. | No. |

h4. Reference
_I like Jay Bose's reference TOC (below). On top of it, I'd suggest:_

(-) Remove "What is WebWork" and "Getting Started/Deployment Notes";

(+) Replace them with "Introduction", in which there would be instructions to read the Overview first and proceed to the tutorial if the reader wants to get started;

(+) Append "/ Dependency Injection" to "IoC", because some people may know it only by the name "Dependency Injection";

(on) Group "JSP & Velocity Tags" with "WebWork Freemarker Support" to create a single section that contains everything related to user interface (in subsections);

(-) "JSP Expression Language Comparison with WebWork 1.x" should be in "Migrating from WebWork 1.x", in the "Project Information" section;

(+) Add to that same UI topic: JavaScript validation and DWR support (is this in 2.2?);

(-) WebFlow would be in "Related Projects";

(on) Have "3rd Party Integration" be links to Cookbook pages that explain how to integrate with SiteMesh, Spring, Pico, Hibernate, JUnit, Quartz, etc.

h4. Related Projects
# WebFlow (graphical chart tool)
# EclipseWork (Eclipse Plugin)
# IDEA Plugin
# WebWork Optional
# Etc. ?



h2. Jay Bose's Suggestions

h4. Suggested standalone documents (that may be viewed as single html, multiple html chapters, or PDF):
* Reference manual
* Tutorial

h4. Suggested wiki sections/pages:
* FAQ
* License 
* Cookbook
* Webwork Community
* Webwork versions
* Articles about Webwork
* Projects using Webwork
* Comparison to Struts


h4. Suggested Reference TOC:
# What is Webwork -- also explain what Webwork is not.
# Architecture
# Getting Started/Deployment Notes
# Configuration
# Interceptors
# Action Chaining
# IOC
# JSP & Velocity Tags -- this would be the current tag information, combined with the current "JSP Expression Language Comparison with Webwork 1.x" pages
# Webwork Freemarker Support 
# Result Types 
# Type Conversion 
# Validation 
# OGNL 
# Internationalization 
# Webflow
# 3rd Party Integration

The tutorial TOC/flow could come from whatever Patrick's example app already has.