06-15-2005 TOC Homework

Create a section with your name and write your suggestions on the Table of Contents (TOC). Let's wiki this!

Vítor Souza's Suggestions

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.

1. Overview
2. Project Information
3. FAQ
4. Tutorial
5. Cookbook
6. Reference
7. Related Projects

(details on each of the above follows)

Overview

1. What is WebWork
2. Comparison to Struts (Tapestry, VRaptor, JSF, etc.?)
3. WebWork community
   • Mailing lists / Forum
   • Bug tracker
   • Wiki
   • How to contribute?
4. Articles and press about WebWork
5. Projects using WebWork / Testimonials

Project Information

1. License
2. Deployment notes
3. WebWork versions
   • Current release
   • Previous releases
   • Migrating from WebWork 1.x;
4. Dependencies

FAQ

1. Category 1
2. Category 2
3. Etc.

Tutorial

1. Downloading and installing WebWork
2. Setting up the test environment (to test tutorial source code)
3. Basic configuration and your first action (Hello WebWorld)
4. Understanding actions (includes note on displaying data using Scriptlets)
5. Understanding results
6. Meet WebWork tag library (would also explain a little bit of ONGL)
7. Evaluating other view options: Velocity
8. Evaluating other view options: FreeMarker
9. Understanding interceptors
10. Performing validation
11. Performing dependency injection (IoC) through components
12. Going i18n (internationalization)

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:

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";

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";

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

Related Projects

1. WebFlow (graphical chart tool)
2. EclipseWork (Eclipse Plugin)
3. IDEA Plugin
4. WebWork Optional
5. Etc. ?

Jay Bose's Suggestions

Suggested standalone documents (that may be viewed as single html, multiple html chapters, or PDF):

• Reference manual
• Tutorial

Suggested wiki sections/pages:

• FAQ
• License
• Cookbook
• Webwork Community
• Webwork versions
• Articles about Webwork
• Projects using Webwork
• Comparison to Struts

Suggested Reference TOC:

1. What is Webwork – also explain what Webwork is not.
2. Architecture
3. Getting Started/Deployment Notes
4. Configuration
5. Interceptors
6. Action Chaining
7. IOC
8. JSP & Velocity Tags – this would be the current tag information, combined with the current "JSP Expression Language Comparison with Webwork 1.x" pages
9. Webwork Freemarker Support
10. Result Types
11. Type Conversion
12. Validation
13. OGNL
14. Internationalization
15. Webflow
16. 3rd Party Integration

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