projects / diogenes.git / blame
| Commit | Line | Data |
|---|---|---|
| 6855525e JL |
1 | Notes for Diogenes |
| 2 | ||
| 3 | PRESENTATION | |
| 4 | ------------ | |
| 5 | ||
| 6 | Diogenes is a content management system that allows you to quickly create and | |
| 7 | host web sites for communities. It was written by the Polytechnique.org | |
| 8 | team. More information can be found on the Diogenes project page : | |
| 9 | ||
| 10 | http://opensource.polytechnique.org/diogenes/ | |
| 11 | ||
| 12 | It is released under the terms of the GNU Public License (GPL) version 2. The | |
| 13 | full text of this license can be found in the COPYING file included in this | |
| 14 | distribution. | |
| 15 | ||
| 16 | ||
| 17 | DOCUMENTATION & INSTALLATION | |
| 18 | ---------------------------- | |
| 19 | ||
| 20 | The documentation for Diogenes, including installation instructions can | |
| 21 | be found here: | |
| 22 | ||
| 23 | http://doc.polytechnique.org/diogenes/ | |
| 24 | ||
| 25 | ||
| 26 | CUSTOMISING DIOGENES | |
| 27 | -------------------- | |
| 28 | ||
| 29 | Diogenes provides several means of customising its look and behaviour. | |
| 30 | ||
| 31 | * CONFIGURATION FILE | |
| 32 | ||
| 33 | The 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 | |
| 35 | look at the file called "diogenes.globals.inc.php". | |
| 36 | ||
| 37 | * SUBCLASSING DIOGENES'S CLASSES | |
| 38 | ||
| 39 | Diogenes is written in Object-Oriented Programming (OOP), and it is possible to | |
| 40 | specify the classes to use from the configuration file. For instance, if you | |
| 41 | want 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 |