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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a89cf02d816079a37d7a46f926a77b8e084ea6521b9a8dbe2a6616b8fbddb0f
-  data.tar.gz: 62d0c38503090c81c54e7d15bc32dbf50f87b9257f659829bf98b2c6a4658e67
+  metadata.gz: 1f1c5e450726f3057d398f010f245835b9359d35cac156120a3c71f387f223c4
+  data.tar.gz: 5f70b71c0816d0397542e889f45dea97476e50a42807599b7b01a5cb8d5ac61f
 SHA512:
-  metadata.gz: a289cf63df4aae969859ef27dfcb357a56286c1fcbb81598332ff9ad20eea765f62b87e7e03eb60682852b8fca3055a8dc18956a45112843c4bd1dc1a12ef323
-  data.tar.gz: 32c575404cddbc955955ce28845853424580f639c8d8cfa003e83f43e9d6a42d048219273e6f367234391f5e23e14a75d575d9e21bf4e7f941a34ea87f9573f8
+  metadata.gz: f83ac6d95f7350a9b96286ae1fe2b8437f0ee4cb8444eee3b6f5a84bf3b8a002e3ec818764fd4f16ccfb53079047b049cbd5af4506b1346dcc161d2f78f4b616
+  data.tar.gz: 10b83b693065ecf4c70992067c6f922e9c06dd2302ff6593d89ad179edfb5fd3e89328f285ac94e21185062d7fb05f91a89aa624240a54391551f7966afb7f5c

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".freeze
+  VERSION = "1.8.0-beta1".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
+  version: 1.8.0.pre.beta1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-03-21 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: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.9
 signing_key: