Location: PHPKode > projects > Aloys Core Framework > readme.txt
Read-me file for ALOYS CORE 0.1a1 06.05.2003 GK

0. PRE-REQUISITS

This is ALOYS CORE CMS distribution. Is needs :

PHP4
mySQL

Home web site : http://aloyscore.com
Download site : ftp://ftp.aloyscore.com/dl/

1. PREAMPLE

This is a pre-alpha release. So even if it works... this is most
given as a 'for reading' distribution.

The product is a framework, so the given modules are just here as
example, and more solid distribution will follow as the core is
in beta verion.

2. COMPONENTS

a. Core

The core is stored in the two folders : classes and widgets. 

Classes containts all the classes for environment, module dispatcher, 
datasource bases class, modules bases classes. Some of the files will
be transfered to the core CMS.

Widgets containts all the classes for datasource/template connection.

b. Core CMS

Most of the files of the core CMS are still now in the core. So 
following text is about what will be done on next stable version. 
They will be placed as a particular module from witch all modules 
will take CMS base functions. In fact Core CMS is not intended to be 
part of ALOYS CORE, as anybody can create his own CMS distribution. 
But it will be created as an example of such a distribution, and show 
how to create a standard distribution in aim to have distribution 
portable modules.

The module used as Core CMS is select by a constant so some CMS can 
be tested in parallel.

c. Base modules

This modules deal with core databases : variables, categories, users,
fields, widgets, groups, permissions. In fact, they are standard 
modules and you can without problem rewrite them. In fact they are just
basic tools, to deal with basic informations. Good user interface
should be better for a distributable version.

d. Modules

Whatever you want. I just wrote a little news system, basicly as 
test. A comment module will come with one of the next versions. This
to test inter-module connectivity.

e. Templates

For now only the TemplateHTML is implemented. Other template 
implementation is planned. But every one should implement his favourite
one. 

I put a little test template generaltheme. Code in the template is 
normally only for presentation. Some containt too much code, for example
general formular template of general table template. This is to be
improved.

The locations for templates are TEMPLATE_DIR/TEMPLATE_VAR/template.php
first, then if it doesn't exists MODULE_DIR/MODULE_NAME/templates/global.php.
It is planed that GENERAL_DIR/template.php will be although possible
for code templates or other site general thementes.

f. Main application

This, on the root, consist on three files.

Index.php. This is the main dispatcher, it only load configuration
generate environment and display the result of the Aloys object execution.
In fact you can have as many main php files as you want, for example
for multisite configuration.

Config.php. Here are defined the constants for DB access if any and
locations of all the elements of the CMS : classes, widget, modules,
templates, Core CMS name.

MyVariables.php. This is a derivation of the VariableSite class. Here
will be stored all the environment datasources. Base are _REQUEST,
_COOKIE and base variables language and Template. But you can add, 
user connection, modules variables, categories for ML texts and selections, 
fields names, widget definitions, LDAP, etc. All this possible sources will 
be in classes as VariablesXXX classes.

g. language

Multilibgual treatement is given in two ways, by categories tables or 
as constants. For the later solution, constant definition files are stored
in LANGUAGE_DIR/LANGUAGE_VAR/global.php for general language constants.
On module call MODULE_DIR/MODULE_NAME/lang/LANGUAGE_VAR/global.php is
loaded. Of cource files are loaded only if they exist.

h. database

An SQL file (database.sql) is given. tables are prefixed by accms_.
if you want to change the prefix, don't forget to change the _PRFX
constant in config.php.

3 INSTALLATION

There's no installation module now. I think I'll make a per-module
system for installing with database base config on all distribution
modules plus the core. This will make module distribution more modular.

So for now, just deploy the app under www directory in some place,
modify config.php file according to your database. Create the database
if needed. Change prefix un database.php if needed. send database.sql
in your BD.

Normally that's all.

On any problem you can go to the forum : 
http://forum.aloyscore.com.

4. DOCUMENTATION

There is not real programming documentation for now as the core is
still very instable and a lot of rewriting is still in process.

But you can get last version doc on :
http://doc.aloyscore.com/

For your particular version docs zip can be found in various format :
ftp://ftp.aloyscore.com/docu/

5. BUGS

There's still a lot of bugs, sometime mistakes or version changes
lost things, sometime conceptual lacks. Anyway, if you want to help
you can point out problems on the forum or in the bug tracking system :
http://bugs.aloyscore.com

Code moves a lot so little detail stuff like 'there's missing a space
on my screen' is not needed, but conceptual flaws, or wanted things
are welcome...

6. CVS

For now I lock devloppement to our little team. Until things are more 
stable. At this time i'll open a mailing list and CVS for interested 
poeple. But there's a lot of work for now on.

7. SECURITY

Niente. Appart a buggy login that doesn't do big things and is easyly
turned out, there's nothing. As a lot of the security issues will be
processed by modules and as we are still on the core, it's not an issue
now.

But on nexts versions the following task are on the way :

- Better user management
- Session handling
- Group management
- Access control management
- Inclusion in the core of access control and display control on these 
infos.

8. TODO

Too much to write it out here...
Return current item: Aloys Core Framework