GNUe documentation

James Thompson <[email protected]> Tue, 24 Oct 2006 09:19:45 -0500
Newsgroups gmane.comp.gnu.enterprise.general
Message-ID <[email protected]>
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