|
1
|
<!-- @file Documentation landing page and topics for the https://drupal-bootstrap.org site. -->
|
|
2
|
<!-- @mainpage -->
|
|
3
|
# Drupal Bootstrap Documentation
|
|
4
|
|
|
5
|
{.lead} The official documentation site for the [Drupal Bootstrap] base theme
|
|
6
|
|
|
7
|
The majority of this site is automatically generated from source files
|
|
8
|
located through out the project's repository. Topics are extracted from Markdown
|
|
9
|
files and the rest is extracted from embedded PHP comments.
|
|
10
|
|
|
11
|
---
|
|
12
|
|
|
13
|
## Topics
|
|
14
|
|
|
15
|
Below are some topics to help get you started using the [Drupal Bootstrap] base
|
|
16
|
theme. They are ordered based on the level one typically progresses while using
|
|
17
|
a base theme like this.
|
|
18
|
|
|
19
|
#### @link faq FAQ @endlink
|
|
20
|
|
|
21
|
#### @link getting_started Getting Started @endlink
|
|
22
|
|
|
23
|
#### @link subtheme Sub-Theming @endlink
|
|
24
|
- @link subtheme_settings Theme Settings @endlink
|
|
25
|
- @link subtheme_helper_functions Helper Functions @endlink
|
|
26
|
- @link subtheme_cdn CDN Starterkit @endlink
|
|
27
|
- @link subtheme_less Less Starterkit @endlink
|
|
28
|
- @link subtheme_sass Sass Starterkit @endlink
|
|
29
|
|
|
30
|
#### @link registry Theme Registry @endlink
|
|
31
|
- @link theme_preprocess Preprocess Functions (.vars.php) @endlink
|
|
32
|
- @link theme_process Process Functions (.vars.php) @endlink
|
|
33
|
- @link templates Templates (.tpl.php) @endlink
|
|
34
|
- @link theme_functions Theme Functions (.func.php) @endlink
|
|
35
|
|
|
36
|
#### @link api APIs @endlink
|
|
37
|
|
|
38
|
#### @link contribute Contribute @endlink
|
|
39
|
- @link contribute_maintainers Project Maintainers @endlink
|
|
40
|
|
|
41
|
---
|
|
42
|
|
|
43
|
## Terminology
|
|
44
|
|
|
45
|
The term **"bootstrap"** can be used excessively through out this project's
|
|
46
|
documentation. For clarity, we will always attempt to use this word verbosely
|
|
47
|
in one of the following ways:
|
|
48
|
|
|
49
|
- **[Drupal Bootstrap]** refers to the Drupal base theme project.
|
|
50
|
- **[Bootstrap Framework](https://getbootstrap.com/docs/3.3/)** refers to the external
|
|
51
|
front end framework.
|
|
52
|
- **[drupal_bootstrap](https://api.drupal.org/apis/drupal_bootstrap)** refers
|
|
53
|
to Drupal's bootstrapping process or phase.
|
|
54
|
|
|
55
|
When referring to files inside the [Drupal Bootstrap] project directory, they
|
|
56
|
will always start with `./bootstrap` and continue to specify the full path to
|
|
57
|
the file or directory inside it. For example, the file that is responsible for
|
|
58
|
displaying the text on this page is located at `./bootstrap/docs/README.md`.
|
|
59
|
|
|
60
|
When referring to files inside a sub-theme, they will always start with
|
|
61
|
`./subtheme/` and continue to specify the full path to the file or directory
|
|
62
|
inside it. For example, the primary file Drupal uses to determine if a theme
|
|
63
|
exists is: `./subtheme/subtheme.info`, where `subtheme` is the machine name of
|
|
64
|
your sub-theme.
|
|
65
|
|
|
66
|
[Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
|
