jekyll-theme-bas-style-kit 0.9.0 → 0.10.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f065e17e8b2747bf095b9856f103a51014fbfd34dd135beecac6e954b940920e
4
- data.tar.gz: 1a855495621e64329de7f966cf032488c11993f68529772623d4ad5d41309be4
3
+ metadata.gz: b908438db459e82826393134d985468e10310620aa50ad9aa64a37ea3f2315d3
4
+ data.tar.gz: 0a0cf92ed57a4d435fc80edc4e967d76517b4c1c070952a3af97dc443bb097ed
5
5
  SHA512:
6
- metadata.gz: 0e343338277106b1b48af5601725ebc03aaa1e1a07850fbad562c054241386a7a1b77af829a8a3e72f35615f6cd0123aa553aa6846940140ad2b8569c32a406e
7
- data.tar.gz: b31d0fc487db006bda7ca0019d483b00bbac0be3754d0091b2e77ad00bf0d3b24c97f9d2fad7de19f97fcc4912e8508c5bb1975be6dd43dec01edc4330c81134
6
+ metadata.gz: 6798c1642676febbb0a84bc8cc86737252bdcb802707fa8a568152f72860a43732d4c89e9f09233d5c5169ebbbb59d35a6ac696e4eb6b642cbef9d0f206ce44c
7
+ data.tar.gz: 8802655c6262bc25076cda5fc0c4a3064ed64b82dc331bf9585337940bae59ae139c8f92d2e2d6273f27c3f14c0da5ee722d5ddf5862812fe357140b43456964
@@ -5,6 +5,28 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
5
5
 
6
6
  ## [Unreleased][unreleased]
7
7
 
8
+ ### Removed
9
+
10
+ * Synk testing due to incompatibility with modern bundler versions
11
+
12
+ ## 0.10.0 - 2020-06-27
13
+
14
+ ### Added
15
+
16
+ * Updated to Style Kit 0.6.0-beta
17
+ * Updated to JS Cookie 2.2.1
18
+ * Updated to jQuery 3.5.1
19
+ * Updated to Jekyll 4.1
20
+ * Updated Ruby dependencies
21
+ * Missing patterns for start and 'sign in' page patterns
22
+ * Support for new component patterns (item type header and ORCID iD)
23
+
24
+ ### Changed
25
+
26
+ * Feedback links changed to open in a new tab
27
+ * Updated licence dates
28
+ * Updated release procedures
29
+
8
30
  ## 0.9.0 - 2019-07-02
9
31
 
10
32
  ### Added
@@ -59,8 +81,8 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
59
81
  ### Changed [BREAKING!]
60
82
 
61
83
  * Icon uses replaced with alternatives or removed where not needed due to the removal of Font Awesome
62
- * Favicon attribute option changed, set `bas_style_kit_jekyll_theme.attributes.head_favicon` to `default` for the Style
63
- Kit favicon, other values will be ignored and no favicon will be set
84
+ * Favicon attribute option changed, set `bas_style_kit_jekyll_theme.attributes.head_favicon` to `default` for the Style
85
+ Kit favicon, other values will be ignored and no favicon will be set
64
86
 
65
87
  ### Added
66
88
 
@@ -129,7 +151,7 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
129
151
  * Re-licensing project under the Open Government License
130
152
  * Upgrading to Jekyll 3.7.2
131
153
  * Upgrading to Style Kit 0.3.0
132
- * Layouts, includes and data files are now in a `bas-style-kit` namespace
154
+ * Layouts, includes and data files are now in a `bas-style-kit` namespace
133
155
  * Generic *blank* and *HTML* layouts and associated includes have been redeveloped
134
156
  * The Style Kit layout has been split into *base* and *standard* layouts
135
157
  * Style Kit includes have been redeveloped and renamed
data/LICENSE.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # License
2
2
 
3
- © UK Research and Innovation (UKRI), 2017-2018, British Antarctic Survey.
3
+ © UK Research and Innovation (UKRI), 2017-2020, British Antarctic Survey.
4
4
 
5
- You may use and re-use this software and associated documentation files free of charge in any format or medium, under
5
+ You may use and re-use this software and associated documentation files free of charge in any format or medium, under
6
6
  the terms of the Open Government Licence v3.0.
7
7
 
8
8
  You may obtain a copy of the Open Government Licence at http://www.nationalarchives.gov.uk/doc/open-government-licence/
data/README.md CHANGED
@@ -90,7 +90,7 @@ site_navigation_launcher:
90
90
 
91
91
  #### Standard page
92
92
 
93
- To create a page in an application or website based on the standard BAS page structure, create an application layout
93
+ To create a page in an application or website based on the standard BAS page structure, create an application layout
94
94
  (e.g. `_layouts/app.html`) with the following:
95
95
 
96
96
  ```
@@ -113,7 +113,7 @@ defaults:
113
113
 
114
114
  #### Use a page pattern
115
115
 
116
- To create a page in an application or website based on a [page design pattern](#page-patterns), create a view
116
+ To create a page in an application or website based on a [page pattern](#page-patterns), create a view
117
117
  (e.g. `views/error.pug`) with the following:
118
118
 
119
119
  ```html
@@ -130,17 +130,25 @@ layout: views/bas-style-kit/bsk--page-not-found
130
130
  ---
