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