theme/bootstrapbase/README.txt

   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 grunt
  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 moodlebootstrap.js
  40 ------------------
  41 This file initiates the bootstrap library.
  42
  43 headercollapse.js
  44 -----------------
  45 Workaround for the collapse button on the Moodle custom menu. Without this
  46 Submenu items cannot be opened
  47
  48 Updating Twitter bootstrap and Libraries
  49 ========================================
  50
  51 Twitter bootstrap
  52 -----------------
  53 This theme uses the original unmodified version 2.3.0 Twitter bootstrap less files. These are
  54 Object Oriented CSS files. The bootstrap repository is available on:
  55
  56 https://github.com/twitter/bootstrap.git
  57
  58 To update to the latest release of twitter bootstrap remove all files from less/bootstrap,
  59 download the new less files and store them in less/bootstrap
  60 Inclusion of bootstrap files is configured in less/moodle.less. To generate the new
  61 Moodle CSS read /less/README
  62
  63 html5shiv.js
  64 ------------
  65 This theme uses the original unmodified html5shiv.js JavaScript library to enable HTML5 tags in IE7 and IE8.
  66 This library is available on:
  67
  68 https://github.com/aFarkas/html5shiv/blob/master/src/html5shiv.js
  69
  70 To update to the latest release of html5shiv download and replace:
  71 javascript/html5shiv.js
  72
  73 Licenses & Authors
  74 ==================
  75
  76 Twitter Bootstrap Copyright and license
  77 ---------------------------------------
  78 Authors: Mark Otto, Jacob Thornton
  79 URL: http://twitter.github.com/bootstrap/
  80 License:
  81
  82 Copyright 2012 Twitter, Inc.
  83
  84 Licensed under the Apache License, Version 2.0 (the "License");
  85 you may not use this work except in compliance with the License.
  86 You may obtain a copy of the License in the LICENSE file, or at:
  87
  88    http://www.apache.org/licenses/LICENSE-2.0
  89
  90 Unless required by applicable law or agreed to in writing, software
  91 distributed under the License is distributed on an "AS IS" BASIS,
  92 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  93 See the License for the specific language governing permissions and
  94 limitations under the License.
  95
  96 Html5shiv.js
  97 ------------
  98 Author: Sjoerd Visscher
  99 URL: http://en.wikipedia.org/wiki/HTML5_Shiv, https://github.com/aFarkas/html5shiv
 100 License: MIT/GPL2 Licensed
 101
 102 moodlebootstrap.js
 103 ------------------
 104 Author: 2013 Bas Brands. www.sonsbeekmedia.nl
 105 license:  http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later