summaryrefslogtreecommitdiffstats
path: root/README.txt
blob: 4357e3ba54e3c58da69bc6d6dfeabf376c8ab42d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
CONTENTS OF THIS FILE
---------------------

 * Installing Kalatheme
 * Automatic Setup and Subthemes
 * Manually Installing Bootstrap
 * Creating a Subtheme
 * Key Features

INSTALLING KALATHEME
--------------------
## System Requirements

Unlike other Drupal themes Kalatheme requires some other modules to work properly. Please verify you have the following before proceeding with installation. If you fail to do as Kalatheme has requested it will bug you about it until the ending of the world.

1. Libraries API 2.1+
2. Panels 3.3+
3. Views 3.x
4. JQuery Update 2.x (with JQuery version set to 1.7+)
5. PHP 5.3+
6. Optional but highly recommended: Panopoly Theme
7. Optional: A custom Bootstrap library

The easiest way to satisfy all of these requirements is to just start with Panopoly on Pantheon:
https://drupal.org/node/2175703

Then install Kalatheme like any other Drupal theme:
http://drupal.org/documentation/install/modules-themes

Some people also having troubles using the Kalacustomize plugin were helped by Patch #5 here:
#2024441: Fatal error undefined function panels_plugin_get_function when doing #ajax on pane style form
which was rolled against Panels 3.3+41-dev.

UPDATE: This patch is now in the latest dev version of CTools/Panels.


AUTOMATIC SETUP & SUBTHEMES
---------------------------
Kalatheme is meant to be the base theme that is used to build more powerful
subthemes. Subthemes inherit almost all of the propoerties of their base theme
so you can reduce theme clutter and start on the 10th floor.

Luckily, Kalatheme features a pretty neat subtheme generation tool that will
automatically set everything up for you and allow you to customize your
subtheme. You don't even need to install a Bootstrap library, Kalatheme will pull one from Bootswatch (http://bootswatch.com/) for you!

Check out more documentation on the Kalatheme subtheme generator GUI: https://github.com/drupalprojects/kalatheme/wiki/Setup-and-Installation



MANUALLY INSTALLING BOOTSTRAP
-----------------------------
Kalatheme no longer requires an installed Bootstrap library to work. Our subtheme generator does that for you. However, if you are looking to create a custom bootstrap library, here are some options:

 * To get the standard Bootstrap library, or to customize that library:
 http://getbootstrap.com/

 * If you are looking to rool with a custom version of Bootstrap try out
 http://getbootstrap.com/customize/
 https://drupal.org/node/2167149

 * If you don't mind paying for a little extra:
 http://wrapbootstrap.com/

 * You can also Google for other sources if you are feeling adventerous.
 http://www.google.com/

If you choose to manually install a custom Bootstrap library, put your Bootstrap files in sites/all/libraries/CURRENT-THEME_bootstrap. For
example, if you have a Kalatheme subtheme enabled called mytheme, you'd put
Bootstrap's files in sites/all/libraries/mytheme_bootstrap. If you have
Kalatheme set as your default theme, you'd use
sites/all/libraries/kalatheme_bootstrap.
This is so you can have differently customized installations of Bootstrap for
different themes.

Custom Bootstrap libraries can use a non-standard files scheme so you need to
make sure that your bootstrap directory looks like the following folders and
files.

  /CURRENT-THEME_bootstrap
  /CURRENT-THEME_bootstrap/css
  /CURRENT-THEME_bootstrap/css/bootstrap.css
  /CURRENT-THEME_bootstrap/css/bootstrap.min.css
  /CURRENT-THEME_bootstrap/fonts/
  /CURRENT-THEME_bootstrap/js/
  /CURRENT-THEME_bootstrap/js/bootstrap.js
  /CURRENT-THEME_bootstrap/js/bootstrap.min.js

IMPORTANT: The only actual requirement here is that either css/bootstrap.css or
css/bootstrap.min.css exist and that they both have some sort of version
information at the top like this:

  /*!
   * Bootstrap v3.0.0
   *
   * Copyright 2013 Twitter, Inc
   * Licensed under the Apache License v2.0
   * http://www.apache.org/licenses/LICENSE-2.0

Most themes have this by default and you can use the above as a basis. It is
also worth noting that while you only need boostrap.(min).css for this to "work"
you will likely be disappointed if you don't have the JS and font files as well.

If you have more files than what is listed above we recommend putting these
files in a KalaSUBtheme.

You also do not need to have the minified files to get this to work but they are
highly recommended for better performance.

### Upgrading Bootstrap to 3.2
If you have a Custom Bootstrap library that is older than 3.2 you may not have the URL to rebuild the library.  With 3.2, this is now added into the json file.  However, it can be done with older bootstrap json files by following [this StackOverflow post](http://stackoverflow.com/questions/20384330/reload-bootstrap-customization).

=======
KEY FEATURES OF KALATHEME
-------------------------
 * Settings
 On the settings page for Kalatheme you can configure how you want the style
 plugin to work.
https://github.com/drupalprojects/kalatheme/wiki/Kalatheme-settings-and-config

 * Style Plugin
 When you choose to "Customize this page" using the Panels In-Place Editor you
 gain access to a bunch of customization tools provided by Kalatheme. Select the
 paintbrush on the panels pane or region you want to edit, choose
 "Kalacustomize" and hit next.
https://github.com/drupalprojects/kalatheme/wiki/Styles-Plugin

 * Grid Systen
 Any content pane view that is made with the grid display and that has an
 amount of columns that can evenly divide the amount of columns in your
 responsive grid (12 by default) will be automatically responsive. You can
 also implement a custom size grid.
https://github.com/drupalprojects/kalatheme/wiki/Dynamic-Grid-System

 * Responsive Menu and Toggling
 The "main-menu" menu will automatically dropdown for subitems. It will also
 automatically "responsify" on tablet and phone. You can also choose what
 device you want each pane to show up on.
https://github.com/drupalprojects/kalatheme/wiki/Responsive-Toggling

 * One Region Theme Nirvana with Panels Layouts
 https://github.com/drupalprojects/kalatheme/wiki/Theming-with-One-Region
https://github.com/drupalprojects/kalatheme/wiki/Panels-Layouts
git pull git@github.com:katypool/kalatheme.git 7.x-3.x