jekyll-theme-bas-style-kit 0.3.0 → 0.4.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c4a0ad3f7b4d4ea061ee635069310aaa47dadafa329cf8fb4cdf162ec5f6a4a
-  data.tar.gz: 7f290f1fdc4c35b91360a265ff43bd9eb86318f1e0187cc88e4c8e63c6ab8be6
+  metadata.gz: 56555ac55dcbd9b60a0174ebf1bc822c5494b50e990545b7de4d8cb71ace6377
+  data.tar.gz: '0790272e4228b918ab7311136def958ea5596d6354150880efd872d71ae40613'
 SHA512:
-  metadata.gz: 5f5369159555c464aa379e64b72382fba00731a5d859c12dc72f171d4702b7033b89d97a6630805c9a14bfd2f40858255eaeb2583f42bfada3d59dd1334df6b4
-  data.tar.gz: cd15e48fe799f1ef7e8c539150706ea2913850e18b601710065a8c55551b0ef5c34baef3a314f99b83e592910d42dc41a962e071a7ddb48d621a9eaa9533ac99
+  metadata.gz: 6ca7a0b3411e6c197d77e4fe60fac685eea5cb87b9261923fac7c1e457d721c7ce9bb72d8078e10dd2eaad29d4b9e71a64581b7c2c8fa342366ce7f79403f859
+  data.tar.gz: 2b3503db0158d223296aae3964553e578a75eac259d667fff705011ed04070c73247226f7a9741a395adb035e891dd3024c7de401f0015eb8fda2a7eefc5712d

data/CHANGELOG.md

@@ -3,10 +3,33 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## 0.3.0 - 28/02/2018 - BREAKING!
-
 ## [Unreleased][unreleased]
 
+### Added
+
+* 'is something wrong' and 'back to top' footer includes with optional footer spacer when used with footer content
+* Governance statement for use in footers
+* Table of Contents (TOC) generic include
+* Table of Contents (TOC) Style Kit include
+* Page title Style Kit include
+* Standard page layout
+
+### Changed [BREAKING!]
+
+* Refactored OGL statement as part of the new governance statement footer include, requiring some variable changes
+* Upgraded to Style Kit 0.4.0-beta
+
+### Fixed
+
+* Default URLs to legal policies
+
+### Changed
+
+* Updating order of legal policy links and copyright statement (also changed to 'British Antarctic Survey')
+* Updating project copyright from NERC to UKRI
+
+## 0.3.0 - 28/02/2018 - BREAKING!
+
 ### Changed [BREAKING!]
 
 * Re-licensing project under the Open Government License

data/LICENSE.md

@@ -1,6 +1,6 @@
 # License
 
-© Natural Environment Research Council (NERC), 2017-2018, British Antarctic Survey.
+© UK Research and Innovation (UKRI), 2017-2018, British Antarctic Survey.
 
 You may use and re-use this software and associated documentation files free of charge in any format or medium, under 
 the terms of the Open Government Licence v3.0.

data/README.md

@@ -66,7 +66,8 @@ defaults:
 #### Style Kit specific layouts
 
 * [`bsk--base`](/docs/layout/bsk--base.md)
-* [`bsk--base`](/docs/layout/bsk--standard.md)
+* [`bsk--standard`](/docs/layout/bsk--standard.md)
+* [`bsk--standard-page`](/docs/layout/bsk--standard-page.md)
 
 ### Includes
 
@@ -86,6 +87,7 @@ All includes are namespaced using a `bas-style-kit/` directory - i.e. the includ
 
 * [`head`](/docs/include/head.md)
 * [`body`](/docs/include/body.md)
+* [`toc`](/docs/include/toc.md)
 
 #### Style Kit specific includes
 
@@ -107,12 +109,16 @@ HTML Body includes:
 * [`bsk-body--back-to-top`](/docs/include/bsk-body--back-to-top.md)
 * [`bsk-body--standard-header`](/docs/include/bsk-body--standard-header.md)
 * [`bsk-body--standard-footer`](/docs/include/bsk-body--standard-footer.md)
