add a 'makePath' method to Diogenes_Barrel
[diogenes.git] / README
... / ...
CommitLineData
1Notes for Diogenes
2
3PRESENTATION
4------------
5
6Diogenes is a content management system that allows you to quickly create and
7host web sites for communities. It was written by the Polytechnique.org
8team. More information can be found on the Diogenes project page :
9
10 http://opensource.polytechnique.org/diogenes/
11
12It is released under the terms of the GNU Public License (GPL) version 2. The
13full text of this license can be found in the COPYING file included in this
14distribution.
15
16
17DOCUMENTATION & INSTALLATION
18----------------------------
19
20The documentation for Diogenes, including installation instructions can
21be found here:
22
23 http://doc.polytechnique.org/diogenes/
24
25
26CUSTOMISING DIOGENES
27--------------------
28
29Diogenes provides several means of customising its look and behaviour.
30
31 * CONFIGURATION FILE
32
33The first thing you can modify is Diogenes's configuration file called
34"diogenes.config.inc.php". To have a list of the values you can assign, take a
35look at the file called "diogenes.globals.inc.php".
36
37 * SUBCLASSING DIOGENES'S CLASSES
38
39Diogenes is written in Object-Oriented Programming (OOP), and it is possible to
40specify the classes to use from the configuration file. For instance, if you
41want to change the look and/or behaviour of Diogenes's toplevel pages you would :
42
43- create a class called "CustomToplevel" for instance, which derives from
44 "DiogenesToplevel". Let us say this class is stored in a file called
45 "custom.toplevel.inc.php".
46
47- include "custom.toplevel.inc.php" from your configuration file like this :
48
49 require_once 'custom.toplevel.inc.php';
50
51- tell Diogenes to use your CustomToplevel class to display toplevel pages by
52 setting the following in your configuration file :
53
54 $globals->toplevel = "CustomToplevel";
55
56