Added some docs from MDL-6798

diff --git a/lib/cssconstants.php b/lib/cssconstants.php
index 144a39cc510b3a58608b81f39516ba88eb5cb607..6fbb0253eb0096b8b9b59e4b929446c2748d1884 100644 (file)
--- a/lib/cssconstants.php
+++ b/lib/cssconstants.php
@@ -1,8 +1,68 @@
-<?php
+<?php // $Id$
 
 /******************************************************************************
- Plug in constants/variables 
- ******************************************************************************/
+
+ Plug in constants/variables    - See MDL-6798 for details
+
+ Information from Urs Hunkler:
+
+
+ More flexible themes with CSS constants: An option for Moodle retro themes and easy colour palette variants.
+ 
+ I adopted Shaun Inman's "CSS Server-side Constants" to Moodle: http://www.shauninman.com/post/heap/2005/08/09/css_constants
+ 
+ With setting "cssconstants" to true in "config.php" you activate the CSS constants. If "cssconstants" is missing or set to "false" the
+ replacement function is not used.
+ 
+ $THEME->cssconstants = true;
+ /// By setting this to true, you will be able to use CSS constants
+ 
+ 
+ The constant definitions are written into a separate CSS file named like "constants.css" and loaded first in config.php. You can use constants for any CSS properties. The constant definition looks like:
+ 
+@server constants {
+  fontColor: #3a2830;
+  aLink: #116699;
+  aVisited: #AA2200;
+  aHover: #779911;
+  pageBackground: #FFFFFF;
+  backgroundColor: #EEEEEE;
+  backgroundSideblockHeader: #a8a4e9;
+  fontcolorSideblockHeader: #222222;
+  color1: #98818b;
+  color2: #bd807b;
+  color3: #f9d1d7;
+  color4: #e8d4d8;
+}
+
+
+
+The lines in the CSS files using CSS constants look like:
+
+body {
+  font-size: 100%;
+  background-color: pageBackground;
+  color: fontColor;
+  font-family: 'Bitstream Vera Serif', georgia, times, serif;
+  margin: 0;
+  padding: 0;
+}
+div#page {
+  margin: 0 10px;
+  padding-top: 5px;
+  border-top-width: 10px;
+  border-top-style: solid;
+  border-top-color: color3;
+}
+div.clearer {
+  clear: both;
+}
+a:link {
+  color: aLink;
+} 
+ 
+******************************************************************************/
+
 function replace_cssconstants($css) {
     if (preg_match_all("/@server\s+(?:variables|constants)\s*\{\s*([^\}]+)\s*\}\s*/i",$css,$matches)) {
         $variables  = array();