css/design40/less/READ_ME.md

   1 # About this less stuff
   2
   3 ## What is LESS?
   4 Read this excellent short german overview: http://www.lesscss.de<br>
   5 It is recommended to install lessc/node-less server-side.
   6 LESS contains mainly CSS/LESS statements, and yes!, also pure and
   7 valid CSS-Code is also accepted and compiled. The compiler (lessc) creates
   8 pure and valid css code with your LESS and CSS code.
   9
  10 ## How to create a style.css for kivitendo
  11 First set the cursor of your terminal to <code>/css/less/</code> (<code>cd /css/less</code>)<br>
  12 Use following command: <code>lessc style.less ../style.css</code><br>
  13 For minifiying the output css:  <code>lessc -x style.less ../style.css</code><br>
  14 Then a new <code>/css/style.css</code> is created except if errors occur.
  15
  16 ## Developing kivitendo CSS (not customizing)
  17 Read style.less.<br>
  18 This is the control center for the whole less stuff.<br>
  19 Variables can be set or changed in variables.less.<br>
  20 Variables are efficacious in the other less files.
  21
  22 ## Overriding original stuff
  23 There are several overriding LESS files. Some of the files are for
  24 customizing the original kivitendo LESS stuff.
  25
  26  * <b>jquery-ui-overrides.less</b> (overrides original jquery css in jquery.less)
  27  * <b>main-overrides</b> (overrides a lot of kivitendo less/css stuff)
  28  * <b>custom-variables.less</b> (overrides variables in variable.less)
  29  * <b>custom.less</b> (overrides all the original kivitendo LESS stuff)
  30
  31 Overriding is useful for occurences of standard elements in a special
  32 context. For example: a standard table occurs in a toggle panel or in other
  33 control panels.
  34
  35 ## jQuery and overriding jQuery-CSS
  36 The jQuery LESS stuff contains the original jQuery CSS stuff (pure CSS).
  37 Overriding the jQuery stuff (you can call it customizing for kivitendo) is
  38 the best way to preserve full functionality of the jQuery JS. It is intended
  39 just to change colors, font-sizes & -families etc. with the override-file
  40 (jquery-overrides.less).
  41
  42 If there's a new jQuery-Version just paste the whole CSS code into the
  43 corresponding LESS file. That's (almost) all, folks.
  44
  45 ## Customizing kivitendo CSS (not developing)
  46 For customisation do not touch the original (developers) LESS files.<br>
  47 Therefore it is recommended to edit only these two files:
  48
  49  * <b>custom-variables.less</b> (overrides variables in variable.less)
  50  * <b>custom.less</b> (overrides in the end all the original kivitendo LESS stuff)
  51
  52 These files can be empty if you do not want to customize the kivitendo CSS
  53 stuff. The original custom files contains only comments and deactivated example
  54 code.
  55
  56 Customization only with these two files gives you comfort in your GIT
  57 habit.
  58