Issue #2235473 by sjbassett: Main content element changed to role='main'
[project/kalatheme.git] / README.txt
1
2 CONTENTS OF THIS FILE
3 ---------------------
4
5  * Installing Kalatheme
6  * Automatic Setup and Subthemes
7  * Manually Installing Bootstrap
8  * Creating a Subtheme
9  * Key Features
10
11 INSTALLING KALATHEME
12 --------------------
13 Unlike other Drupal themes Kalatheme requires some other modules to work
14 properly. Please verify you have the following before proceeding with
15 installation. If you fail to do as Kalatheme has requested it will bug
16 you about it until the ending of the world.
17
18  * Libraries 2.1+
19  * Panels 3.3+
20  * PHP 5.3+
21  * JQuery Update 2.x (with JQuery version set to 1.7+)
22  * A Bootstrap 3.0+ library (read below in Installing Bootstrap)
23  *  Optional but highly recommended: Panopoly Theme.
24  * Optional: A custom Bootstrap library.
25
26 The easiest way to satisfy all of these requirements is to just start with
27 Panopoly on Pantheon.
28 https://drupal.org/node/2175703
29
30 Then install Kalatheme like any other theme
31 http://drupal.org/documentation/install/modules-themes
32
33 Some people having troubles using the Kalacustomize plugin were helped by
34 Patch #5 here: https://drupal.org/node/2024441
35 which was rolled against Panels 3.3+41-dev
36
37 AUTOMATIC SETUP & SUBTHEMES
38 ---------------------------
39 Kalatheme is meant to be the base theme that is used to build more powerful
40 subthemes. Subthemes inherit almost all of the propoerties of their base theme
41 so you can reduce theme clutter and start on the 10th floor. Here is some
42 documentation on creating a basic subtheme
43
44 Luckily, Kalatheme features a pretty neat subtheme generation tool that will
45 automatically set everything up for you and allow you to customize your
46 subtheme.
47 https://drupal.org/node/2167149
48
49
50 MANUALLY INSTALLING BOOTSTRAP
51 -----------------------------
52 Kalatheme doesn't do much without a Bootstrap Library so you are going to need
53 to shop around for one.
54
55  * To get the standard Bootstrap library, or to customize that library:
56  http://getbootstrap.com/
57
58  * If you are looking for a free and pre-made custom version of Bootstrap:
59  http://bootswatch.com/
60
61  * If you are looking to rool with a custom version of Bootstrap try out
62  http://getbootstrap.com/customize/
63  https://drupal.org/node/2167149
64
65  * If you don't mind paying for a little extra:
66  http://wrapbootstrap.com/
67
68  * You can also Google for other sources if you are feeling adventerous.
69  http://www.google.com/
70
71 Kalatheme uses the Libraries API so in order to get Bootstrap working you need
72 to put your Bootstrap files in sites/all/libraries/CURRENT-THEME_bootstrap. For
73 example, if you have a Kalatheme subtheme enabled called mytheme, you'd put
74 Bootstrap's files in sites/all/libraries/mytheme_bootstrap. If you have
75 Kalatheme set as your default theme, you'd use
76 sites/all/libraries/kalatheme_bootstrap.
77 This is so you can have differently customized installations of Bootstrap for
78 different themes.
79
80 Custom Bootstrap libraries can use a non-standard files scheme so you need to
81 make sure that your bootstrap directory looks like the following folders and
82 files.
83
84   /CURRENT-THEME_bootstrap
85   /CURRENT-THEME_bootstrap/css
86   /CURRENT-THEME_bootstrap/css/bootstrap.css
87   /CURRENT-THEME_bootstrap/css/bootstrap.min.css
88   /CURRENT-THEME_bootstrap/fonts/
89   /CURRENT-THEME_bootstrap/js/
90   /CURRENT-THEME_bootstrap/js/bootstrap.js
91   /CURRENT-THEME_bootstrap/js/bootstrap.min.js
92
93 IMPORTANT: The only actual requirement here is that either css/bootstrap.css or
94 css/bootstrap.min.css exist and that they both have some sort of version
95 information at the top like this:
96
97   /*!
98    * Bootstrap v3.0.0
99    *
100    * Copyright 2013 Twitter, Inc
101    * Licensed under the Apache License v2.0
102    * http://www.apache.org/licenses/LICENSE-2.0
103
104 Most themes have this by default and you can use the above as a basis. It is
105 also worth noting that while you only need boostrap.(min).css for this to "work"
106 you will likely be disappointed if you don't have the JS and font files as well.
107
108 If you have more files than what is listed above we recommend putting these
109 files in a KalaSUBtheme.
110
111 You also do not need to have the minified files to get this to work but they are
112 highly recommended for better performance.
113
114 KEY FEATURES
115 ------------
116  * Settings
117  On the settings page for Kalatheme you can configure how you want the style
118  plugin to work.
119  https://drupal.org/node/2167213
120
121  * Style Plugin
122  When you choose to "Customize this page" using the Panels In-Place Editor you
123  gain access to a bunch of customization tools provided by Kalatheme. Select the
124  paintbrush on the panels pane or region you want to edit, choose
125  "Kalacustomize" and hit next.
126  https://drupal.org/node/2167217
127
128  * Views Grid
129  Any content pane view that is made with the grid display and that has an
130  amount of columns that can evenly divide the amount of columns in your
131  responsive grid (12 by default) will be automatically responsive. You can
132  also implement a custom size grid.
133  https://drupal.org/node/2167219
134
135  * Responsive Menu and Toggling
136  The "main-menu" menu will automatically dropdown for subitems. It will also
137  automatically "responsify" on tablet and phone. You can also choose what
138  device you want each pane to show up on.
139  https://drupal.org/node/2167215
140
141  * One Region Theme Nirvana with Panels Layouts
142  https://drupal.org/node/2167223
143  https://drupal.org/node/2167225
144
145  * SASS and COMPASS Support
146  https://drupal.org/node/2167227