Project

General

Profile

Paste
Download (7.16 KB) Statistics
| Branch: | Revision:

root / drupal7 / sites / all / themes / bootstrap / docs / FAQ.md @ 749b8a23

1
<!-- @file Frequently Asked Questions -->
2
<!-- @defgroup -->
3
# FAQ - Frequently Asked Questions
4

    
5
- [Do you support X module?](#support)
6
- [Do you support Internet Explorer?](#ie)
7
- [Is Drupal Bootstrap a module or theme?](#module-or-theme)
8
- [What does the JavaScript error `TypeError: $(...).on is not a function` mean?](#jquery)
9
- [Where can I discuss an issue in real time?](#irc)
10
- [Where should I make changes?](#changes)
11
- [Why are my sub-theme's `.info` settings ignored?](#theme-settings-ignored)
12

    
13
---
14

    
15
### Q: Do you support X module? {#support}
16
**A: Possibly**
17

    
18
Below are a list of modules the [Drupal Bootstrap] base theme actively supports.
19
This list is constantly growing and each module's support has usually been
20
implemented because of either extremely high usage or the fact it was designed
21
explicitly for use with this base theme and has maintainers in both projects.
22

    
23
**Supported modules:**
24
- [Admin Menu](https://www.drupal.org/project/admin_menu)
25
- [Bootstrap Core](https://www.drupal.org/project/bootstrap_core)
26
- [jQuery Update](https://www.drupal.org/project/jquery_update)
27
- [Icon API](https://www.drupal.org/project/icon)
28
- [Path Breadcrumbs](https://www.drupal.org/project/path_breadcrumbs)
29
- [Picture](https://www.drupal.org/project/picture)
30
- [Views](https://www.drupal.org/project/picture) _(partial support)_
31
- [Webform](https://www.drupal.org/project/webform) _(partial support)_
32

    
33
The following modules are "un-supported modules" and are not documented by the
34
[Drupal Bootstrap] base theme. This does not mean that the base theme will not
35
work with them or that they are "bad". It simply means that this project does
36
not have the time, energy or effort it would take to document "every possible
37
scenario".
38

    
39
It is certainly possible that some of these modules may eventually become
40
"officially" supported. That will happen only, of course, if there are enough
41
people to help contribute solid solutions and make supporting them by the base
42
theme maintainers a relatively "easy" task.
43

    
44
Some of these modules may have blogs or videos floating around on the internet.
45
However, if you choose to use one of these modules, you are really doing so
46
at your own expense. Do not expect support from this base theme or the project
47
you are attempting to integrate the base theme with.
48

    
49
**"Un-supported" modules:**
50
- Color module (in core)
51
- [Bootstrap API](https://www.drupal.org/project/bootstrap_api)
52
- [Bootstrap Library](https://www.drupal.org/project/bootstrap_library)
53
- [Display Suite](https://www.drupal.org/project/ds)
54
- [Display Suite Bootstrap Layouts](https://www.drupal.org/project/ds_bootstrap_layouts)
55
- [LESS module](https://drupal.org/project/less)
56
- [Panels](https://www.drupal.org/project/panels)
57
- [Panels Bootstrap Layouts](https://www.drupal.org/project/panels_bootstrap_layouts)
58

    
59
---
60

    
61
### Q: Do you support Internet Explorer? {#ie}
62
**A: No, not "officially"**
63

    
64
The [Bootstrap Framework] itself does not officially support older Internet
65
Explorer [compatibility modes](http://getbootstrap.com/getting-started/#support-ie-compatibility-modes).
66
To ensure you are using the latest rendering mode for IE, consider installing
67
the [HTML5 Tools](https://drupal.org/project/html5_tools) module.
68

    
69
Internet Explorer 8 requires the use of [Respond.js] to enable media queries
70
(Responsive Web Design). However, [Respond.js] does not work with CSS that is
71
referenced via a CSS `@import` statement, which is the default way Drupal
72
adds CSS files to a page when CSS aggregation is disabled. To ensure
73
[Respond.js] works properly, enable CSS aggregation at the bottom of:
74
`admin/config/development/performance`.
75

    
76
---
77

    
78
### Q: Is Drupal Bootstrap a module or theme? {#module-or-theme}
79
**A: Theme**
80

    
81
More specifically a base theme. It is _not_ a module. Modules are allowed to
82
participate in certain hooks, while themes cannot. This is a very important
83
concept to understand and limits themes from participating in a wider range of
84
functionality.
85

    
86
---
87

    
88
### Q: What does the JavaScript error `TypeError: $(...).on is not a function` mean? {#jquery}
89
Drupal 7 ships with the `1.4.4` version of jQuery out-of-the-box. The [$.on()](http://api.jquery.com/on/)
90
method was introduced several versions after this in jQuery version `1.7`.
91

    
92
You must upgrade your site or sub-theme's jQuery Version by installing (and
93
properly configuring) the [jQuery Update] module to use a jQuery version
94
compatible with the [Bootstrap Framework]. This is typically a version greater
95
than or equal to `1.9`.
96

    
97
Ensuring jQuery compatibilities between Drupal, the [Bootstrap Framework] and
98
other plugins/modules does not fall within the scope of this base theme's
99
documentation or support.
100

    
101
---
102

    
103
### Q: Where can I discuss an issue in real time? {#irc}
104
**A: In IRC**
105

    
106
The [Drupal Bootstrap] project and its maintainers use the `#drupal-bootstrap`
107
channel on the freenode.net IRC network to communicate in real time. Please read
108
the following for more information on how to the community uses this technology:
109
[Chat with the Drupal Community on IRC](https://www.drupal.org/irc).
110

    
111
Please keep in mind though, this **IS NOT** a "support" channel. It's primary
112
use is to discuss issues and to help fix bugs with the base theme itself.
113

    
114
---
115

    
116
### Q: Where should I make changes? {#changes}
117
**A: In a custom sub-theme**
118

    
119
You should **never** modify any theme or sub-theme that is packaged and released
120
from Drupal.org. If you do, all changes you have made would be lost once that
121
theme is updated. This makes keeping track of changes next to impossible.
122

    
123
Instead, you should create a custom sub-theme that isn't hosted on Drupal.org.
124

    
125
[Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
126
[Bootstrap Framework]: http://getbootstrap.com
127
[Respond.js]: https://github.com/scottjehl/Respond
128

    
129
---
130

    
131
### Q: Why are my sub-theme's `.info` settings ignored? {#theme-settings-ignored}
132
**A: The database contains a copy of the theme settings and they take
133
precedence over theme settings stored in the `.info` file.**
134

    
135
This is actually quite a common issue whenever a theme's settings are saved
136
from the UI. This action stores the settings in the {variables} table of the
137
database. The workflow for theme_get_setting() merges the settings from the
138
database on top of the settings found in the theme's `.info` file.
139

    
140
You need to remove the variable `theme_[theme_name]_settings` from the database,
141
where `[theme_name]` is your sub-theme's machine name (e.g. if your sub-theme
142
machine name is `my_bootstrap_subtheme`, the variable name would be
143
`theme_my_bootstrap_subtheme_settings`).
144

    
145
The easiest way to do accomplish this task is to use the following [Drush]
146
command: `theme_my_bootstrap_subtheme_settings`
147

    
148
If you do not have or use [Drush], you will either have to manually delete this
149
variable from the database or create an [update hook](https://api.drupal.org/api/drupal/modules%21system%21system.api.php/function/hook_update_N/7)
150
in a custom module that deletes the variable for you:
151

    
152
```php
153
/**
154
* Remove the 'theme_my_bootstrap_subtheme_settings' variable.
155
*/
156
function hook_update_N() {
157
  variable_del('theme_my_bootstrap_subtheme_settings');
158
}
159
```
160

    
161
[Drush]: http://www.drush.org
162
[Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
163
[Bootstrap Framework]: http://getbootstrap.com
164
[jQuery Update]: https://drupal.org/project/jquery_update