Doc Team Suggestions
Documentation Style
Click here for the suggestions on documentation style.
...
- 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 displaying data using Scriptlets)
- Understanding results
- Meet WebWork tag library (would also explain a little bit of OGNL)
- Evaluating other view options: Velocity
- Evaluating other view options: FreeMarker
- Understanding interceptors
- Performing validation
- Performing dependency injection (IoC) through components
- Going i18n (internationalization)
- Retrieving data without a full request using XHR/Ajax
This should be in conformance to Patrick's example app. Vitor will talk to Patrick to get his opinions on the sequence of lessons suggested above and how to make the tutorial conformant to the example app.
...
- Tips and tricks on Application Servers (this was in "Overview")
- Stuff from the current 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:
...
A question that arised in the TOC discussion was: what's the difference between the Cookbook and the FAQ? Well, some of the items in the Cookbook are also FAQs (people ask about them a lot), so they would also be included in the FAQ, with links to the Cookbook. The FAQ should have quick answers or link to longer answers, such as the Cookbook. The Cookbook is tutorial-style, a collection of mini HOW-TOs.
Reference
- Introduction – This will have parts of Overview in it, rather than forwarding them to Overview altogether.
- Architecture
- Configuration
- Interceptors
- Action Chaining
- IOC / Dependency Injection
- UI Components - JSP, Velocity, Freemarker, JavaScript validation and DWR support
- Result Types
- Type Conversion
- Validation
- OGNL / Object Graph Navigation Language
- Internationalization
- 3rd Party Integration - Sitemesh, Spring, Pico, Hibernate, JUnit, Quartz, etc.
...