Changeset 214 for trunk/docs/file_layout.txt

Timestamp:

Dec 12, 2006 12:28:01 AM (17 years ago)

Author:

quinn

Message:

Q - Final check-in before releasing trunk as version 2.1

File:

• trunk/docs/file_layout.txt (modified) (6 diffs)

trunk/docs/file_layout.txt

@@ -1 @@
-Updated: 26 Aug 2005 14:37:42
-
-======================================================================================
-Codebase can be located anywhere, as long as it is in the application's include path.
-======================================================================================
+Updated: 11 Dec 2006 16:25:10
+=====================================================================
 
 codebase/
-    bin/
-        (generic command-line scripts and applications)
+    bin/ (generic command-line scripts and applications)
+        acl.cli.php (Tool for managing the permissions of an ACL.inc.php based system)
+        extract_gettext.pl (tool for exporting all the strings called by the _("Gettext function") )
         file_importer.php
         install.sh
-        pedit_permissions.sh
         module_maker/ (scripts for generating modules)
             _config.inc.php
@@ -16 +13 @@
             list_template.cli.php
             module.cli.php
-            skel/
-                (templates for generating modules)
+            skel/ (templates for generating modules)
                 adm_form.ihtml
                 adm_list.ihtml
@@ -26 +22 @@
             sql.cli.php
             validation.cli.php
+        pedit_permissions.sh
+    css/ (generic CSS files to be included using lib/CSS.inc.php)
+        admin.inc.css (CSS for the generic Strangecode administration system)
+        codebase.inc.css (CSS for html output by codebase libraries)
+        utilities.inc.css (generic CSS tools)
     docs/
-        codebase_script_template.php
         coding_standards.txt
+        example_config.inc.php (an example of the _config.inc.php site-boot document)
+        example_script_template.php
         example_virtualhost_directive.txt
         file_layout.txt
-        software_licence.txt
-        todo.txt
+        gpl.txt
+        revision_history.txt
+        version.txt (the version number of this codebase)
     lib/
-        App.inc.php (functions dealing with sessions, href/url/IP manipulation, directories.)
-        Auth_File.inc.php (file-based authentication system.)
-        Auth_SQL.inc.php (sql-based authentication system.)
+        ACL.inc.php (provides Access Control List functionality)
+        App.inc.php (provides global application functionality: sessions, href/url/IP manipulation, directories)
+        Auth_File.inc.php (file-based authentication system)
+        Auth_SQL.inc.php (sql-based authentication system)
         AuthorizeNet.inc.php (routines for connection to authorize.net's advanced processing interface)
-        CSS.inc.php
-        DB.inc.php (database abstraction layer.)
-        DBSessionHandler.inc.php (database session handler.)
-        FormValidator.inc.php (validation routines used to test incoming user data.)
+        Cache.inc.php (provides session-based caching functionality for quick retreival of all PHP data types)
+        CSS.inc.php (manage and deliver CSS data)
+        DB.inc.php (minimal database abstraction layer)
+        DBSessionHandler.inc.php (database session handler)
+        Email.inc.php (provides email validation and sending functionality)
+        FormValidator.inc.php (validation routines used to test incoming user data)
         Google_API.inc.php (class for connecting to, querying, and dealing with data of the Google API)
-        ImageThumb.inc.php (automated image thumbnailing routines.)
+        Heirarchy.php (class for manipulation of heirarchies)
+        Image.inc.php (manage printing of images related to db records)
+        ImageThumb.inc.php (automated image thumbnailing routines)
+        Lock.inc.php (db record locking system)
         MCVE.inc.php
-        Nav.inc.php (navigation element management class))
-        NodeHeirarchy.php (class for manipulation of node heirarchies.)
+        Navigation.inc.php (navigation element management class))
         PageNumbers.inc.php (class for managing and printing various elements of page numbers and pagenation)
         PageSequence.inc.php (manage a sequence of steps and data from step form elements, like order checkout or signup)
@@ -52 +60 @@
         PEdit.inc.php (page-by-page file-based content management system)
         Prefs.inc.php (class for semi-permenent storage of values)
-        Lock.inc.php (db record locking system)
-        Version.inc.php (db record versioning system)
         ScriptTimer.inc.php (timer for scripts)
-        Cache.inc.php (class for accessing a cache in a users session, stores any variables for quick retreival)
         SortOrder.inc.php (class dealing with sorting of columns in database generated lists)
         SpellCheck.inc.php
-        TemplateGlue.inc.php (functions that generating html.)
-        Upload.inc.php (class that manages uploading of files.)
-        Utilities.inc.php (functions for general utility: setting defaults, num/string functions, etc.)
-    services/
-        (codebase scripts that are only useful when web accessible, i.e. to be used in a doc root)
+        TemplateGlue.inc.php (functions that generating html)
+        Upload.inc.php (class that manages uploading of files)
+        Utilities.inc.php (functions for general utility: setting defaults, num/string functions, etc)
+        Version.inc.php (db record versioning system)
+    services/ (codebase scripts that are only useful when web accessible, i.e. to be used in a doc root)
         admins.php
         css.php
@@ -71 +76 @@
         password.php
         phpinfo.php
-        templates
+        provides
+        templates/
         versions.php
+    tests/ (unit-based tests for all codebase libraries)
+
+===================================================================================
+Group of applications and related files, usually installed at /home/user/www.domain.com/
 
 
-======================================================================================
-Group of applications and related files, usually installed at /home/user/www.domain.com/
-======================================================================================
-
-global/
-    (global level configuration and libraries for a group of sites/apps)
+global/ (global level configuration and libraries for a group of sites/apps)
     config.inc.php (system-wide configuration)
     db_auth.inc.php (db-authentication for CLI scripts. chown'ed by user executing cron, NOT apache).
 
-docs/
-    (documents specific to a group of sites/apps)
-    tei_db.mysql (db schema)
+docs/ (documents specific to a group of sites/apps)
+    schema.mysql
 
-bin/
-    (global level command-line scripts)
+bin/ (global level command-line scripts)
 
-admin/
-    (DocumentRoot for the admin application)
+admin/ (DocumentRoot for the admin application)
     _config.inc.php
     _templates/ (templates used for the admin docroot)
@@ -107 +109 @@
     versions.php (manage db record versions)
 
-html/
-    (DocumentRoot of main site application)
-    _config.inc.php (configuration options and defaults specific to this site. included first in each script.)
+html/(DocumentRoot of main site application)
+    _config.inc.php (configuration options and defaults specific to this site. included first in each script)
     _templates/ (site specific templates. templates here override global codebase templates with same name)
     css.php (style sheets loader)