Re: GNUe documentation

Having spent a considerable amount of time recently with TurboGears  
(www.turbogears.org) I would like to suggest creating a screencast  
for the following:

1. Installation and configuration (20 min)
2. Creating a 2-tier Hello World app on steroids (20 min).  Meaning  
something like a address book.
3. Creating a 3-tier Hello World app on steriods (20 min).  Probably  
the same as No. 2.

It is really easier to learn from a screencast than from a manual.   
It may even take less time. Screecasts also seem to have driven some  
of the popularity of Ruby on Rails.

You might also consider creating on-line tutorials for No. 2 and No. 3.

I believe today people want to get a quick introduction and walk  
through before they commit to learning the guts from the manuals. Of  
course you still need the manuals, and with a screencast you will  
have more people asking for the manuals.  But this would make it  
easier for beginners to get started.

Neil


On Oct 24, 2006, at 9:19 AM, James Thompson wrote:

> I'm going to make an attempt at correcting our documentation  
> problem.  Via
> discussions in IRC we've tenatively decided on 2 main guides to the  
> project.
> A complete reference and a learning guide.  The first to be built  
> will be the
> complete reference which will then provide source material used to  
> build a
> learning guide.
>
> The plan is to.....
>   develop a basic outline of the complete guide
>   merge in all the existing tools documenation
>   delete all the original docs after they are merged
>   expand and complete the missing sections
>
> Below is a still incomplete stab at an outline for the complete  
> guide.  I'd
> appreciate any input or suggestions on extending or improving it.
>
> Thanks
> James
>
> Table of Contents
>
> Introduction
>
> How to use this Guide
>     - Interested in 2 tier
>     - Interested in 3 tier
>     - Interested in building custom apps upon GNUe
>
> Part : The GNU Enterprise Project
> 	Chapter : Overview
> 	Chapter : GNUe Component Description
>
> Part : The GNUe Framework
>         Chapter : Overview
>                 2 tier vs 3 tier
>
>         Chapter : Configuration
>                     - connections.conf
>                     - gnue.conf
>
> 	Chapter : GNUe Appserver
> 		 Overview
> 			- Invoking
> 		 XML Reference
>                  Configuration Options
> 		
> 	Chapter : GNUe Navigator
> 		 Overview
> 			- Invoking
> 		 XML Reference
>                  Configuration Options
>
> 	Chapter : GNUe Common
> 		 Overview
> 		 Application Framework
> 		 Datasources
> 		 Parser
> 		 Triggers
> 		 Events
>                  Miscellaneous
>                  Configuration Options
>                  API Reference
>         Miscellaneous Utilities
>             GNUe Schema
>                 - Overview
>                 - Invoking
>                 - XML Schema
>
> Part : Development Tools
> 	Chapter : GNUe Forms
> 		 Overview
> 			- Invoking
> 		 Anatomy of a Form
> 			- The object tree
> 		 Widgets
> 		 Parameters
> 		 Triggers
> 		 Libraries
>                  Configuration Options
> 		 XML Reference
> 	
> 	Chapter : GNUe Reports
> 		 Overview
> 			- Invoking
> 		 Anatomy of a Report
> 			- The object tree
> 		 Widgets
> 		 Parameters
> 		 Triggers
> 		 Libraries
>                  Configuration Options
> 		 XML Reference
> 	
> 	Chapter : GNUe Designer
> 		 Overview
> 			- Invoking
> 		 Wizards
> 		 Common Tools
> 			- Property Editor
> 			- Document Tree
> 			- Trigger Editor
> 		 Designing Forms
> 		 Designing Reports
>                  Configuration Options
> 		
>
> Part : A Complete Example
>         Overview
>         Configuration
>         Appserver Section
>         Forms Section
>         Reports Section
>         Navigator Section
>
> Appendix : Installation
>     - Basic Source Install Unix
>         - Windows Notes
>     - Developer Install
>         - Windows Notes
>
> Index
>
>
> _______________________________________________
> Gnue mailing list
> [email protected]
> http://lists.gnu.org/mailman/listinfo/gnue