+* [`bsk-body--page-header`](/docs/include/bsk-body--page-header.md)
+* [`bsk-body--toc`](/docs/include/bsk-body--toc.md)
 
 Footer includes:
 
+* [`bsk-footer--back-to-top`](/docs/include/bsk-footer--back-to-top.md)
 * [`bsk-footer--contents`](/docs/include/bsk-footer--contents.md)
+* [`bsk-footer--governance`](/docs/include/bsk-footer--governance.md)
+* [`bsk-footer--is-something-wrong`](/docs/include/bsk-footer--is-something-wrong.md)
 * [`bsk-footer--legal-policies`](/docs/include/bsk-footer--legal-policies.md)
-* [`bsk-footer--ogl`](/docs/include/bsk-footer--ogl.md)
 
 Header includes:
 
@@ -162,6 +168,10 @@ Refer to [Jekyll's documentation](https://jekyllrb.com/docs/configuration/) for
 Configuration options are used extensively throughout this theme. Some variables are used to set properties such as the
 brand text or image in the navbar (attributes), others are used to enable various features (feature flags).
 
+Configuration options operate at different scopes, *site* or *page*. Site options applies to across a site, whereas 
+page options can be applied to specific content items. Default values can be set for page options, which can then be
+overridden by specific content items.
+
 Configuration options for this theme are namespaced under a `bas_style_kit_jekyll_theme` option - i.e. an option `foo`
 is set as `bas_style_kit_jekyll_theme.foo`.
 
@@ -300,8 +310,10 @@ $ docker-compose push
 [2]
 
 ```shell
+# add 'entrypoint: ash' to the app service in /docker-compose.yml
 $ docker-compose run app gem build jekyll-theme-bas-style-kit.gemspec
 $ docker-compose run app gem push jekyll-theme-bas-style-kit-*.gem
+# remove 'entrypoint: ash' from the app service in /docker-compose.yml
 ```
 
 **Note:** Add `entrypoint: ash` to the `app` service in `docker-compose.yml` to run these commands
@@ -320,7 +332,7 @@ The maintainer of this project is the BAS Web & Applications Team, they can be c
 
 ## License
 
-© Natural Environment Research Council (NERC), 2017 - 2018, British Antarctic Survey.
+© UK Research and Innovation (UKRI), 2017-2018, British Antarctic Survey.
 
 You may use and re-use this software and associated documentation files free of charge in any format or medium, under 
 the terms of the Open Government Licence v3.0.

data/_config.yml

@@ -19,7 +19,7 @@ plugins:
 # Set default permalink format
 permalink: pretty
 
-# Theme settings
+# Theme settings - global variables
 #
 
 bas_style_kit_jekyll_theme:
@@ -33,8 +33,11 @@ bas_style_kit_jekyll_theme:
       site_navigation: true
       development_phase: true
     standard_footer:
+      is_something_wrong: true
+      back_to_top: true
+      spacer: false
       divider: true
-      ogl: true
+      governance: true
       legal_policies: true
   attributes:
     container: fixed
@@ -62,9 +65,22 @@ bas_style_kit_jekyll_theme:
     site_footer:
       ogl:
         href: 'http://www.nationalarchives.gov.uk/doc/open-government-licence'
-        img: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.3.0/img/logos-symbols/ogl-symbol-inverse-transparent-32.png'
         text_version: 'v3.0'
       legal_policies:
-        copyright_href: '/legal/copyright.html'
-        cookies_href: '/legal/copyright.html'
-        privacy_href: '/legal/privacy.html'
+        copyright_href: '/legal/copyright'
+        cookies_href: '/legal/cookies'
+        privacy_href: '/legal/privacy'
+
+# Theme settings - defaults for page level variables
+#
+
+defaults:
+  -
+    scope:
+      # an empty string here means all files in the project
+      path: ""
+    values:
+      bas_style_kit_jekyll_theme:
+        feature_flags:
+          page:
+            toc: true

data/_data/bas-style-kit/bsk-css.yml

@@ -1,5 +1,5 @@
 ---
 -
-    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.3.0/css/bas-style-kit.min.css'
-    integrity: 'sha256-yuFC35HZoRiUo5Gkp630hHWFrnmDpoYFsh54qYo2HPc='
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.4.0-beta/css/bas-style-kit.min.css'
+    integrity: 'sha256-yLdM6BCsb9KLkrDyGbHke/Wyuu+XYitHJPkBNJLukQE='
     type: 'remote'

data/_data/bas-style-kit/bsk-js.yml

@@ -8,6 +8,6 @@
     integrity: 'sha256-EareStqgZTnMUqLWtDkCa3SldvB8NPBY8u5C6ZUMWRc='
     type: 'remote'
 -
-    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.3.0/js/bas-style-kit.min.js'
-    integrity: 'sha256-QbuFUcH4HIGWW9ch0hO/j+GkhxP4QNdWWGyHE9lIlc8='
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.4.0-beta/js/bas-style-kit.min.js'
+    integrity: 'sha256-buOvInyhMJKHpUjqgaYtulG026RRSemvLNsl3xfXsGQ='
     type: 'remote'

data/_data/bas-style-kit/bsk-vars.yml

@@ -1,3 +1,3 @@
 ---
-theme_version: "0.3.0-develop"
-bsk_version: "0.3.0"
+theme_version: "0.3.0"
+bsk_version: "0.4.0-beta"

data/_includes/bas-style-kit/bsk-body--page-header.html

@@ -0,0 +1,3 @@
+<header class="bsk-page-header">
+  <h1>{{ page.title }}</h1>
+</header>

data/_includes/bas-style-kit/bsk-body--standard-footer.html

@@ -1,12 +1,21 @@
 <footer class="site-footer">
     <div class="bsk-footer bsk-footer-default">
         <div class="{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}bsk-container{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}bsk-container-fluid{% endif %}">
+            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.is_something_wrong == true %}
+                {% include bas-style-kit/bsk-footer--is-something-wrong.html %}
+            {% endif %}
+            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.back_to_top == true %}
+                {% include bas-style-kit/bsk-footer--back-to-top.html %}
+            {% endif %}
+            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.spacer == true %}
+                <div role="separator" class="bsk-footer-spacer"></div>
+            {% endif %}
             {% include bas-style-kit/bsk-footer--contents.html %}
             {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.divider == true %}
                 <div role="separator" class="bsk-footer-divider"></div>
             {% endif %}
-            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.ogl == true %}
-                {% include bas-style-kit/bsk-footer--ogl.html %}
+            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.governance == true %}
+                {% include bas-style-kit/bsk-footer--governance.html %}
             {% endif %}
             {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.legal_policies == true %}
                 {% include bas-style-kit/bsk-footer--legal-policies.html %}

data/_includes/bas-style-kit/bsk-body--toc.html

@@ -0,0 +1 @@
+{% include bas-style-kit/toc.html html=content h_min=2 %}

data/_includes/bas-style-kit/bsk-footer--back-to-top.html

@@ -0,0 +1,5 @@
+<div class="bsk-footer-back-to-top">
+    <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_back_to_top_target_href }}">
+        <i class="fa fa-fw fa-chevron-up" aria-hidden="true"></i> Back to top
+    </a>
+</div>

data/_includes/bas-style-kit/bsk-footer--governance.html

@@ -0,0 +1,5 @@
+<div class="bsk-footer-governance">
+    The <a href="https://www.bas.ac.uk">British Antarctic Survey</a> (BAS) is part of <a href="https://www.ukri.org">UK Research and Innovation</a> (UKRI)
+    <div class="bsk-footer-ogl"><div class="bsk-ogl-symbol"><a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.href }}" rel="license"><span class="bsk-ogl-symbol">Open Government Licence</span></a></div>
+    All content is available under the <a href="http://www.nationalarchives.gov.uk/doc/open-government-licence" rel="license">Open Government Licence {{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.text_version }}</a>, except where otherwise stated</div>
+</div>

