Commit 5d9cce7b authored by markcarver's avatar markcarver

Follow-up to http://bit.ly/29w2Mso

parent 0c0fca91
......@@ -23,6 +23,6 @@ This base theme bridges the gap between Drupal and the [Bootstrap Framework].
### Documentation
Visit the project's [official documentation site](http://drupal-bootstrap.org)
or the markdown files inside the `./docs` folder.
or the markdown files inside the `./docs` directory.
[Bootstrap Framework]: http://getbootstrap.com
......@@ -6,17 +6,17 @@
* This file should only contain light helper functions and point to stubs in
* other files containing more complex functions.
*
* The stubs should point to files within the `./includes` folder named after
* The stubs should point to files within the `./includes` directory named after
* the function itself minus the theme prefix. If the stub contains a group of
* functions, then please organize them so they are related in some way and name
* the file appropriately to at least hint at what it contains.
*
* All [pre]process functions, theme functions and template files lives inside
* the `./templates` folder. This is a highly automated and complex system
* the `./templates` directory. This is a highly automated and complex system
* designed to only load the necessary files when a given theme hook is invoked.
*
* Visit this project's official documentation site, http://drupal-bootstrap.org
* or the markdown files inside the `./docs` folder.
* or the markdown files inside the `./docs` directory.
*
* @see bootstrap_theme()
* @see \Drupal\bootstrap\Registry
......
......@@ -4,7 +4,7 @@
## Installation
- Install the Bootstrap base theme in `themes` or a similar `sites/*/themes`
folder.
directory.
- Enable the [Drupal Bootstrap] base theme.
## Bootstrap Framework Fundamentals
......
......@@ -22,7 +22,7 @@ Suffice it to say: you will not have to manually update this project again.
After you have installed the prerequisite CLI tools, run `npm install` in this
directory. This will install the necessary NodeJS modules inside the
`node_modules` folder.
`node_modules` directory.
After NodeJS has finished installing its own modules, it will automatically
invoke `grunt install` for you. This is a grunt task that is specifically
......@@ -64,7 +64,7 @@ next time they pull down the repository.
### `grunt sync`
This is a sub-task used by `grunt install`. It will automatically
download and install the various 3.x.x versions of the Bootstrap and Bootswatch
libraries for local development purposes in the `./lib` folder. This process
libraries for local development purposes in the `./lib` directory. This process
utilizes Bower and can initially take a while for it to fully complete.
Once you have the various versions of libraries have been installed, this task
......
......@@ -26,10 +26,10 @@ Once you've selected one of the above starterkits, here's how to install it:
1. Copy over one of the starterkits you have chosen from the
`./bootstrap/starterkits` directory into the `themes` directory.
2. Rename the folder to a unique machine readable name. This will be your
2. Rename the directory to a unique machine readable name. This will be your
sub-theme's "name". For this example and future examples we'll use `subtheme`.
3. Rename `./subtheme/THEMENAME.starterkit.yml` to match the folder name and append
`.info.yml` (e.g. `./subtheme/subtheme.info.yml`).
3. Rename `./subtheme/THEMENAME.starterkit.yml` to match the directory name and
append `.info.yml` (e.g. `./subtheme/subtheme.info.yml`).
4. Open `./subtheme/subtheme.info.yml` and change the name, description and any
other properties to suite your needs. Make sure to change the library name:
`- THEMENAME/globalstyling` to `- subtheme/globalstyling` as well.
......
......@@ -31,7 +31,7 @@ container construction since a theme could vary from page to page (in theory).
So, instead, this base theme implements its own annotated discovery plugins
to leverage the powerful inheritance capabilities of PHP class instances.
All of these plugins can be found in the following folders and are discussed,
All of these plugins can be found in the following directories and are discussed,
in length, below in their respective sub-topics:
- `./bootstrap/src/Plugin/Alter`
- `./bootstrap/src/Plugin/Form`
......
......@@ -108,7 +108,7 @@ class JsDelivr extends ProviderBase {
]);
// Expected library names from jsDelivr API v1. Must use "twitter-bootstrap"
// instead of "bootstrap" (which is just a folder alias).
// instead of "bootstrap" (which is just a directory alias).
// @see https://www.drupal.org/node/2504343
// @see https://github.com/jsdelivr/api/issues/94
$bootstrap = 'twitter-bootstrap';
......
......@@ -23,7 +23,7 @@ use Drupal\Core\Extension\ThemeHandlerInterface;
class Theme {
/**
* Ignores the following folders during file scans of a theme.
* Ignores the following directories during file scans of a theme.
*
* @see \Drupal\bootstrap\Theme::IGNORE_ASSETS
* @see \Drupal\bootstrap\Theme::IGNORE_CORE
......@@ -33,17 +33,17 @@ class Theme {
const IGNORE_DEFAULT = -1;
/**
* Ignores the folders "assets", "css", "images" and "js".
* Ignores the directories "assets", "css", "images" and "js".
*/
const IGNORE_ASSETS = 0x1;
/**
* Ignores the folders "config", "lib" and "src".
* Ignores the directories "config", "lib" and "src".
*/
const IGNORE_CORE = 0x2;
/**
* Ignores the folders "docs" and "documentation".
* Ignores the directories "docs" and "documentation".
*/
const IGNORE_DOCS = 0x4;
......@@ -53,7 +53,7 @@ class Theme {
const IGNORE_DEV = 0x8;
/**
* Ignores the folders "templates" and "theme".
* Ignores the directories "templates" and "theme".
*/
const IGNORE_TEMPLATES = 0x16;
......
Use this folder to override template, theme and \[pre\]process functions.
Use this directory to override template, theme and \[pre\]process functions.
Please refer to the @link registry Theme Registry @endlink topic for more info.
......@@ -21,13 +21,13 @@ preprocessor.
## Additional Setup {#setup}
Download and extract the **latest** 3.x.x version of
[Bootstrap Framework Source Files] into the root your new sub-theme. After it
has been extracted, the folder should be renamed (if needed) so it reads
[Bootstrap Framework Source Files] into the root of your new sub-theme. After
it has been extracted, the directory should be renamed (if needed) so it reads
`./subtheme/bootstrap`.
If for whatever reason you have an additional `bootstrap` folder wrapping the
first `bootstrap` folder (e.g. `./subtheme/bootstrap/bootstrap`), remove the
wrapping `bootstrap` folder. You will only ever need to touch these files if
If for whatever reason you have an additional `bootstrap` directory wrapping the
first `bootstrap` directory (e.g. `./subtheme/bootstrap/bootstrap`), remove the
wrapping `bootstrap` directory. You will only ever need to touch these files if
or when you upgrade your version of the [Bootstrap Framework].
{.alert.alert-warning} **WARNING:** Do not modify the files inside of
......
Use this folder to override template, theme and \[pre\]process functions.
Use this directory to override template, theme and \[pre\]process functions.
Please refer to the @link registry Theme Registry @endlink topic for more info.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment