See also CocoonDocsDrafts for "rules" about how to work on this document.

Documentation tracks?

We'd like to add tracks to the existing documentation on the Cocoon web site, to help users interested in specific parts of Cocoon to get up to speed.

The idea of a track is to provide a reading list (links to pages, technically) of documents that one should study to get up to speed on specific parts of Cocoon. The track itself will not contain any content, only point to existing content.

The main goal is to answer questions like "what documentation should I study, and in which order, to go from zero to being able to publish the results of database queries in PDF format?".

A secondary, but important goal is to show which documentation is available: tracks that have only a title but little content will show that information is still scarce in this area.

Help Wanted!

You might be a Master of one of the areas listed in the tracks plan below, or maybe you studied a specific Cocoon feature recently and would like to complete the plan? Please do!

See the About page if you're unsure about how to edit this page.

Also, make sure that the left part of this page displays "You are: <your name>" before editing this page, and if not set your name in UserPreferences. This is very helpful as it allows the Wiki to keep track of who wrote what.

Thanks for your contributions!

Tracks - the plan

This is very rough for now - feel free to add sections and/or complete their contents. You can also use footnotes #1 to enter comments.

Track: General information

Done in the CVS docs ("First steps" track).

Track: HTML publishing

Done in the CVS docs ("Web Publishing" track).

Track: PDF and RTF publishing

Done in the CVS docs ("Web Publishing" track).

Track: SQL Database Connectivity

  1. Database Access -- An excellent overview. 1.# Configure -- Before accessing your database, you must configure it as a Cocoon datasource. 1.## Install and Configure a Datasource -- Learn how to add a new datasource to Cocoon. 1.## SpecificDatabaseConnection and SpecificDatabaseConnectionNew #2 -- Learn the gory details of connecting your favorite database software to Cocoon. JDBC drivers, JDBC class names, and connection strings. 1.# Query -- Choose from three different query approaches: 1.## Database Actions 1.## ESQL Taglib 1.## SQL Transformer

Track: XML databases with Xindice

Track: Form Handling and Validation

As with the database track, there are multiple approaches to choose from.

  1. FormValidatorAction -- A fairly simple approach to form validation. Requires little or no custom Java code. Could be bad for complex multi-page forms. 1.# Official docs 1.# FormValidationUsingCocoon -- wiki docs for the action 1.# XSPFormValidator -- wiki docs for the companion logicsheet 1.# SimpleFormTransformer -- An alternative to the logicsheet. The official docs do not adequately describe this transformer.

  2. XMLForm -- A powerful (but complex) approach to form validation. Requires extensive Java code to be written for each form. Good for complicated multi-page form wizards, but overkill for simpler forms.

    1.# Official docs 1.# XMLForm wizard

  3. Woody -- A new approach to form validation that does not seem to require Java code to be written. Only documented in the wiki.

Track: Flow

Track: Embedding Cocoon

I'm just throwing this out as a candidate. I want to be able to use Cocoon pipelines from within my own application, rather than embedding it in a web server. I'm not even sure where to start looking, though. -- ScottBrickner

Add another title above this if you have an idea for another track!

like this example footnote
These wiki pages need some major work. When finished, they need to be added to the main cocoon docs.
This document states that JFOR cannot be included within Cocoon. It is now included within Cocoon 2.1. Upayavira

DocumentationTracksProject (last edited 2009-09-20 23:42:09 by localhost)