jekyll-open-sdg-plugins 1.7.0.pre.beta1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a20f18058cd335bd8013c7ee57b71e24a89d58233b41a40bb1b9b68935808181
-  data.tar.gz: 7500171f49b24af2713419835bddabdb4818a191db2543f5a4f9dc3c71c8790b
+  metadata.gz: 8a8c796bf7b90b41f1d9258be2f52a3cb3fb80604ca580ef592cf5bf7a7acf59
+  data.tar.gz: 961d18d17a15e41591547046e76fcf48e6c12ea226dfcee8c9378be019ccdb00
 SHA512:
-  metadata.gz: 2aa09b75a8c255eede956558d0f70b1bfaab9ec6cf48d823ed75c8414d66d9e55e52bef746ddbc04561883c6cdc405dea133d734bf8acb70b6c526e8ecaf8870
-  data.tar.gz: 5b908df4984d24c1218c49c3e9e53dca009ea86c4bc534ec584784b22977e0d63de6e9087254fbb1c98df5caf202f002ca1cc88d577e529b742ebf4cc5eabf99
+  metadata.gz: e78a4af21623402d3a363f4af61e1c6e3ca9d1e0731f2758b0163be9c9e35df9cea52b9fc3fb2a3830d676ef27b0eb042db60fbb4b680a1717248007f55bee55
+  data.tar.gz: 3f31ee6e9d6ef944fa62b9f1ea1b5e7aea1a9179ab988d60277872c0d0ddd4fc6133c2405e1779ccd3a928d9ed96ec3bcef038e65701549f58fc5436b1015033

data/lib/jekyll-open-sdg-plugins/backwards_compatibility.rb

@@ -59,6 +59,39 @@ module JekyllOpenSdgPlugins
           add_translation_keys(goal['statuses'], site)
         end
       end
+
+      # Print warnings for settings that are deprecated
+      # and will be removed in version 2.0.0.
+      if !site.config.has_key?('accessible_charts') || !site.config['accessible_charts']
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the accessible_charts setting will be automatically set to true.')
+      end
+      if !site.config.has_key?('accessible_tabs') || !site.config['accessible_tabs']
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the accessible_tabs setting will be automatically set to true.')
+      end
+      if !site.config.has_key?('contrast_type') || site.config['contrast_type'] != 'single'
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the contrast_type setting will be automatically set to "single".')
+      end
+      if site.config.has_key?('create_goals') && site.config['create_goals']['layout'] != 'goal-with-progress'
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the create_goals.layout setting will be removed, because there will only be a single option for goal layouts. To see a preview, set "bootstrap_5" to "true".')
+      end
+      if !site.config.has_key?('favicons') || site.config['favicons'] != 'favicon.io'
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the favicons setting will be automatically set to "favicon.io".')
+      end
+      if site.config.has_key?('frontpage_heading') && site.config['frontpage_heading'] != ''
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the "frontpage_heading" setting will no longer be used.')
+      end
+      if site.config.has_key?('frontpage_instructions') && site.config['frontpage_instructions'] != ''
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the "frontpage_instructions" setting will no longer be used.')
+      end
+      if site.config.has_key?('header') && site.config['header']['include'] != 'header-menu-left-aligned.html'
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the "header.include" setting will no longer be used because there will only be a single option for headers. To see what this will look like, set "bootstrap_5" to "true".')
+      end
+      if site.config.has_key?('non_global_metadata') && site.config['non_global_metadata'] != ''
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the "non_global_metadata" setting will be removed. Please use the "metadata_tabs" setting to control the labels of the metadata tabs.')
+      end
+      if !site.config.has_key?('series_toggle') || !site.config['series_toggle']
+        opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the "series_toggle" will be automatically set to "true". In order to keep the "false" behavior, please rename your "Series" column to something else.')
+      end
     end
   end
 end

data/lib/jekyll-open-sdg-plugins/create_goals.rb

@@ -78,6 +78,9 @@ module JekyllOpenSdgPlugins
       self.data['goal_number'] = goal.to_s
       self.data['language'] = language
       self.data['layout'] = layout
+      if site.config['bootstrap_5']
+        self.data['layout'] = 'goal-bootstrap5'
+      end
       # Backwards compatibility:
       self.data['sdg_goal'] = self.data['goal_number']
     end

data/lib/jekyll-open-sdg-plugins/create_indicators.rb

@@ -158,6 +158,9 @@ module JekyllOpenSdgPlugins
       self.data = {}
       self.data['indicator_number'] = inid.gsub('-', '.')
       self.data['layout'] = layout
