cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From d...@cocoon.apache.org
Subject [Cocoon Wiki] New: CocoonBlueBook
Date Tue, 23 Nov 2004 06:37:52 GMT
   Date: 2004-11-22T22:37:52
   Editor: DerekLastname <dhohls@csir.co.za>
   Wiki: Cocoon Wiki
   Page: CocoonBlueBook
   URL: http://wiki.apache.org/cocoon/CocoonBlueBook

   Draft 1

New Page:

The Cocoon "Blue Book"

== Concept ==

The "Blue Book" is the working title for the Cocoon documentation project, run by the documentation
'task team'.  Its aim is to ensure a comprehensive and up-to-date set of documents that will
describe ''all'' aspects of Cocoon.  The "Blue Book" will be avaialable on-line, and be downloadable
by whole, by part or by chapter.  In development, the "Blue Book" will not 'reinvent the wheel',
but will draw on existing offical docs, wiki pages, and past mailing list Q&A as its basis.


There are some aspects, related to the Cocoon Project, that are not addressed...

* Whats New
* Future Plans
* Latest FAQ (key FAQ will be taken up into an appropriate section of the Blue Book)


= Part I:  General =

Part I is meant to be the  most 'readable' of all the sections; with well-written text, aimed
especially at the newer user and those coming to Cocoon from other 'systems' (PHP, JSP, Struts,
.NET?).  Emphasis will be on the scope of Cocoon's built-in, or readily available, functionality.
 This section will ''always'' be kept in-sync with the latest, downloadable version.

== Why Cocoon: The Business Case ==

== Quick Install: Get Going ==

== Whirlwhind Tour: Major Concept and Features ==

== Learning Curve: Newbie Guide ==

== Best Practices ==
* Design
* Build
* Debug
* Deploy
* Tools

== Extending Cocoon ==
* Customizing
* Component Writing

== Welcome to the Family: Related Applications ==
* Lucene
* FINS
* Geoid
* Lenya

== Outside the Sandbox ==

== Beyond the Blue Book ==
* Mailing List
* Wiki
* API (JavaDocs)


= Part II: Use Cases =

'Uses Cases' are part examples, part tutorials; aimed at demonstrating the application of
Cocoon to meet real-world needs, and integrating aspects of the samples into more cohesive
and complete 'demos' (that can only be used by prospective adopters to support their business
case...).

* Documentation Server
* "General Purpose" Interactive Website
* Database Front-end
* Pet Store
* Photo Album
* Web Portal
* Web Services Framework
* Discussion Forums


= Part III: Technical Reference =

(The bulk of this part of the Blue Book is made up from existing on-line documentation; aspects
of which will also be absorbed in Part I)


= Part IV: Appendices =

== Detailed Installation Guide ==
* System Requirements
* Building: Ant and Blocks
* Common Problems
** Headless Unix
** FEE (frequently encountered errors)

== Notes for Cocoon Samples ==

== Jargon ==

== A Brief History of Cocoon ==

== Cocoon Releases ==
* Release x.x
** Major Features
** Key Changes
** Areas Deprecated

Mime
View raw message