Updated to Drupal 8.5. Core Media not yet in use.
[yaffs-website] / web / themes / contrib / bootstrap / docs / Sub-Theming.md
index 605315f54e68db53919a64b4bd9a291d0cc56984..78db638ea22fc9a601e9b2171eb0a52ba145ac6d 100644 (file)
@@ -8,59 +8,60 @@ are instructions on how to create a [Drupal Bootstrap] based sub-theme.
 There are several different variations on how to accomplish this task, but this
 topic will focus on the two primarily and most common ways.
 
 There are several different variations on how to accomplish this task, but this
 topic will focus on the two primarily and most common ways.
 
-{.alert.alert-warning} **Warning** You should never modify any theme or sub-theme that 
-is packaged and released from Drupal.org, such as Drupal Bootstrap. If you 
-do, all changes you have made will be lost once that theme is updated. Instead, 
-you should create a subtheme from one of the provided starterkits (this is 
-considered a best practice). Once you've done that, you can override CSS, 
-templates, and theme processing.
+{.alert.alert-warning} **Warning** You should never modify any theme or
+sub-theme that is packaged and released from Drupal.org, such as Drupal
+Bootstrap. If you do, all changes you have made will be lost once that theme is
+updated. Instead, you should create a subtheme from one of the provided
+starterkits (this is considered a best practice). Once you've done that, you
+can override CSS, templates, and theme processing.
 
 #### Choose a Starterkit {#starterkit}
 
 - @link sub_theming_cdn CDN Starterkit @endlink - uses the "out-of-the-box"
   CSS and JavaScript files served by the [jsDelivr CDN].
 
 #### Choose a Starterkit {#starterkit}
 
 - @link sub_theming_cdn CDN Starterkit @endlink - uses the "out-of-the-box"
   CSS and JavaScript files served by the [jsDelivr CDN].
-- @link sub_theming_less Less Starterkit @endlink - uses the [Bootstrap Framework]
-  [Less] source files and a local [Less] preprocessor.
-- @link sub_theming_sass Sass Starterkit @endlink - uses the [Bootstrap Framework]
-  [Sass] source files and a local [Sass] preprocessor.
+- @link sub_theming_less Less Starterkit @endlink - uses the
+  [Bootstrap Framework] [Less] source files and a local [Less] preprocessor.
+- @link sub_theming_sass Sass Starterkit @endlink - uses the
+  [Bootstrap Framework] [Sass] source files and a local [Sass] preprocessor.
 
 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.
 
 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 directory to a unique machine readable name. This is your sub-theme's
-   "machine name". When referring to files inside a sub-theme, they will always
-   start with `./THEMENAME/`, where `THEMENAME` is the machine name of your
-   sub-theme. They will continue to specify the full path to the file or
-   directory inside it. For example, the primary file Drupal uses to determine
-   if a theme exists is: `./THEMENAME/THEMENAME.info.yml`.
+2. Rename the directory to a unique machine readable name. This is your
+   sub-theme's "machine name". When referring to files inside a sub-theme,
+   they will always start with `./THEMENAME/`, where `THEMENAME` is the machine
+   name of your sub-theme. They will continue to specify the full path to the
+   file or directory inside it. For example, the primary file Drupal uses to
+   determine if a theme exists is: `./THEMENAME/THEMENAME.info.yml`.
 3. Rename `./THEMENAME/THEMENAME.starterkit.yml` to match
 3. Rename `./THEMENAME/THEMENAME.starterkit.yml` to match
-   `./THEMENAME/THEMENAME.info.yml`. Also, rename `./THEMENAME/THEMENAME.libraries.yml` 
-   and `./THEMENAME/THEMENAME.theme` as well.
-4. Open `./THEMENAME/THEMENAME.info.yml` and change the name, description and any
-   other properties to suite your needs. Make sure to rename the library name as
-   well:  `- THEMENAME/global-styling`.
-5. Rename the sub-theme configuration files, located at:
+   `./THEMENAME/THEMENAME.info.yml`.
+4. Rename `./THEMENAME/THEMENAME.libraries.yml`
+5. Rename `./THEMENAME/THEMENAME.theme`.
+6. Open `./THEMENAME/THEMENAME.info.yml` and change the name, description and
+   any other properties to suite your needs. Make sure to rename the library
+   extension name as well:  `THEMENAME/framework`.
+7. Rename the sub-theme configuration files, located at:
    `./THEMENAME/config/install/THEMENAME.settings.yml` and
    `./THEMENAME/config/schema/THEMENAME.schema.yml`.
    `./THEMENAME/config/install/THEMENAME.settings.yml` and
    `./THEMENAME/config/schema/THEMENAME.schema.yml`.
-6. Open `./THEMENAME/config/schema/THEMENAME.schema.yml` and rename
+8. Open `./THEMENAME/config/schema/THEMENAME.schema.yml` and rename
    `- THEMENAME.settings:` and `'THEMETITLE settings'`
 
 {.alert.alert-warning} **WARNING:** Ensure that the `.starterkit` suffix is
    `- THEMENAME.settings:` and `'THEMETITLE settings'`
 
 {.alert.alert-warning} **WARNING:** Ensure that the `.starterkit` suffix is
-not present on your sub-theme's `.info.yml` filename. This suffix is simply a stop
-gap measure to ensure that the bundled starter kit sub-theme cannot be enabled
-or used directly. This helps people unfamiliar with Drupal avoid modifying the
-starter kit sub-theme directly and instead forces them to create a new sub-theme
-to modify.
+not present on your sub-theme's `.info.yml` filename. This suffix is simply a
+stop gap measure to ensure that the bundled starter kit sub-theme cannot be
+enabled or used directly. This helps people unfamiliar with Drupal avoid
+modifying the starter kit sub-theme directly and instead forces them to create
+a new sub-theme to modify.
 
 #### Enable Your New Sub-theme {#enable}
 In your Drupal site, navigate to `admin/appearance` and click the `Enable and
 
 #### Enable Your New Sub-theme {#enable}
 In your Drupal site, navigate to `admin/appearance` and click the `Enable and
-set default` link next to your newly created sub-theme. Now that you've enabled
-your starterkit, please refer to the starterkit's documentation page to customize.
-
+set default` link next to your newly created sub-theme. Now that you've
+enabled your starterkit, please refer to the starterkit's documentation page
+to customize.
 
 [Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
 
 [Drupal Bootstrap]: https://www.drupal.org/project/bootstrap
-[Bootstrap Framework]: http://getbootstrap.com
+[Bootstrap Framework]: https://getbootstrap.com/docs/3.3/
 [jsDelivr CDN]: http://www.jsdelivr.com
 [Less]: http://lesscss.org
 [Sass]: http://sass-lang.com
 [jsDelivr CDN]: http://www.jsdelivr.com
 [Less]: http://lesscss.org
 [Sass]: http://sass-lang.com