+      if site.config['bootstrap_5']
+        self.data['layout'] = 'indicator-bootstrap5'
+      end
       self.data['language'] = language
       # Backwards compatibility:
       self.data['indicator'] = self.data['indicator_number']

data/lib/jekyll-open-sdg-plugins/create_pages.rb

@@ -61,6 +61,12 @@ module JekyllOpenSdgPlugins
           pages = site.config['create_pages']
         end
 
+        pages.each do |page|
+          if page['layout'] == 'frontpage'
+            opensdg_notice('DEPRECATION NOTICE: In Open SDG 2.0.0, the "frontpage" layout will change. To see a preview, set "bootstrap_5" to "true".')
+          end
+        end
+
         # Clone pages so that we don't edit the original.
         pages = pages.clone
 
@@ -130,6 +136,15 @@ module JekyllOpenSdgPlugins
           self.data[key] = value
         end
       end
+
+      if site.config['bootstrap_5']
+        if page.has_key?('layout') && page['layout'] == 'reportingstatus'
+          self.data['layout'] = 'reportingstatus-bootstrap5'
+        end
+        if page.has_key?('layout') && page['layout'] == 'frontpage'
+          self.data['layout'] = 'frontpage-alt'
+        end
+      end
     end
   end
 end

data/lib/jekyll-open-sdg-plugins/schema-site-config.json

@@ -56,6 +56,18 @@
                 }
             ]
         },
+        "bootstrap_5": {
+            "title": "Bootstrap 5",
+            "type": "boolean",
+            "description": "This setting can be set to `true` to enable Bootstrap 5. Importantly, this will automatically be set to 'true' in Open SDG 2.0.0.",
+            "format": "checkbox",
+            "links": [
+                {
+                    "rel": "More information on the bootstrap_5 setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#bootstrap_5"
+                }
+            ]
+        },
         "breadcrumbs": {
             "options": {"collapsed": true},
             "type": "object",
@@ -97,6 +109,18 @@
                 }
             ]
         },
+        "chartjs_3": {
+            "title": "Chart.js 3",
+            "type": "boolean",
+            "description": "This setting can be set to `true` to enable Chart.js 3. Importantly, this will automatically be set to 'true' in Open SDG 2.0.0.",
+            "format": "checkbox",
+            "links": [
+                {
+                    "rel": "More information on the chartjs_3 setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#chartjs_3"
+                }
+            ]
+        },
         "contrast_type": {
             "type": "string",
             "title": "Contrast type",
@@ -414,6 +438,12 @@
                     "type": "string",
                     "title": "Message",
                     "description": "A short disclaimer message."
+                },
+                "hidden": {
+                    "type": "boolean",
+                    "title": "Hidden",
+                    "description": "Hide the disclaimer.",
+                    "format": "checkbox"
                 }
             },
             "links": [
@@ -1462,6 +1492,36 @@
             "description": "Configuration of the site configuration form.",
             "$ref": "#/definitions/config_form_options"
         },
+        "time_series_attributes": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Time-series attributes",
+            "description": "This setting can be used to specify data columns to be considered 'time-series attributes' and displayed in the footer.",
+            "items": {
+                "type": "object",
+                "title": "Time-series attribute",
+                "properties": {
+                    "field": {
+                        "type": "string",
+                        "minLength": 1,
+                        "title": "Field",
+                        "description": "Column name in the data."
+                    },
+                    "label": {
+                        "type": "string",
+                        "minLength": 1,
+                        "title": "Label",
+                        "description": "Label when displayed in the footer."
+                    }
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the time series attributes setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#time_series_attributes"
+                }
+            ]
+        },
         "validate_indicator_config": {
             "title": "Validate indicator config",
             "type": "boolean",

data/lib/jekyll-open-sdg-plugins/site_configuration.rb

@@ -61,6 +61,20 @@ module JekyllOpenSdgPlugins
           'label' => 'status.disaggregation_status_notapplicable',
         },
       ]
+
+      # Provide some defaults.
+      if !site.config.has_key?('time_series_attributes') or site.config['time_series_attributes'].length == 0
+        site.config['time_series_attributes'] = [
+          {
+            'field' => 'COMMENT_TS',
+            'label' => 'indicator.footnote',
+          },
+          {
+            'field' => 'DATA_LAST_UPDATE',
+            'label' => 'metadata_fields.national_data_update_url'
+          },
+        ]
+      end
     end
 
     # Copy properties from a hash onto another hash.

data/lib/jekyll-open-sdg-plugins/version.rb

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.7.0-beta1".freeze
+  VERSION = "1.8.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 1.7.0.pre.beta1
+  version: 1.8.0
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -102,9 +102,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.9
 signing_key: