[Summary view] [Print] [Text view]

   1  About this theme
   2  ================
   3  
   4  This is the Bootstrap theme for Moodle.
   5  
   6  * package   Moodle Bootstrap theme
   7  * copyright 2013 Bas Brands. www.sonsbeekmedia.nl
   8  * authors   Bas Brands, David Scotson
   9  * license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  10  
  11  This theme has been created with the help of:
  12  Stuart Lamour, Mark Aberdour, Paul Hibbitts, Mary Evans
  13  
  14  This theme is based on the Twitter Bootstrap CSS framework version 2.3.
  15  It contains all unmodified less* CSS sources from the Twitter Bootstrap CSS
  16  framework in folder /less/bootstrap.
  17  On top of the Bootstrap less CSS sources Moodle CSS is added to create this
  18  theme.
  19  
  20  HTML5 is tags are used in the /layout/general.php file. The structure of this file
  21  provides a 2-1-3 layout when looking at your Moodle page source. This improves
  22  accessibility and Search Engine Optimization (SEO).
  23  
  24  *less CSS
  25  Less CSS is a Object Oriented way of writing CSS code. All Less CSS files
  26  for this theme are stored in the /less folder. A developer can use recess
  27  to generate the CSS files in the /style folder. For more
  28  information read /less/README
  29  
  30  JavaScript Libraries
  31  
  32  html5shiv.js
  33  ------------
  34  To provide backwards compatibility for HTML5 for Internet Explorer 7 (IE7) and Internet
  35  Explorer 8 (IE8) a javascript library call /javascript/html5shiv.js was added. This
  36  JavaScript converts HTML tags and CSS into Tag that are understood by IE7 and IE8.
  37  The config.php makes sure these libraries are only loaded for IE7 and IE8.
  38  
  39  bootstrapcollapse.js, bootstrapdropdown.js, bootstrapengine.js
  40  --------------------------------------------------------------
  41  These are the 3 out of 12 original YUI ports of the Twitter Bootstrap jQuery libraries by
  42  Jay Shirley. The full list of the ported libraries can be found here:
  43  https://github.com/jshirley/bootstrap/tree/master/js
  44  
  45  moodlebootstrap.js
  46  ------------------
  47  This file initiates the bootstrap*.js libraries.
  48  
  49  headercollapse.js
  50  -----------------
  51  Workaround for the collapse button on the Moodle custom menu. Without this
  52  Submenu items cannot be opened
  53  
  54  Updating Twitter bootstrap and Libraries
  55  ========================================
  56  
  57  Twitter bootstrap
  58  -----------------
  59  This theme uses the original unmodified version 2.3.0 Twitter bootstrap less files. These are
  60  Object Oriented CSS files. The bootstrap repository is available on:
  61  
  62  https://github.com/twitter/bootstrap.git
  63  
  64  To update to the latest release of twitter bootstrap remove all files from less/bootstrap,
  65  download the new less files and store them in less/bootstrap
  66  Inclusion of bootstrap files is configured in less/moodle.less. To generate the new
  67  Moodle CSS read /less/README
  68  
  69  html5shiv.js
  70  ------------
  71  This theme uses the original unmodified html5shiv.js JavaScript library to enable HTML5 tags in IE7 and IE8.
  72  This library is available on:
  73  
  74  https://github.com/aFarkas/html5shiv/blob/master/src/html5shiv.js
  75  
  76  To update to the latest release of html5shiv download and replace:
  77  javascript/html5shiv.js
  78  
  79  bootstrapcollapse.js, bootstrapdropdown.js, bootstrapengine.js
  80  --------------------------------------------------------------
  81  This them uses YUI ports of the Twitter bootstrap jQuery based libs. These ported files are available on:
  82  
  83  https://github.com/jshirley/yui3-gallery/blob/master/src/gallery-bootstrap-collapse/js/bootstrap-collapse.js
  84  https://github.com/jshirley/yui3-gallery/blob/master/src/gallery-bootstrap-dropdown/js/bootstrap-dropdown.js
  85  https://github.com/jshirley/yui3-gallery/blob/master/src/gallery-bootstrap-engine/js/bootstrap-engine.js
  86  
  87  The content of these files are slightly modified to make sure all required YUI libraries are loaded. To achieve
  88  that the first and last line of each of these files has been modified.
  89  
  90  The YUI port of the Twitter bootstrap libs are now longer maintained. If you need all of the Bootstrap JavaScript
  91  functionality consider switching to the original jQuery version of these file
  92  
  93  If you do want to update use these file locations:
  94  javascript/bootstrap-collapse.js
  95  javascript/bootstrap-dropdown.js
  96  javascript/bootstrap-engine.js
  97  
  98  Licenses & Authors
  99  ==================
 100  
 101  Twitter Bootstrap Copyright and license
 102  ---------------------------------------
 103  Authors: Mark Otto, Jacob Thornton
 104  URL: http://twitter.github.com/bootstrap/
 105  License:
 106  
 107  Copyright 2012 Twitter, Inc.
 108  
 109  Licensed under the Apache License, Version 2.0 (the "License");
 110  you may not use this work except in compliance with the License.
 111  You may obtain a copy of the License in the LICENSE file, or at:
 112  
 113     http://www.apache.org/licenses/LICENSE-2.0
 114  
 115  Unless required by applicable law or agreed to in writing, software
 116  distributed under the License is distributed on an "AS IS" BASIS,
 117  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 118  See the License for the specific language governing permissions and
 119  limitations under the License.
 120  
 121  Html5shiv.js
 122  ------------
 123  Author: Sjoerd Visscher
 124  URL: http://en.wikipedia.org/wiki/HTML5_Shiv, https://github.com/aFarkas/html5shiv
 125  License: MIT/GPL2 Licensed
 126  
 127  bootstrapcollapse.js, bootstrapdropdown.js, bootstrapengine.js
 128  --------------------------------------------------------------
 129  Author: Jay Shirley
 130  URL: http://jshirley.github.com/bootstrap/
 131  License:
 132  Copyright 2012 Twitter, Inc.
 133  
 134  Licensed under the Apache License, Version 2.0 (the "License");
 135  you may not use this work except in compliance with the License.
 136  You may obtain a copy of the License in the LICENSE file, or at:
 137  
 138     http://www.apache.org/licenses/LICENSE-2.0
 139  
 140  Unless required by applicable law or agreed to in writing, software
 141  distributed under the License is distributed on an "AS IS" BASIS,
 142  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 143  See the License for the specific language governing permissions and
 144  limitations under the License.
 145  
 146  moodlebootstrap.js
 147  ------------------
 148  Author: 2013 Bas Brands. www.sonsbeekmedia.nl
 149  license:  http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later