# gnue/packages/README - Describes the packages dir structure.
#                  
# Copyright (C) 2001 Free Software Foundation, Inc.
#
# This file is part of GNU Enterprise.
#
# This file originally written by Neil Tiffin (neilt@gnue.org).
#
# $Id: README,v 1.9 2001/12/01 03:48:43 ntiffin Exp $
#

packages Directory
=====================
This directory contains the various files used to configure GNUe to
perform as enterprise software.

See note below for converting .geas files to .sql.  All *.geas.py files
are loaded as class methods (business rules).  If you don't wish
this to happen don't put *.geas.py files in this directory tree. Simply
calling a file *.py should not cause a problem as geas now checks for
the file name to end with ".geas.py".

Directory Structure
===================
                   
packages/"package-name"/"module-name" - generic format for packages.
                   "package-name = the functional package (i.e. finance,
                   base, supply-chain, etc.)
                   
packages/"template-name"/"module-name" - generic format for templates.

For Example:

packages/base/"module-name" - contains all of the module definitions for 
                   the base gnue enterprise system.  This includes all
                   module definitions that are common to other packages.
                   
packages/base/package-doc - folder contains the docbook format
                   for the base package documentation.

packages/supply-chain/"module-name" - contains all of the module definitions
                   that pertain to the supply chain package.              

packages/supply-chain/package-doc - folder contains the docbook format
                   for the supply chain package documentation.

                   
Each module-name folder contains the following folders:
    methods - directory for method files.  All *.geas.py files are loaded
               into GEAS if python methods are selected.
    reports - contains report definitions (.grd)
    forms - contains form definitions (.gfd)
    classes - contains class (business object) definitions (.gcd)
    defaults - sql or other initialization scripts etc.  Note that
               file types of .geas are almost SQL files, suitable for
               use in documentation.  If you you want real .sql files
               to load an SQL database then run
               geas/tools/parse_load_sql.py to convert .geas to .sql
    doc - the module documention files in docbook format.