[Openposs-cvs-commits] CVS: Documents OPRFC005.txt,NONE,1.1

[<ope...@li...>]

Update of /cvsroot/openposs/Documents
In directory usw-pr-cvs1:/tmp/cvs-serv28855

Added Files:
	OPRFC005.txt 
Log Message:
Initial Addition.

--- NEW FILE: OPRFC005.txt ---
Filename: OPRFC005.txt
Author  : Brian A Cheeseman <bc...@bc...>
Date    : June 27, 2002
Purpose : This document will describe the API's and directory structures 
          utilized as part of the openPOS System.
Status  : Open for discussion.

Contents
~~~~~~~~

	i  -  Prelude
	1  -  Server Directory Structure
	2  -  Directory Purpose Descriptions

	
i - Prelude
~~~~~~~~~~~
	This document will describe the directory structure of the Server and API 
for the openPOS System. It will be a work inprogress throughout the development
cycle of the project, however will be made into a standard each time a new 
release is made available to the public.


1 - Server Directory Structure
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    - Server/
        |
        +- admin/
		|    |
		|    +- Admin/
		|    |    |
		|    |    +- module.php
		|    |    :
		|    | 
		|    +- UserAdmin/
		|    |    |
		|    |    +- module.php
		|    |    :
		|    |
		|    +- ModuleAdmin/
		|    |    |
		|    |    +- module.php
		|    |    :
		|    :
		|    +- index.php
		|    :
		|
		+- adodb/
		|    |
		|    :
		|
		+- java/
		|    |
		|    :
		|
		+- language/
		|    |
		|    +- eng/
		|    |    |
		|    |    +- global.php
		|    |    :
		|    |
		|    +- deu/
		|    |    |
		|    |    +- global.php
		|    |    :
		|    :
		|
		+- module/
		|    |
		|    +- Transaction/
		|    |    |
		|    |    +- module.php
		|    |    +- admin.php
		|    |    :
		|    |    
		|    +- Quote/
		|    |    |
		|    |    +- module.php
		|    |    +- admin.php
		|    |    :
		|    |   
		|    +- Customer/
		|    |    |
		|    |    +- module.php
		|    |    +- admin.php
		|    |    :
		|    :
		|
		+- reports/
		|    |
		|    +- Low_Stock/
		|    |    |
		|    |    +- report.php
		|    |    :
		|    :
		|
		+- theme/
		     |
		     +- Default/
		     |    |
		     |    +- theme.php
		     |    +- theme.css
		     |    :
		     :
		 
		 
2 - Directory Purpose Descriptions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

/Server/
	This directory is the root of the directory structure for the openPOS 
System server. It contains the API's for the server, and also holds the initial
configuration to get the server connected to the database containing all data
for the system as well as the configuration data.

/Server/admin/
	This directory holds the directories containing the administration and
configuration modules. 

/Server/admin/Admin/
	This directory contains the php files for the top level of the administration
capabilities within the openPOS system. Once coded, the end-user will have no 
need to change anything within these files. The files in this directory will 
basically provide a menu to the other admin modules within the /Server/admin/
directory structure.

/Server/admin/UserAdmin/
	This directory provides the User Administration module for the openPOS 
System. This will be all of the user management and will also provide links
back to the main administration module listed above.

/Server/admin/ModuleAdmin/
	This directory provides the module administration capabilities for the
openPOS System. This will include the installation/de-installation, enabling 
and disabling of modules.