131
131
  ```
132
132
 
133
+ #### Use a component pattern
134
+
135
+ To include a [component pattern](#component-pattern), call the relevant include with an required parameters.
136
+ For example:
137
+
138
+ ```
139
+ {% include bas-style-kit/bsk--pattern--item-type-header.html item_type="Item type" item_title="Item title" %}
140
+ ```
141
+
133
142
  ### Patterns
134
143
 
135
- Design patterns are used to demonstrate preferred ways to pass on information to users, or ask them for information.
136
- For example, information to show when a service is unavailable, formatting dates consistently or asking users for their
137
- username in a consistent way. See the [Style Kit documentation](https://style-kit.web.bas.ac.uk/patterns) for more
138
- information.
144
+ Patterns are used to define preferred ways to pass information to users, and ask information from users, in a consistent
145
+ way. See the [Style Kit documentation](https://style-kit.web.bas.ac.uk/patterns) for more information.
139
146
 
140
- These patterns are implemented by this theme based on the reference examples included in the Style Kit. These
141
- include patterns for:
147
+ There are two types of pattern used in the Style Kit and these templates:
142
148
 
143
- * [pages](#page-patterns) - standalone pages designed to be used without customisation, defined as [Views](#views)
149
+ * [pages](#page-patterns) - standalone pages designed to be used without customisation using [Views](#views)
150
+ * [components](#component-patterns) - inline elements designed to be used without customisation using
151
+ [Includes](#includes)
144
152
 
145
153
  #### Page patterns
146
154
 
@@ -155,9 +163,12 @@ No configuration options.
155
163
 
156
164
  ##### 'service unavailable' pattern
157
165
 
158
- Optionally, use page content for:
166
+ Use page content for:
159
167
 
160
168
  * contact information
169
+
170
+ Optionally, use page content for:
171
+
161
172
  * details of alternative services
162
173
 
163
174
  Optionally, use a `pattern_availability` page variable for setting the availability line:
@@ -168,19 +179,138 @@ Optionally, use a `pattern_availability` page variable for setting the availabil
168
179
 
169
180
  ##### 'problem with this service' pattern
170
181
 
171
- Optionally, use page content for:
182
+ Use page content for:
172
183
 
173
184
  * contact information
185
+
186
+ Optionally, use page content for:
187
+
174
188
  * details of alternative services
175
189
 
190
+ ##### 'start' pattern
191
+
192
+ Use page content for:
193
+
194
+ * a list of needs the service caters for, as a list wrapped in a section with the `bsk-service-uses` class [1]
195
+ * a call to action, as a link wrapped in a section with the `bsk-call-to-action` class [2]
196
+ * if the call to action should be a 'Sign in to start' button use [3]
197
+ * contact information, as text wrapped in a section with the `bsk-more-information` class [4]
198
+
199
+ Optionally, use page content for:
200
+
201
+ * 'before you start' information, wrapped in a section with the `bsk-before-you-start` class [5]
202
+
203
+ **Note:** If not already included via a layout, include
204
+ [Font Awesome](https://style-kit.web.bas.ac.uk/core/icons/#font-awesome) to show the ORCID symbol.
205
+
206
+ [1]
207
+
208
+ ```html
209
+ <section class="bsk-service-uses">
210
+ <h2 class="bsk-h3">Use this service to:</h2>
211
+ <ul>
212
+ <li>access some information</li>
213
+ <li>perform an action</li>
214
+ <li>etc.</li>
215
+ </ul>
216
+ </section>
217
+ ```
218
+
219
+ [2]
220
+
221
+ ```html
222
+ <section class="bsk-call-to-action">
223
+ <a class="bsk-btn bsk-btn-primary bsk-btn-lg" href="#">
224
+ Start Now
225
+ <i class="fa-fw fas fa-chevron-right"></i>
226
+ </a>
227
+ </section>
228
+ ```
229
+
230
+ [3]
231
+
232
+ ```html
233
+ <section class="bsk-call-to-action">
234
+ <button class="bsk-btn bsk-btn-ms-account bsk-btn-lg">
235
+ <object class="bsk-ms-pictogram" type="image/svg+xml" data="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/logos-symbols/ms-pictogram.svg"></object>
236
+ Sign in to start
237
+ <i class="fa-fw fas fa-chevron-right"></i>
238
+ </button>
239
+ <p class="bsk-sign-in-hint bsk-text-muted">Use the account you use for your NERC email to sign into this service.</p>
240
+ </section>
241
+ ```
242
+
243
+ [4]
244
+
245
+ ```html
246
+ <section class="bsk-more-information">
247
+ <h2 class="bsk-h3">More information</h2>
248
+ <p>Contact the <a href="#">Sample Team</a> for information and help on how to use [website or application].</p>
249
+ </section>
250
+ ```
251
+
252
+ [5]
253
+
254
+ ```html
255
+ <section class="bsk-before-you-start">
256
+ <h2 class="bsk-h3">Before you start</h2>
257
+ <p>You need some information to use this service.</p>
258
+ </section>
259
+ ```
260
+
261
+ ##### 'sign in' pattern
262
+
263
+ Use page content for:
264
+
265
+ * a call to action, as a page variable [1]
266
+
267
+ ```html
268
+ ---
269
+ layout: views/bas-style-kit/bsk--sign-in-microsoft
270
+
271
+ call_to_action_href: #
272
+ ---
273
+ ```
274
+
275
+ #### Component patterns
276
+
277
+ These templates use includes for all component patterns. Include parameters are used for customising each instance of
278
+ the component.
279
+
280
+ See the [Style Kit documentation](https://style-kit.web.bas.ac.uk) for general information on using these patterns.
281
+
282
+ ##### Item type header pattern
283
+
284
+ Parameters:
285
+
286
+ * `item_type` the type or kind of thing the item is, e.g. if the item is a person, it's type is 'person'
287
+ * `item_title` a label specific to the item, e.g. if the item is a person their name
288
+
289
+ ```html
290
+ {% include bas-style-kit/bsk--pattern--item-type-header.html item_type="Item type" item_title="Item title" %}
291
+ ```
292
+
293
+ ##### ORCID iD pattern
294
+
295
+ Parameters:
296
+
297
+ * `orcid_id` the ORCID iD of an individual as a URL
298
+
299
+ ```
300
+ {% include bas-style-kit/bsk--pattern--orcid-id.html orcid_id="https://sandbox.orcid.org/0000-0001-8373-6934" %}
301
+ ```
302
+
303
+ **Note:** If not already included via a layout, include
304
+ [Font Awesome](https://style-kit.web.bas.ac.uk/core/icons/#font-awesome) to show the ORCID symbol.
305
+
176
306
  ### Using custom CSS/JS
177
307
 
178
- Support is provided for loading additional CSS an/or JavaScript resources, such as application or website specific
308
+ Support is provided for loading additional CSS an/or JavaScript resources, such as application or website specific
179
309
  styling or interactivity, either as references to files.
180
310
 
181
311
  This support is available in all layouts which inherit from the `bsk--basic.html` layout.
182
312
 
183
- For file resources, variables are provided for adding URLs and optional SRI values. Files will be included in the
313
+ For file resources, variables are provided for adding URLs and optional SRI values. Files will be included in the
184
314
  relevant block automatically, after the Style Kit's own resources if a Style Kit layout is used.
185
315
 
186
316
  * CSS resources are outputted at the end of the `<head>` element
@@ -212,16 +342,16 @@ Resource objects have the following properties:
212
342
  | `type` | String | Yes | `local` or `remote` | `local` |
213
343
  | `integrity` | String | No | Any SRI value | `sha256-ClILH8AIH4CkAybtlKhzqqQUYR4eSDiNTK5LIWfF4qQ=` |
214
344
 
215
- The `integrity` property is used to specify a
216
- [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) value for
217
- a resource. If specified an `integrity` attribute and will be added to the generated markup. A `crossorigin`
218
- attribute will also be added for
219
- [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) support with a
220
- hard-coded, `anonymous`, value.
345
+ The `integrity` property is used to specify a
346
+ [Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) value for
347
+ a resource. If specified an `integrity` attribute and will be added to the generated markup. A `crossorigin`
348
+ attribute will also be added for
349
+ [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) support with a
350
+ hard-coded, `anonymous`, value.
221
351
 
222
352
  ### Navigation menu items
223
353
 
224
- When using the `bsk--standard.html` layout, a [navbar](https://style-kit.web.bas.ac.uk/components/navbar/) is included
354
+ When using the `bsk--standard.html` layout, a [navbar](https://style-kit.web.bas.ac.uk/components/navbar/) is included
225
355
  as part of the 'standard header', which consists of a cookie banner, navbar and site development phase banner.
226
356
 
227
357
  This navbar consists of three menus (and other elements, documented elsewhere):
@@ -230,8 +360,8 @@ This navbar consists of three menus (and other elements, documented elsewhere):
230
360
  2. a secondary navigation menu - aligned right, before the launcher menu
231
361
  3. a navigation launcher menu - aligned right, after the secondary navigation menu
232
362
 
233
- The navigation launcher is a restricted menu, used to link to other BAS websites and applications. By default it
234
- contains links to the [BAS public website](https://www.bas.ac.uk) and the [BAS data catalogue](https://data.bas.ac.uk).
363
+ The navigation launcher is a restricted menu, used to link to other BAS websites and applications. By default it
364
+ contains links to the [BAS public website](https://www.bas.ac.uk) and the [BAS data catalogue](https://data.bas.ac.uk).
235
365
  Other websites and applications can be added as well where relevant.
236
366
 
237
367
  The primary and secondary navigation menu's support:
@@ -254,21 +384,21 @@ All navigation menus are implemented using the [Jekyll menus](https://github.com
254
384
 
255
385
  ### Navigation branding
256
386
 
257
- [Navbars](https://style-kit.web.bas.ac.uk/components/navbar/) are also used to display the name/identity of a website
387
+ [Navbars](https://style-kit.web.bas.ac.uk/components/navbar/) are also used to display the name/identity of a website
258
388
  or application, to remind users where they are. These elements are referred to as 'brand' elements within the Style Kit.
259
389
 
260
- In the 'standard header', navbar brand elements are shown on the far left.
390
+ In the 'standard header', navbar brand elements are shown on the far left.
261
391
 
262
392
  Supported brand elements:
263
393
 
264
- * [brand text](https://style-kit.web.bas.ac.uk/components/navbar/#brand-text) - set using the
394
+ * [brand text](https://style-kit.web.bas.ac.uk/components/navbar/#brand-text) - set using the
265
395
  `bas_style_kit_jekyll_theme.attributes.site_brand.text` config variable
266
- * [brand image](https://style-kit.web.bas.ac.uk/components/navbar/#brand-image) - set using the
396
+ * [brand image](https://style-kit.web.bas.ac.uk/components/navbar/#brand-image) - set using the
267
397
  `bas_style_kit_jekyll_theme.attributes.site_brand.img` config variable
268
398
 
269
- Brand elements can be used together or individually, with fix classes applied automatically as needed.
399
+ Brand elements can be used together or individually, with fix classes applied automatically as needed.
270
400
 
271
- Brand elements are linked to a location specified by the `bas_style_kit_jekyll_theme.attributes.site_brand.href` config
401
+ Brand elements are linked to a location specified by the `bas_style_kit_jekyll_theme.attributes.site_brand.href` config
272
402
  variable, which should be the index of each website or application (i.e. `/`).
273
403
 
274
404
  ### Site development phase
@@ -276,14 +406,14 @@ variable, which should be the index of each website or application (i.e. `/`).
276
406
  The site development phase reflects the stage of development for a website or application, e.g. alpha or live. They are
277
407
  described in the Style Kit [here](https://style-kit.web.bas.ac.uk/core/colours/#development-phase-colours).
278
408
 
279
- For websites or applications that are not firmly in the 'live' phase, a banner should be shown to inform users and
409
+ For websites or applications that are not firmly in the 'live' phase, a banner should be shown to inform users and
280
410
  request feedback. This forms part of the 'standard header' of cookie banner, navbar and site development phase banner.
281
411
 
282
- In these templates, the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable is used to
283
- specify the current phase for a website or application. When using the `bsk--standard.html`layout, a banner will be
412
+ In these templates, the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable is used to
413
+ specify the current phase for a website or application. When using the `bsk--standard.html`layout, a banner will be
284
414
  shown automatically based on this variable.
285
415
 
286
- To disable this banner, set the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable to
416
+ To disable this banner, set the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable to
287
417
  `live-stable`. This isn't a real phase but separates a newly released website or application from something more mature.
288
418
 
289
419
  For example:
@@ -296,7 +426,7 @@ bas_style_kit_jekyll_theme:
296
426
 
297
427
  #### Experimental development phase
298
428
 
299
- Alternatively, the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable can be set to
429
+ Alternatively, the `bas_style_kit_jekyll_theme.attributes.site_development_phase` config variable can be set to
300
430
  `experimental` to indicate where an website or application is used for staging or other development/testing activities.
301
431
 
302
432
  For example:
@@ -309,7 +439,7 @@ bas_style_kit_jekyll_theme:
309
439
 
310
440
  ### Website analytics
311
441
 
312
- To include the Google Analytics universal tracking library (gtag), set the
442
+ To include the Google Analytics universal tracking library (gtag), set the
313
443
  `bas_style_kit_jekyll_theme.attributes.site_analytics.id` property to relevant Google Analytics property ID.
314
444
 
315
445
  **Note:** When used, the anonymise IP option in Google Analytics is enabled by default.
@@ -325,8 +455,8 @@ bas_style_kit_jekyll_theme:
325
455
 
326
456
  ## Components
327
457
 
328
- Components in these templates are structured according to Jekyll's conventions (e.g. layouts in `_layouts/`). They are
329
- also namespaced in a `bas-style-kit` directory (e.g. `_layouts/bas-style-kit/`). Components that are specific to the
458
+ Components in these templates are structured according to Jekyll's conventions (e.g. layouts in `_layouts/`). They are
459
+ also namespaced in a `bas-style-kit` directory (e.g. `_layouts/bas-style-kit/`). Components that are specific to the
330
460
  Style Kit are prefixed with `bsk--`.
331
461
 
332
462
  ### Views
@@ -349,7 +479,7 @@ Views for some pattern variants can be used as-is, others require variables or p
349
479
 
350
480
  Refer to [Jekyll's documentation](https://jekyllrb.com/docs/layouts/) for general information.
351
481
 
352
- Layouts are 'base' templates from which views or other layouts inherit. Layouts in this theme are hierarchical, with
482
+ Layouts are 'base' templates from which views or other layouts inherit. Layouts in this theme are hierarchical, with
353
483
  each layout extending the last in this order:
354
484
 
355
485
  * `blank.html`: lowest level layout, intentionally as minimal as possible and not intended for direct use, unless
@@ -358,9 +488,9 @@ each layout extending the last in this order:
358
488
  compatibility
359
489
  * `bsk--base.html`: intentionally implements the BAS Style Kit as minimally as possible and not intended for direct use,
360
490
  unless the bsk_standard.j2 layout is unsuitable
361
- * `bsk--standard.html`: defines an opinionated, conventional, page layout with a 'standard' header/footer, recommended
491
+ * `bsk--standard.html`: defines an opinionated, conventional, page layout with a 'standard' header/footer, recommended
362
492
  as a base for application/website layouts
363
- * `bsk--standard-page.html`: defines an opinionated, conventional, content page layout, recommended as a base for
493
+ * `bsk--standard-page.html`: defines an opinionated, conventional, content page layout, recommended as a base for
364
494
  content type websites, such as documentation
365
495
 
366
496
  For example:
@@ -373,7 +503,7 @@ layout: bas-style-kit/html
373
503
  Page content
374
504
  ```
375
505
 
376
- Layouts inheriting from the `bsk--standard` layout can add additional classes to the `#main-content` element by setting
506
+ Layouts inheriting from the `bsk--standard` layout can add additional classes to the `#main-content` element by setting
377
507
  the `main_content_classes` variable in each layout.
378
508
 
379
509
  For example:
@@ -402,7 +532,7 @@ Refer to [Jekyll's documentation](https://jekyllrb.com/docs/datafiles/) for gene
402
532
 
403
533
  This theme uses data files to define CSS and JavaScript resources to load and for some variables about the theme.
404
534
 
405
- All data files use the `.yml` (Yaml) extension and are namespaced using a `bas-style-kit/` directory - i.e. a data
535
+ All data files use the `.yml` (Yaml) extension and are namespaced using a `bas-style-kit/` directory - i.e. a data
406
536
  element `foo` in the data file `bsk-vars.yml` is available as `site.data.bas-style-kit.bsk-vars.foo`.
407
537
 
408
538
  ### Variables
@@ -423,7 +553,7 @@ Refer to [Jekyll's documentation](https://jekyllrb.com/docs/configuration/) for
423
553
  Configuration options are used extensively throughout this theme. Some variables are used to set properties such as the
424
554
  brand text or image in the navbar (attributes), others are used to enable various features (feature flags).
425
555
 
426
- Configuration options operate at different scopes, *site* or *page*. Site options applies to across a site, whereas
556
+ Configuration options operate at different scopes, *site* or *page*. Site options applies to across a site, whereas
427
557
  page options can be applied to specific content items. Default values can be set for page options, which can then be
428
558
  overridden by specific content items.
429
559
 
@@ -487,11 +617,11 @@ These config options must not be changed and should be treated as read only:
487
617
  | Config Option | Value Type | Allowed Values | Default Value | Notes |
488
618
  | --------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------- | ------------------ | ---------------------------------------------------------- |
489
619
  | `bas_style_kit_jekyll_theme.feature_flags.page.toc` | Boolean | `true` / `false` | `true` | Whether to show the table of contents in standard pages |
490
- | `bas_style_kit_jekyll_theme.attributes.head_title.default` | String | Any string | 'site title' | Typically 1-3 words |
491
- | `bas_style_kit_jekyll_theme.attributes.head_title.appended` | String | Any string | *None* | Typically 1-3 words |
492
- | `bas_style_kit_jekyll_theme.attributes.head_description` | String | Any string | 'site description' | Typically 1-2 sentences |
493
- | `bas_style_kit_jekyll_theme.attributes.site_analytics.id` | String | Google Analytics property ID | *None* | See [Site analytics](#site-analytics) |
494
- | `bas_style_kit_jekyll_theme.attributes.site_brand.text` | String | Any string | 'site title' | Typically 1-3 words |
620
+ | `bas_style_kit_jekyll_theme.attributes.head_title.default` | String | Any string | 'site title' | Typically 1-3 words |
621
+ | `bas_style_kit_jekyll_theme.attributes.head_title.appended` | String | Any string | *None* | Typically 1-3 words |
622
+ | `bas_style_kit_jekyll_theme.attributes.head_description` | String | Any string | 'site description' | Typically 1-2 sentences |
623
+ | `bas_style_kit_jekyll_theme.attributes.site_analytics.id` | String | Google Analytics property ID | *None* | See [Site analytics](#site-analytics) |
624
+ | `bas_style_kit_jekyll_theme.attributes.site_brand.text` | String | Any string | 'site title' | Typically 1-3 words |
495
625
  | `bas_style_kit_jekyll_theme.attributes.site_development_phase` | String | `discovery` / `alpha` / `beta` / `live` / `live-stable` / `retired` / `experimental` / `custom` | 'alpha' | See [Site development phase](#site-development-phase) |
496
626
  | `bas_style_kit_jekyll_theme.attributes.site_feedback_href` | String | URL to feedback page or other content (e.g. model overlay) | '/feedback.html' | - |
497
627
  | `bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href` | String | URL to cookies legal policy | '/legal/cookies' | - |
@@ -519,10 +649,10 @@ This theme depends on these plugins:
519
649
 
520
650
  ## Development
521
651
 
522
- [Git](https://git-scm.com), [Docker](https://www.docker.com/community-edition) and
652
+ [Git](https://git-scm.com), [Docker](https://www.docker.com/community-edition) and
523
653
  [Docker Compose](https://docs.docker.com/compose/overview/) are required to build this project locally.
524
654
 
525
- To update the Docker image for this project, access to the private
655
+ To update the Docker image for this project, access to the private
526
656
  [BAS Docker Registry](https://docker-registry.data.bas.ac.uk) [1] is also required.
527
657
 
528
658
  ```shell
@@ -533,7 +663,7 @@ $ docker-compose up
533
663
 
534
664
  Visit [localhost:9000](http://localhost:9000) to see a preview of the theme.
535
665
 
536
- **Note:** If you don't have access to the BAS Private Docker Registry, you will need to build the project Docker image
666
+ **Note:** If you don't have access to the BAS Private Docker Registry, you will need to build the project Docker image
537
667
  locally first using `docker-compose build`.
538
668
 
539
669
  [1] The first time you use this registry, you will need to authenticate using:
@@ -544,7 +674,7 @@ $ docker login docker-registry.data.bas.ac.uk
544
674
 
545
675
  ### Updating dependencies
546
676
 
547
- If the `.gemspec` for this project is changed, the project Docker image will need to be rebuilt and pushed to the
677
+ If the `.gemspec` for this project is changed, the project Docker image will need to be rebuilt and pushed to the
548
678
  private BAS Docker Repository [1].
549
679
 
550
680
  ```shell
@@ -558,14 +688,6 @@ $ docker-compose push app
558
688
  $ docker login docker-registry.data.bas.ac.uk
559
689
  ```
560
690
 
561
- #### Dependency vulnerability scanning
562
-
563
- To ensure the security of this project, and users of the Style Kit, all dependencies are checked against
564
- [Snyk](https://app.snyk.io/org/antarctica/project/a409ca29-86a3-45de-9838-5f1d7d1aca12) for vulnerabilities.
565
-
566
- Through [Continuous Integration](#continuous-integration), on each commit current dependencies are tested and a
567
- snapshot uploaded to Snyk. This snapshot is then monitored for vulnerabilities.
568
-
569
691
  ### Jekyll plugins
570
692
 
571
693
  Additional Jekyll plugins (gems) can be used by listing them as dependencies in the `gems` option in `_config.yml`.
@@ -574,7 +696,7 @@ They will be installed automatically when this theme is used by an end-user.
574
696
 
575
697
  ### Jekyll config options
576
698
 
577
- The Jekyll Data plugin is used to set config options within sites that use this theme. Make sure to document which
699
+ The Jekyll Data plugin is used to set config options within sites that use this theme. Make sure to document which
578
700
  config options are set by this theme.
579
701
 
580
702
  ### Ruby Gem
@@ -583,18 +705,12 @@ This theme is distributed as a Ruby Gem, through the public [Ruby Gems](https://
583
705
 
584
706
  The `jekyll-theme-bas-style-kit.gemspec` file details the properties of the Gem for this project.
585
707
 
586
- **Note:** The `spec.files` parameter controls which files in this project are copied into the Gem. If a file is not
708
+ **Note:** The `spec.files` parameter controls which files in this project are copied into the Gem. If a file is not
587
709
  listed it won't be included. This is separate to the Git `.gitignore` file.
588
710
 
589
- ## Testing
590
-
591
- ### Continuous Integration
592
-
593
- The BAS GitLab instance is used for Continuous Integration using settings defined in `.gitlab-ci.yml`.
594
-
595
711
  ## GitHub mirror
596
712
 
597
- A read-only mirror of this project's repository is maintained on GitHub, to support Jekyll's automatic theme
713
+ A read-only mirror of this project's repository is maintained on GitHub, to support Jekyll's automatic theme
598
714
  installation, and to allow use by those outside of BAS.
599
715
 
600
716
  Merge requests **WILL NOT** be accepted on this mirror.
@@ -604,9 +720,6 @@ Merge requests **WILL NOT** be accepted on this mirror.
604
720
  Before release:
605
721
 
606
722
  1. create a release branch
607
- 2. remove `-develop` from the version in:
608
- * `jekyll-theme-bas-style-kit.gemspec`
609
- * `_data/bsk_jekyll_vars.json`
610
723
  3. build and push the app docker image [1]
611
724
  4. if new config options have been set, update the usage section
612
725
  5. update screen-shot (width: 900px)
@@ -618,10 +731,10 @@ Before release:
618
731
 
619
732
  After release:
620
733
 
621
- 1. bump the version with `-develop` as a prefix in:
734
+ 1. bump the version in:
622
735
  * `jekyll-theme-bas-style-kit.gemspec`
623
736
  * `_data/bsk_jekyll_vars.json`
624
- 2. push the app docker image [1]
737
+ 2. build and push the app docker image [1]
625
738
  3. commit changes, merge with master and close release branch
626
739
 
627
740
  [1]
@@ -641,19 +754,19 @@ $ gem push jekyll-theme-bas-style-kit-*.gem
641
754
 
642
755
  ## Issue tracking
643
756
 
644
- This project uses [issue tracking](https://trello.com/b/0Mhzizpk/bas-style-kit) to manage development of new
757
+ This project uses [issue tracking](https://trello.com/b/0Mhzizpk/bas-style-kit) to manage development of new
645
758
  features/improvements and reporting bugs.
646
759
 
647
760
  ## Feedback
648
761
 
649
- The maintainer of this project is the BAS Web & Applications Team, they can be contacted through the
762
+ The maintainer of this project is the BAS Web & Applications Team, they can be contacted through the
650
763
  [BAS Service Desk](mailto:servicedesk@bas.ac.uk).
651
764
 
652
765
  ## License
653
766
 
654
- © UK Research and Innovation (UKRI), 2017-2018, British Antarctic Survey.
767
+ © UK Research and Innovation (UKRI), 2017-2020, British Antarctic Survey.
655
768
 
656
- You may use and re-use this software and associated documentation files free of charge in any format or medium, under
769
+ You may use and re-use this software and associated documentation files free of charge in any format or medium, under
657
770
  the terms of the Open Government Licence v3.0.
658
771
 
659
772
  You may obtain a copy of the Open Government Licence at http://www.nationalarchives.gov.uk/doc/open-government-licence/
@@ -1,5 +1,5 @@
1
1
  ---
2
2
  -
3
- href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.6.0-alpha/css/bas-style-kit.min.css'
4
- integrity: 'sha256-YsP5zVtOhiEalahZCyQcl8vG7vyzUJ4aP/yGoPXGOZ0='
3
+ href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.6.0-beta/css/bas-style-kit.min.css'
4
+ integrity: 'sha256-CIM+E9YZgr1hUKQ98wzF/USoPd7OBQl9Y6bWEk0Dqlc='
5
5
  type: 'remote'
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  -
3
- href: 'https://cdn.web.bas.ac.uk/libs/jquery/3.3.1/jquery-3.3.1.min.js'
4
- integrity: 'sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8='
3
+ href: 'https://cdn.web.bas.ac.uk/libs/jquery/3.5.1/js/jquery-3.5.1.min.js'
4
+ integrity: 'sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0='
5
5
  type: 'remote'
6
6
  -
7
- href: 'https://cdn.web.bas.ac.uk/libs/js-cookie/2.1.3/js.cookie-2.1.3.min.js'
8
- integrity: 'sha256-EareStqgZTnMUqLWtDkCa3SldvB8NPBY8u5C6ZUMWRc='
7
+ href: 'https://cdn.web.bas.ac.uk/libs/js-cookie/2.2.1/js/js.cookie-2.2.1.min.js'
8
+ integrity: 'sha256-MdF5lmO7tgKSFNkLp9uc3HJfoCwW1LCQrdNyHkQji2s='
9
9
  type: 'remote'
10
10
  -
11
- href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.6.0-alpha/js/bas-style-kit.min.js'
12
- integrity: 'sha256-pGW+MS4z0IRzUK+7MJrnpc/1FwbD0v0BdP4mvmMlJhw='
11
+ href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.6.0-beta/js/bas-style-kit.min.js'
12
+ integrity: 'sha256-IGaRkrHf/T62GN0E75YL3iLtvmbifinJXfSo8GohRB0='
13
13
  type: 'remote'
@@ -1,3 +1,3 @@
1
1
  ---
2
- theme_version: "0.9.0"
3
- bsk_version: "0.6.0-alpha"
2
+ theme_version: "0.10.0"
3
+ bsk_version: "0.6.0-beta"
@@ -0,0 +1,7 @@
1
+ <header class="bsk-page-header bsk-page-header-stacked">
2
+ <h1>
3
+ <small class="bsk-text-capitalize">{{ include.item_type }}</small>
4
+ <br />
5
+ {{ include.item_title }}
6
+ </h1>
7
+ </header>
@@ -0,0 +1 @@
1
+ <a href="{{ include.orcid_id }}"><i class="fab fa-orcid bsk-orcid-id"></i> {{ include.orcid_id }}</a>
@@ -1,3 +1,3 @@
1
1
  <div class="bsk-footer-is-something-wrong">
2
- <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_feedback_href }}">Is something wrong with this page?</a>
2
+ <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_feedback_href }}" target="_blank">Is something wrong with this page?</a>
3
3
  </div>
@@ -2,8 +2,8 @@
2
2
  <div class="{{ bsk_attributes_container_class }}">
3
3
  <div class="bsk-alert bsk-alert-static-top bsk-alert-dismissible bsk-alert-solid bsk-alert-cookie-notice" data-bsk-role='cookie-notice'>
4
4
  <button class="bsk-close" type="button" data-dismiss="alert" aria-label="Close">&times;</button>
5
- This website uses cookies to help us make it better -
6
- <a class="bsk-alert-link" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href }}">find out more</a>
5
+ This website uses cookies to help us make it better -
6
+ <a class="bsk-alert-link" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href }}" target="_blank">find out more</a>
7
7
  </div>
8
8
  </div>
9
9
  </div>
@@ -0,0 +1,21 @@
1
+ ---
2
+ layout: bas-style-kit/bsk--standard
3
+ main_content_classes: bsk-pattern-sign-in
4
+ title: Sign in
5
+ ---
6
+
7
+ <h1 class="bsk-page-header">Please sign in to continue</h1>
8
+ <p class="bsk-lead">We need to check you are allowed to use this part of this service.</p>
9
+
10
+ <section class="bsk-call-to-action">
11
+ <a class="bsk-btn bsk-btn-ms-account bsk-btn-lg" href=page.call_to_action_href>
12
+ <object class="bsk-ms-pictogram" type="image/svg+xml" data="https://cdn.web.bas.ac.uk/bas-style-kit/{{ site.data.bas-style-kit.bsk-vars.bsk_version }}/img/logos-symbols/ms-pictogram.svg"></object>
13
+ Sign in to continue
14
+ </a>
15
+ </section>
16
+ <section class="bsk-sign-in-information">
17
+ <p>Use the account you use for your NERC email to sign into this service.</p>
18
+ <p><a href="mailto:servicedesk@bas.ac.uk">Contact the IT Service Desk</a> if you are unable to sign in.</p>
19
+ </section>
20
+
21
+ {{ content }}
@@ -0,0 +1,9 @@
1
+ ---
2
+ layout: bas-style-kit/bsk--standard
3
+ main_content_classes: bsk-pattern-start
4
+ title: Start
5
+ ---
6
+
7
+ <h1 class="bsk-page-header">{{ site.bas_style_kit_jekyll_theme.attributes.site_brand.text }}</h1>
8
+
9
+ {{ content }}
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-bas-style-kit
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Felix Fennell
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-07-02 00:00:00.000000000 Z
11
+ date: 2020-06-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: jekyll
@@ -16,34 +16,28 @@ dependencies:
16
16
  requirements:
17
17
  - - "~>"
18
18
  - !ruby/object:Gem::Version
19
- version: '3.8'
20
- - - ">="
21
- - !ruby/object:Gem::Version
22
- version: 3.8.5
19
+ version: '4.1'
23
20
  type: :runtime
24
21
  prerelease: false
25
22
  version_requirements: !ruby/object:Gem::Requirement
26
23
  requirements:
27
24
  - - "~>"
28
25
  - !ruby/object:Gem::Version
29
- version: '3.8'
30
- - - ">="
31
- - !ruby/object:Gem::Version
32
- version: 3.8.5
26
+ version: '4.1'
33
27
  - !ruby/object:Gem::Dependency
34
28
  name: jekyll-data
35
29
  requirement: !ruby/object:Gem::Requirement
36
30
  requirements:
37
31
  - - "~>"
38
32
  - !ruby/object:Gem::Version
39
- version: '1.0'
33
+ version: '1.1'
40
34
  type: :runtime
41
35
  prerelease: false
42
36
  version_requirements: !ruby/object:Gem::Requirement
43
37
  requirements:
44
38
  - - "~>"
45
39
  - !ruby/object:Gem::Version
46
- version: '1.0'
40
+ version: '1.1'
47
41
  - !ruby/object:Gem::Dependency
48
42
  name: jekyll-menus
49
43
  requirement: !ruby/object:Gem::Requirement
@@ -51,9 +45,6 @@ dependencies:
51
45
  - - "~>"
52
46
  - !ruby/object:Gem::Version
53
47
  version: '0.6'
54
- - - ">="
55
- - !ruby/object:Gem::Version
56
- version: 0.6.0
57
48
  type: :runtime
58
49
  prerelease: false
59
50
  version_requirements: !ruby/object:Gem::Requirement
@@ -61,9 +52,6 @@ dependencies:
61
52
  - - "~>"
62
53
  - !ruby/object:Gem::Version
63
54
  version: '0.6'
64
- - - ">="
65
- - !ruby/object:Gem::Version
66
- version: 0.6.0
67
55
  - !ruby/object:Gem::Dependency
68
56
  name: jekyll-tidy
69
57
  requirement: !ruby/object:Gem::Requirement
@@ -71,9 +59,6 @@ dependencies:
71
59
  - - "~>"
72
60
  - !ruby/object:Gem::Version
73
61
  version: '0.2'
74
- - - ">="
75
- - !ruby/object:Gem::Version
76
- version: 0.2.2
77
62
  type: :runtime
78
63
  prerelease: false
79
64
  version_requirements: !ruby/object:Gem::Requirement
@@ -81,43 +66,34 @@ dependencies:
81
66
  - - "~>"
82
67
  - !ruby/object:Gem::Version
83
68
  version: '0.2'
84
- - - ">="
85
- - !ruby/object:Gem::Version
86
- version: 0.2.2
87
69
  - !ruby/object:Gem::Dependency
88
70
  name: bundler
89
71
  requirement: !ruby/object:Gem::Requirement
90
72
  requirements:
91
73
  - - "~>"
92
74
  - !ruby/object:Gem::Version
93
- version: '1.16'
94
- - - ">="
95
- - !ruby/object:Gem::Version
96
- version: 1.16.1
75
+ version: '2.0'
97
76
  type: :development
98
77
  prerelease: false
99
78
  version_requirements: !ruby/object:Gem::Requirement
100
79
  requirements:
101
80
  - - "~>"
102
81
  - !ruby/object:Gem::Version
103
- version: '1.16'
104
- - - ">="
105
- - !ruby/object:Gem::Version
106
- version: 1.16.1
82
+ version: '2.0'
107
83
  - !ruby/object:Gem::Dependency
108
84
  name: rake
109
85
  requirement: !ruby/object:Gem::Requirement
110
86
  requirements:
111
87
  - - "~>"
112
88
  - !ruby/object:Gem::Version
113
- version: '12.3'
89
+ version: '13.0'
114
90
  type: :development
115
91
  prerelease: false
116
92
  version_requirements: !ruby/object:Gem::Requirement
117
93
  requirements:
118
94
  - - "~>"
119
95
  - !ruby/object:Gem::Version
120
- version: '12.3'
96
+ version: '13.0'
121
97
  description:
122
98
  email:
123
99
  - felnne@bas.ac.uk
@@ -135,6 +111,8 @@ files:
135
111
  - _data/bas-style-kit/bsk-vars.yml
136
112
  - _data/menus.yml
137
113
  - _includes/bas-style-kit/body.html
114
+ - _includes/bas-style-kit/bsk--pattern--item-type-header.html
115
+ - _includes/bas-style-kit/bsk--pattern--orcid-id.html
138
116
  - _includes/bas-style-kit/bsk-body--analytics-script.html
139
117
  - _includes/bas-style-kit/bsk-body--back-to-top.html
140
118
  - _includes/bas-style-kit/bsk-body--core-scripts.html
@@ -173,6 +151,8 @@ files:
173
151
  - _layouts/views/bas-style-kit/bsk--page-not-found.html
174
152
  - _layouts/views/bas-style-kit/bsk--problem-with-service.html
175
153
  - _layouts/views/bas-style-kit/bsk--service-unavailable.html
154
+ - _layouts/views/bas-style-kit/bsk--sign-in-microsoft.html
155
+ - _layouts/views/bas-style-kit/bsk--start.html
176
156
  - _sass/main.scss
177
157
  - assets/empty
178
158
  - screenshot.png
@@ -196,8 +176,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
196
176
  - !ruby/object:Gem::Version
197
177
  version: '0'
198
178
  requirements: []
199
- rubyforge_project:
200
- rubygems_version: 2.7.7
179
+ rubygems_version: 3.1.2
201
180
  signing_key:
202
181
  specification_version: 4
203
182
  summary: Jekyll theme for the BAS Style Kit