In light of this thread on cocoon-docs, I decided to look into reorganizing the current doc structure. Following is a proposed TOC which I managed to make on my own. -- TonyCollen.
There is also the proposed TOC which is also gives some good ideas as to how the docs could be organized.
This page will be the current workspace for organizing the documentation.
An alternative, somewhat similar, documentation outline is given in the [CocoonBlueBook].
The Cocoon Manual
(c) 1999-2003 Apache Software Foundation
Table of Contents
Preface
Getting Started
- Intro / Short History / Overview
- Installation
- Installing a Binary Release
- Installing From Source
build.sh|bat
- *Build Targets
Customizing w/Blocks (blocks.properties)
*Note about copying blocks.properties to local.blocks.properties
Build-time Configuration (build.properties)
*Note about copying build.properties to local.build.properties
- *exclude.webapp.documentation
- *exclude.webapp.javadocs
- *exclude.webapp.idldocs
- *exclude.webapp.scratchpad
- *exclude.webapp.samples
- *exclude.scratchpad
- *exclude.deprecated
- *exclude.javadocs
- *exclude.idldocs
- *validate.config
- *validate.xdocs
- *Build Directory Settings
- Configuring Cocoon
- Cocoon.xconf
- Logging Levels
- Etc
- Security Concerns
Component Reference
This section will not have any "How-To" or Tutorial type material; it must be 100% reference material. How the components work (quickly explained) and any configuration parameters they might need. We also need to take into consideration how we want Blocks to be documented. -- TonyCollen
- Actions
ClearCacheAction
ClearPersistentStoreAction
FormValidatorAction
HelloAction
HttpHeaderAction
LocaleAction
RequestParamAction
RequestParameterExistsAction
ResourceExistsAction
ServerPagesAction
SessionInvalidatorAction
SessionIsValidAction
SessionPropagatorAction
SessionStateAction
SessionValidatorAction
SetCharacterEncodingAction
- Authentication
- Generators
DirectoryGenerator
FileGenerator
ImageDirectoryGenerator
LinkStatusGenerator
RequestGenerator
ServerPagesGenerator
ServletGenerator
StatusGenerator
StreamGenerator
WebServiceProxyGenerator
- Flow Layer
- Function Reference
sendPageAndWait()
sendPageAndContinue()
- Function Reference
- Logicsheets
- Matchers
- Modules (Input / Output)
- Readers
- Selectors
- Serializers
- Sitemap Elements
map:components
map:generators
map:transformers
map:serializers
map:readers
map:selectors
map:actions
map:pipes
map:views
map:action-sets
map:resources
map:pipelines
map:global-configurations
*global-variables
map:pipeline
*map:match
*map:generate
*map:transform
*map:serialize
*map:aggregate
**map:part
*map:call
*map:read
*map:act
*map:handle-errors
- Transformers
- XMLForms
Debugging Cocoon
- Components
- Flow
- Sitemap
- XSLT
Extending Cocoon
- Custom Components
- Actions
- Generators
- Matchers
- Readers
- Selectors
- Serializers
- Transformers
- Connecting Cocoon to a Database
- Other Avalon Components
- Custom Blocks
How-Tos / Tutorials
Any articles (Such as the current WebServiceProxyGenerator docs) regarding how to accomplish a specific task will be put here. No reference material here!! There is lots of material in the current docs under "User Guide", as well as "Dev Guide", "FAQs" and "Tutorials" that can all be consolidated under this section. -- TonyCollen
Resources
- Bug Database
- FAQ
- Mail List Archives
- Mail Lists
- cocoon-users
- cocoon-dev
- cocoon-docs
- Getting Cocoon
- CVS
- Mirrors
- Nightly Builds
- Releases
- Binary
- Source
- Installing Cocoon
- Build Problems
Appendix
- Cocoon Community Bylaws
- Extensive History of Cocoon
- Hosting Services
- Links about Cocoon
- Livesites
- Migrating from Cocoon 1 to Cocoon 2
- TODO