www.aleph1.co.uk Git - yaffs-website/blob - web/themes/contrib/bootstrap/docs/Getting-Started.md

   1 <!-- @file The "Getting Started" topic. -->
   2 <!-- @defgroup -->
   3 # Getting Started
   4
   5 ## Installation
   6 - Install the Bootstrap base theme in `themes` or a similar `sites/*/themes`
   7   directory.
   8 - Enable the [Drupal Bootstrap] base theme.
   9
  10 ## Bootstrap Framework Fundamentals
  11 Generally speaking, you should really read the entire [Bootstrap Framework]
  12 documentation site, if you haven't already. Here are the four basic "sections"
  13 that site is split into:
  14
  15 - [Getting Started](http://getbootstrap.com/getting-started) - An overview of
  16   the [Bootstrap Framework], how to download and use, basic templates and
  17   examples, and more.
  18 - [CSS](http://getbootstrap.com/css/) - Global CSS settings, fundamental HTML
  19   elements styled and enhanced with extensible classes, and an advanced grid
  20   system.
  21 - [Components](http://getbootstrap.com/components/) - Over a dozen reusable
  22   components built to provide iconography, dropdowns, input groups, navigation,
  23   alerts, and much more.
  24 - [JavaScript](http://getbootstrap.com/javascript/) - Bring the
  25   [Bootstrap Framework] components to life with over a dozen custom jQuery
  26   plugins. Easily include them all, or one by one.
  27
  28
  29 ## FAQ - Frequently Asked Questions
  30
  31 - [Do you support X module?](#support)
  32 - [Do you support Internet Explorer?](#ie)
  33 - [Is Drupal Bootstrap a module or theme?](#module-or-theme)
  34 - [Where can I discuss an issue in real time?](#irc)
  35 - [Where should I make changes?](#changes)
  36
  37 ---
  38
  39 ### Q: Do you support X module? {#support}
  40 **A: Possibly**
  41
  42 Below are a list of modules the [Drupal Bootstrap] base theme actively supports.
  43 This list is constantly growing and each module's support has usually been
  44 implemented because of either extremely high usage or the fact it was designed
  45 explicitly for use with this base theme and has maintainers in both projects.
  46
  47 **Supported modules:**
  48 See project page for a list of supported modules.
  49
  50 **"Un-supported" modules:**
  51 The following modules are "un-supported modules" and are not documented by the
  52 [Drupal Bootstrap] base theme. This does not mean that the base theme will not
  53 work with them or that they are "bad". It simply means that this project does
  54 not have the time, energy or effort it would take to document "every possible
  55 scenario".
  56
  57 It is certainly possible that some of these modules may eventually become
  58 "officially" supported. That will happen only, of course, if there are enough
  59 people to help contribute solid solutions and make supporting them by the base
  60 theme maintainers a relatively "easy" task.
  61
  62 Some of these modules may have blogs or videos floating around on the internet.
  63 However, if you choose to use one of these modules, you are really doing so
  64 at your own expense. Do not expect support from this base theme or the project
  65 you are attempting to integrate the base theme with.
  66
  67 - Color module (in core)
  68 - [Bootstrap API](https://www.drupal.org/project/bootstrap_api)
  69 - [Bootstrap Library](https://www.drupal.org/project/bootstrap_library)
  70 - [LESS module](https://drupal.org/project/less)
  71
  72 ---
  73
  74 ### Q: Do you support Internet Explorer? {#ie}
  75 **A: No, not "officially"**
  76
  77 The [Bootstrap Framework] itself does not officially support older Internet
  78 Explorer [compatibility modes](http://getbootstrap.com/getting-started/#support-ie-compatibility-modes).
  79 To ensure you are using the latest rendering mode for IE, consider installing
  80 the [HTML5 Tools](https://drupal.org/project/html5_tools) module.
  81
  82 Internet Explorer 8 requires the use of [Respond.js] to enable media queries
  83 (Responsive Web Design). However, [Respond.js] does not work with CSS that is
  84 referenced via a CSS `@import` statement, which is the default way Drupal
  85 adds CSS files to a page when CSS aggregation is disabled. To ensure
  86 [Respond.js] works properly, enable CSS aggregation at the bottom of:
  87 `admin/config/development/performance`.
  88
  89 ---
  90
  91 ### Q: Is Drupal Bootstrap a module or theme? {#module-or-theme}
  92 **A: Theme**
  93
  94 More specifically a base theme. It is _not_ a module. Modules are allowed to
  95 participate in certain hooks, while themes cannot. This is a very important
  96 concept to understand and limits themes from participating in a wider range of
  97 functionality.
  98
  99 ---
 100
 101 ### Q: Where can I discuss an issue in real time? {#irc}
 102 **A: In IRC**
 103
 104 The [Drupal Bootstrap] project and its maintainers use the `#drupal-bootstrap`
 105 channel on the freenode.net IRC network to communicate in real time. Please read
 106 the following for more information on how to the community uses this technology:
 107 [Chat with the Drupal Community on IRC](https://www.drupal.org/irc).
 108
 109 Please keep in mind though, this **IS NOT** a "support" channel. It's primary
 110 use is to discuss issues and to help fix bugs with the base theme itself.
 111
 112 ---
 113
 114 ### Q: Where should I make changes? {#changes}
 115 **A: In a custom sub-theme**
 116
 117 You should **never** modify any theme or sub-theme that is packaged and released
 118 from Drupal.org. If you do, all changes you have made would be lost once that
 119 theme is updated. This makes keeping track of changes next to impossible.
 120
 121 Instead, you should create a custom sub-theme that isn't hosted on Drupal.org.
 122
 123 [Respond.js]: https://github.com/scottjehl/Respond
 124 [Drush]: http://www.drush.org
 125 [Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
 126 [Bootstrap Framework]: http://getbootstrap.com
 127 [jQuery Update]: https://drupal.org/project/jquery_update