[Openposs-cvs-commits] CVS: Documents OPRFC005.txt,1.2,1.3

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

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

Modified Files:
	OPRFC005.txt 
Log Message:

Added directory structure for documentation


Index: OPRFC005.txt
===================================================================
RCS file: /cvsroot/openposs/Documents/OPRFC005.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** OPRFC005.txt	27 Jun 2002 05:28:41 -0000	1.2
--- OPRFC005.txt	28 Jun 2002 02:03:40 -0000	1.3
***************
*** 1,172 ****
! 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
! 	1.1  -  Directory Purpose Descriptions
! 	2    -  API Reference
! 	2.1  -  Database API
! 	3    -  Module Interface API
! 
! 	
! 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
! 		     |    :
! 		     :
! 		 
! 		 
! 1.1 - 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.
! 		
! /Server/adodb/
! 	This directory contains the adodb library as found at 
! http://php.weblogs.com/ADODB. This is our access methof to the database, and
! it also will allow us to connect to multiple different database backends.
! 
! /Server/java/
! 	This directory will hold any java programs utilised by the web-based front
! end of the project. However for java programs that are module specific, they
! will be stored in the appropriate directory for the module in question.
! 
! /Server/language/
! 	This directory holds a directory for each language that the system has been
! configured to use.
! 
! /Server/language/enu/
! 	This directory holds the files which contain the language specific strings
! that are used in the display of information within the openPOS System.
! 
! /Server/module/
! 	This directory holds a directory for each user module installed in the 
! openPOS System. 
! 
! /Server/module/ModuleName/
! 	This directory will contain all the files relating to the module ModuleName.
! 
! /Server/reports/
! 	This directory holds a directory for each report installed in the openPOS
! System.
! 
! /Server/reports/ReportName/
! 	This directory will contain all the files relating to the report ReportName.
--- 1,219 ----
! 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
! 	1.1  -  Directory Purpose Descriptions
! 	2    -  API Reference
! 	2.1  -  Database API
! 	3    -  Module Interface API
! 
! 
! 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/
! 	|       |
! 	|       :
! 	|
! 	+- docs/
!         |      |
!         |      +- install/
!         |      |         |
!         |      |         +- apache.html
!         |      |         +- index.html
!         |      |         +- mysql.html
!         |      |         +- openposs.html
!         |      |         +- oracle.html
!         |      |         +- php.html
!         |      |         +- postgresql.html
!         |      |         :
! 	|      |
!         |      +- manual/
!         |      |         |
!         |      |         +- index.html
!         |      |         :
! 	|      |
!         |      +- upgrade/
!         |      |         |
!         |      |         +- index.html
!         |      |         :
! 	|      :
!         |
! 	+- 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
! 	|     	|    :
! 	|     	:
! 	|
! 	:
! 
! 1.1 - 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.
! 
! /Server/adodb/
! 	This directory contains the adodb library as found at
! http://php.weblogs.com/ADODB. This is our access methof to the database, and
! it also will allow us to connect to multiple different database backends.
! 
! /Server/docs/
! 	This directory holds the directoris containing the documentation for the
! OpenPOS System.  It is noted that the exact form of this directory is not yet
! finalized and should change considerably between now and the version 0.1 release.
! 
! /Server/docs/install
! 	This directory contains all documents relative to preparing a system for
! the installation of the OpenPOS System as well as installation itself.  Due to
! the nature of our system, we shall provide documentation to help guide the user
! through setup of key components, such as PHP, a web server, and a database server.
! The most common combonations will be covered.
! 
! /Server/docs/manual
! 	This directory contains the extensive online documenation to be used by
! the user while using the OpenPOS System.  Think "Windows Help Pages" that actually
! help.
! 
! /Server/docs/upgrade
! 	This directory contains documentation on upgrading the OpenPOS system from \
! a previous release.
! 
! /Server/java/
! 	This directory will hold any java programs utilised by the web-based front
! end of the project. However for java programs that are module specific, they
! will be stored in the appropriate directory for the module in question.
! 
! /Server/language/
! 	This directory holds a directory for each language that the system has been
! configured to use.
! 
! /Server/language/enu/
! 	This directory holds the files which contain the language specific strings
! that are used in the display of information within the openPOS System.
! 
! /Server/module/
! 	This directory holds a directory for each user module installed in the
! openPOS System.
! 
! /Server/module/ModuleName/
! 	This directory will contain all the files relating to the module ModuleName.
! 
! /Server/reports/
! 	This directory holds a directory for each report installed in the openPOS
! System.
! 
! /Server/reports/ReportName/
! 	This directory will contain all the files relating to the report ReportName.