This is where all Camas documentation will be collected.
At the moment, we use the same documenation format than
Caudium documentation eg. autodocs.
This documentation
is really far from complete, but developper's version is
in a big process of reorganization, so documentation
is growing, growing...
First you can look at the slide show given at the latest Caudium
conference. It describes the new Camas release.
It's available as a SXI (OpenOffice presentation).
CAMAS 1.0 design
Here is a little schematic which show modules interactions, camas
modular design and interaction between each modules.
Note that dashed-line modules presented here are "optional modules".
gif -
PDF -
PS / Gz -
xfig / Gz
Here is the modules interaction scheme for CAMAS 1.2. As you can see
more work has been put into more modular code and separation of HTML code
from Pike code.
PNG -
EPS / Gz -
Dia
Here is an example of the steps a typical user's request involves:
- The user HTTP request is first managed by the main module which does
some basics things like setting a user's session using 123session or
gsession in the near future. Then it calls the Actions modules.
If you have several Actions modules it will call them in the order
guessed for each module internal priority.
- The Actions module usually changes the user's session memory
according to the input URL and does some actions like launching the
IMAP or SMTP client.
If it is the login part the module also call one of the Auth module
to find the user name and surname as well as the IMAP server to use.
It also calls the user's preferences from one of the Preferences
modules. This module will fetch the user's preferences from low
storage to session memory.
If the Actions module has launched the IMAP client, this one calls
back the Main module. In any case Main is call after this module
and/or the IMAP client have finished.
- The layout Filesystem modules which have loaded the layout files
from a RXML file and some configuration options from a XML file at
startup are now called by the Layout Manager.
- The layout Manager choose the layout to use if the Default layout is
not the only layout using user or administrator choices and gives
the RXML data to the Camas tags module
- The Camas tags module now renders the RXML file to HTML data and
takes care of language conversion as well as image
generation using the formbuttons module. The screen used
by Camas tags depends on the values set from the previous call of the
Actions modules.
- The Camas entities module now render XML entities to simple text.
The entities, unlike Camas Tags, usually don't depend on the values
set by the Actions module(s) but by the content of the current
layout screen. This module also use the language module.
- If the user is reading an attachment or a HTML mail the HTML module
is called to display the attachment and optionnaly remove dangerous
HTML or other browser language thing.
- The Main module gets the HTML data and after a few more processing
and checks give it to the user browser.