data/_includes/bas-style-kit/bsk-footer--is-something-wrong.html

@@ -0,0 +1,3 @@
+<div class="bsk-footer-is-something-wrong">
+    <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_feedback_href }}">Is something wrong with this page?</a>
+</div>

data/_includes/bas-style-kit/bsk-footer--legal-policies.html

@@ -1,8 +1,8 @@
 <div class="bsk-footer-policy-links">
-    © {{site.time | date: "%Y"}} NERC BAS
     <ul class="bsk-list-inline">
         <li><a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href }}"> Cookies</a></li>
         <li><a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.copyright_href }}"> Copyright</a></li>
         <li><a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.privacy_href }}"> Privacy</a></li>
     </ul>
+    © {{site.time | date: "%Y"}} British Antarctic Survey
 </div>

data/_includes/bas-style-kit/toc.html

@@ -0,0 +1,85 @@
+{% capture tocWorkspace %}
+    {% comment %}
+        Version 1.0.4
+          https://github.com/allejo/jekyll-toc
+
+        "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe
+
+        Usage:
+            {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %}
+
+        Parameters:
+            * html       (string) - the HTML of compiled markdown generated by kramdown in Jekyll
+
+        Optional Parameters:
+            * sanitize   (bool)   : false  - when set to true, the headers will be stripped of any HTML in the TOC
+            * class      (string) :   ''   - a CSS class assigned to the TOC
+            * id         (string) :   ''   - an ID to assigned to the TOC
+            * h_min      (int)    :   1    - the minimum TOC header level to use; any header lower than this value will be ignored
+            * h_max      (int)    :   6    - the maximum TOC header level to use; any header greater than this value will be ignored
+            * ordered    (bool)   : false  - when set to true, an ordered list will be outputted instead of an unordered list
+            * item_class (string) :   ''   - add custom class for each list item; has support for '%level%' placeholder, which is the current heading level
+
+        Output:
+            An ordered or unordered list representing the table of contents of a markdown block. This snippet will only generate the table of contents and will NOT output the markdown given to it
+    {% endcomment %}
+
+    {% capture my_toc %}{% endcapture %}
+    {% assign orderedList = include.ordered | default: false %}
+    {% assign minHeader = include.h_min | default: 1 %}
+    {% assign maxHeader = include.h_max | default: 6 %}
+    {% assign nodes = include.html | split: '<h' %}
+    {% assign firstHeader = true %}
+
+    {% capture listModifier %}{% if orderedList %}1.{% else %}-{% endif %}{% endcapture %}
+
+    {% for node in nodes %}
+        {% if node == "" %}
+            {% continue %}
+        {% endif %}
+
+        {% assign headerLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
+
+        {% if headerLevel < minHeader or headerLevel > maxHeader %}
+            {% continue %}
+        {% endif %}
+
+        {% if firstHeader %}
+            {% assign firstHeader = false %}
+            {% assign minHeader = headerLevel %}
+        {% endif %}
+
+        {% assign indentAmount = headerLevel | minus: minHeader | add: 1 %}
+        {% assign _workspace = node | split: '</h' %}
+
+        {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+        {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+        {% assign html_id = _idWorkspace[0] %}
+
+        {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+        {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+        {% assign space = '' %}
+        {% for i in (1..indentAmount) %}
+            {% assign space = space | prepend: '    ' %}
+        {% endfor %}
+
+        {% unless include.item_class == blank %}
+            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
+        {% endunless %}
+
+        {% capture my_toc %}{{ my_toc }}
+{{ space }}{{ listModifier }} {{ listItemClass }} [{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}](#{{ html_id }}){% endcapture %}
+
+    {% endfor %}
+
+    {% if include.class %}
+        {% capture my_toc %}{:.{{ include.class }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+
+    {% if include.id %}
+        {% capture my_toc %}{: #{{ include.id }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}

data/_layouts/bas-style-kit/bsk--standard-page.html

@@ -0,0 +1,22 @@
+---
+layout: bas-style-kit/bsk--standard
+---
+
+<div class="bsk-row">
+  <div class="bsk-col-12-sm-12 bsk-col-12-md-9 bsk-col-12-xl-10 bsk-col-12-md-offset-3 bsk-col-12-xl-offset-2">
+    {% include bas-style-kit/bsk-body--page-header.html %}
+  </div>
+</div>
+<div class="bsk-row">
+  {% if page.bas_style_kit_jekyll_theme.feature_flags.page.toc == true %}
+    <div class="bsk-col-12-sm-12 bsk-col-12-md-3 bsk-col-12-lg-3 bsk-col-12-xl-2">
+      <aside class="bsk-sidebar bsk-sidebar-default">
+        <h2>Contents</h2>
+        {% include bas-style-kit/bsk-body--toc.html %}
+      </aside>
+    </div>
+  {% endif %}
+  <div class="bsk-col-12-sm-12 bsk-col-12-md-9 bsk-col-12-xl-10 {% unless page.bas_style_kit_jekyll_theme.feature_flags.page.toc == true %}bsk-col-12-md-offset-3 bsk-col-12-xl-offset-2{% endunless %}">
+    {{ content }}
+  </div>
+</div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-bas-style-kit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0.alpha
 platform: ruby
 authors:
 - Felix Fennell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -138,13 +138,17 @@ files:
 - _includes/bas-style-kit/bsk-body--analytics-script.html
 - _includes/bas-style-kit/bsk-body--back-to-top.html
 - _includes/bas-style-kit/bsk-body--core-scripts.html
+- _includes/bas-style-kit/bsk-body--page-header.html
 - _includes/bas-style-kit/bsk-body--standard-footer.html
 - _includes/bas-style-kit/bsk-body--standard-header.html
 - _includes/bas-style-kit/bsk-body--standard.html
+- _includes/bas-style-kit/bsk-body--toc.html
 - _includes/bas-style-kit/bsk-body.html
+- _includes/bas-style-kit/bsk-footer--back-to-top.html
 - _includes/bas-style-kit/bsk-footer--contents.html
+- _includes/bas-style-kit/bsk-footer--governance.html
+- _includes/bas-style-kit/bsk-footer--is-something-wrong.html
 - _includes/bas-style-kit/bsk-footer--legal-policies.html
-- _includes/bas-style-kit/bsk-footer--ogl.html
 - _includes/bas-style-kit/bsk-head--core-meta.html
 - _includes/bas-style-kit/bsk-head--core-styles.html
 - _includes/bas-style-kit/bsk-head--favicon.html
@@ -160,12 +164,14 @@ files:
 - _includes/bas-style-kit/bsk-nav-header--brand.html
 - _includes/bas-style-kit/bsk-nav-header--collapse-trigger.html
 - _includes/bas-style-kit/head.html
+- _includes/bas-style-kit/toc.html
 - _layouts/bas-style-kit/blank.html
 - _layouts/bas-style-kit/bsk--base.html
+- _layouts/bas-style-kit/bsk--standard-page.html
 - _layouts/bas-style-kit/bsk--standard.html
 - _layouts/bas-style-kit/html.html
 - screenshot.png
-homepage: https://gitlab.data.bas.ac.uk/BSK/bas-style-kit-jekyll-theme
+homepage: https://github.com/antarctica/bas-style-kit-jekyll-theme
 licenses:
 - Nonstandard
 metadata:
@@ -181,9 +187,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.4

data/_includes/bas-style-kit/bsk-footer--ogl.html

@@ -1,9 +0,0 @@
-<div class="bsk-footer-ogl">
-    <a class="bsk-ogl-symbol" rel="license" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.href }}">
-        <img alt="Open Government Licence symbol" src="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.img }}" />
-    </a>
-    <div class="bsk-ogl-text">
-        This website is licensed under the 
-        <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.href }}">Open Government Licence {{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.text_version }}</a>
-        , except where otherwise stated</div>
-</div>