About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:architecture:less

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
development:architecture:less [2016/12/21 20:41] – [Command Line Compilation] crhallbergdevelopment:architecture:less [2022/10/21 15:37] demiankatz
Line 2: Line 2:
  
 [[http://lesscss.org/features/|Less]] and [[http://sass-lang.com/|Sass]] are CSS "pre-processors": they include higher level functionality like variables, functions, and nesting on top of CSS and can then be compiled to CSS. [[http://lesscss.org/features/|Less]] and [[http://sass-lang.com/|Sass]] are CSS "pre-processors": they include higher level functionality like variables, functions, and nesting on top of CSS and can then be compiled to CSS.
 +
 +===== LESS vs. SASS =====
 +
 +As of this writing, all VuFind® style development is done using LESS; SASS files are programmatically derived from the LESS files using the lessToSass [[development:grunt|grunt]] task. While LESS and SASS files should be functionally equivalent, the LESS files are more thoroughly tested and we apologize for any problems with SASS. Please feel free to contribute back to the project if you wish to improve our support of SASS.
  
 ===== Command Line Compilation ===== ===== Command Line Compilation =====
Line 8: Line 12:
  
 ===== Active Compilation ===== ===== Active Compilation =====
 +
 +:!: This feature was removed in VuFind® 9.0, and its use is strongly discouraged -- the built-in PHP-based LESS compiler did not generate output consistent with the command-line Grunt-driven LESS compiler, and this had a high potential for causing problems.
 +
 Active compilation can be used to automatically compile from Less to CSS when a page loads. This is very useful for development. Active compilation can be used to automatically compile from Less to CSS when a page loads. This is very useful for development.
  
Line 21: Line 28:
  
 ===== LESS Theme Inheritance ==== ===== LESS Theme Inheritance ====
-This is a bit tricky and is still a problem for VuFind we are especially open to for help/suggestions. 
  
-CSS inheritance is pretty straight forward in VuFind: name your CSS file the same if you want to override the parents', different if you want to extend. In LESS, you can import other files into your stylings, which is INSANELY useful for things like the Bootstrap library because of all the variables. Being able to use those variables to color and size things correctly is crucial.+This is a bit tricky and is still a problem for VuFind®; we are especially open to help/suggestions for making this more straightforward and easier to understand. 
 + 
 +CSS inheritance is pretty straight forward in VuFind®: name your CSS file the same if you want to override the parents', different if you want to extend. In LESS, you can import other files into your stylings, which is VERY useful for things like the Bootstrap library because of all the variables. Being able to use those variables to color and size things correctly is crucial.
  
 In order to utilize the power of imports and the power of inheritance, here's what's going on in the Bootstrap 3 and Bootprint 3 themes. In order to utilize the power of imports and the power of inheritance, here's what's going on in the Bootstrap 3 and Bootprint 3 themes.
  
 ** Bootstrap3 ** ** Bootstrap3 **
-  'less' => array( 
-    'active' => false, 
-    'compiled.less' 
-  ), 
-   
   - compiled.less (only imports bootstrap.less, included in theme.config.php)   - compiled.less (only imports bootstrap.less, included in theme.config.php)
     - @import "bootstrap";     - @import "bootstrap";
Line 41: Line 44:
  
 ** Bootprint3 ** ** Bootprint3 **
-  // No custom theme.config.php 
-   
   - compiled.less (pulled in instead of bootstrap3/compiled.less, due to inheritance)   - compiled.less (pulled in instead of bootstrap3/compiled.less, due to inheritance)
     - @import "bootprint";     - @import "bootprint";
Line 52: Line 53:
   - icons.less (FA icon overwrites, included in theme.config.php)   - icons.less (FA icon overwrites, included in theme.config.php)
  
-Make sure you have a compiled.less in your theme, as the LESS compiler was not keen on pulling from parent themes. Also, doing so will prevent mulitple Bootstrap instances from being compiled into your final CSS.+Make sure you have a compiled.less in your theme, as the LESS compiler may have trouble pulling from parent themes. Also, doing so will prevent multiple Bootstrap instances from being compiled into your final CSS.
  
 ===== Backup PHP Command Line Compiler ===== ===== Backup PHP Command Line Compiler =====
 +
 +:!: Note that the "grunt less" task is the preferred means of compiling LESS files for VuFind®, and the older PHP compiler may produce inconsistent results in some situations. The PHP compiler is deprecated as of VuFind® 8.0 and was removed in VuFind® 9.0.
 +
   php util/cssBuilder.php   php util/cssBuilder.php
  
Line 62: Line 66:
  
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
development/architecture/less.txt · Last modified: 2023/04/20 15:50 by demiankatz