jekyll-open-sdg-plugins 1.4.0 → 1.5.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f535300e051b6be3aae0ab0fc136f5fdda75d2453dd832388f3408ff8d8370d2
-  data.tar.gz: bcd82b1a845f92ed56c49b92f175d778bd9bfc91c1276d32dcc244b29821d685
+  metadata.gz: 06e9d51fe6fddfeab87a899fb547b6b1762d0832d59de269f12d5bddd6aeedc4
+  data.tar.gz: 8f1728d821fffbb4cc51382cbc705e1e1e565c8b34cba3fbfdbe7bedd0ae4c3d
 SHA512:
-  metadata.gz: edbdfc568479a3eb1e6c39a26a9e81d97e8edf9d082c32cd62448ecc6b14802b7f007afcb9076fb08671647abb56e91317604f10031cb6a312fef98cc295c4bd
-  data.tar.gz: '02282d6323e8b8224d8d1b7404753d6bd3ae7e075dcbc3183b11a01e113927e60c7a8058e33afb2918d9759df84ab547d0cf80a2a6858f8e2ee9f502b0cd8c1d'
+  metadata.gz: 68c29fd1482b09b1b22875375277ea93e748d6f8bfa9a89e986cea37790782761ad5f790d1e49d12335578a048140e76e9979b6cd16c1a1cd7fcbca0356670a7
+  data.tar.gz: 8af06e8364fd7ce44039fab11617ba98ff6e8f6eb63ea5e9b4839fcb1bd36e81746d2ec333422159f10931737bda790719895e1f6e66a28fec5212b6116622fc

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

@@ -26,7 +26,7 @@ module JekyllOpenSdgPlugins
           if indicator.has_key?('standalone') and indicator['standalone']
             next
           end
-          goal = inid.split('-')[0].to_i
+          goal = inid.split('-')[0]
           goals[goal] = true
         end
         # Decide what layout to use for the goal pages.
@@ -44,11 +44,13 @@ module JekyllOpenSdgPlugins
             language_public = languages_public[language]
           end
           # Loop through the goals.
-          goals.sort.each do |goal, value|
+          goal_index = 0
+          goals.keys.sort.each do |goal|
             # Add the language subfolder for all except the default (first) language.
             dir = index == 0 ? goal.to_s : File.join(language_public, goal.to_s)
             # Create the goal page.
-            site.collections['goals'].docs << GoalPage.new(site, site.source, dir, goal, language, layout)
+            site.collections['goals'].docs << GoalPage.new(site, site.source, dir, goal, language, layout, goal_index)
+            goal_index += 1
           end
         end
       end
@@ -57,7 +59,7 @@ module JekyllOpenSdgPlugins
 
   # A Page subclass used in the `CreateGoals` class.
   class GoalPage < Jekyll::Page
-    def initialize(site, base, dir, goal, language, layout)
+    def initialize(site, base, dir, goal, language, layout, goal_index)
       @site = site
       @base = base
       @dir  = dir
@@ -65,8 +67,8 @@ module JekyllOpenSdgPlugins
 
       goal_content = ''
       if site.config['create_goals'].has_key?('goals')
-        if !site.config['create_goals']['goals'][goal - 1].nil?
-          goal_content = site.config['create_goals']['goals'][goal - 1]['content']
+        if !site.config['create_goals']['goals'][goal_index].nil?
+          goal_content = site.config['create_goals']['goals'][goal_index]['content']
         end
       end
       @content = goal_content

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

@@ -248,6 +248,7 @@
                                 "type": "string",
                                 "format": "color",
                                 "title": "Line color",
+                                "default": "#949494",
                                 "description": "The color of the line.",
                                 "links": [
                                     {
@@ -257,9 +258,14 @@
                                 ]
                             },
                             "borderDash": {
-                                "type": "string",
+                                "type": "array",
                                 "title": "Line dash type",
                                 "description": "The type of line dash.",
+                                "default": [10, 5],
+                                "items": {
+                                    "type": "number"
+                                },
+                                "minItems": 2,
                                 "links": [
                                     {
                                         "rel": "More information on the line dash setting",
@@ -294,12 +300,13 @@
                                         "type": "string",
                                         "format": "color",
                                         "title": "Label color",
-                                        "description": "Color for the label text."
+                                        "description": "Color for the label text.",
+                                        "default": "#000000"
                                     },
                                     "backgroundColor": {
                                         "type": "string",
                                         "format": "color",
-                                        "default": "#FFFFFFF",
+                                        "default": "#ffffff",
                                         "title": "Background color",
                                         "description": "Background color for the label text."
                                     }
@@ -313,7 +320,7 @@
                                     "borderColor": {
                                         "type": "string",
                                         "format": "color",
-                                        "default": "#FFFFFF",
+                                        "default": "#ffffff",
                                         "title": "High-contrast line color",
                                         "description": "The color of the line in high-contrast mode."
                                     },
@@ -325,7 +332,7 @@
                                             "fontColor": {
                                                 "type": "string",
                                                 "format": "color",
-                                                "default": "#FFFFFF",
+                                                "default": "#ffffff",
                                                 "title": "High-contrast label color",
                                                 "description": "Color for the label text in high-contrast mode."
                                             },
@@ -386,6 +393,40 @@
                 }
             ]
         },
+        "graph_series_breaks": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Graph series breaks",
+            "description": "A list of series break (ie, a gap among the years) lines to display on the graph.",
+            "items": {
+                "type": "object",
+                "title": "Series break",
+                "allOf": [
+                    { "$ref": "#/definitions/series_unit_constraint" },
+                    {
+                        "properties": {
+                            "label_content": {
+                                "type": "string",
+                                "title": "Label content",
+                                "default": "indicator.annotation_series_break",
+                                "description": "The text to display for this series break."
+                            },
+                            "value": {
+                                "type": "number",
+                                "title": "Value",
+                                "description": "The numeric value at which to place the series break. This number should be between 0 (the left side of the chart) and the number of years minus 1 (the right side of the chart)."
+                            }
+                        }
+                    }
+                ]
+            },
+            "links": [
+                {
+                    "rel": "More information on the graph target lines setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#graph_series_breaks"
+                }
+            ]
+        },
         "graph_stacked_disaggregation": {
             "type": "string",
             "title": "Stacked disaggregation",
@@ -397,6 +438,40 @@
                 }
             ]
         },
+        "graph_target_lines": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Graph target lines",
+            "description": "A list of target lines to display on the graph.",
+            "items": {
+                "type": "object",
+                "title": "Target line",
+                "allOf": [
+                    { "$ref": "#/definitions/series_unit_constraint" },
+                    {
+                        "properties": {
+                            "label_content": {
+                                "type": "string",
+                                "title": "Label content",
+                                "default": "indicator.annotation_2030_target",
+                                "description": "The text to display for this target line."
+                            },
+                            "value": {
+                                "type": "number",
+                                "title": "Value",
+                                "description": "The numeric value at which to place the target line."
+                            }
+                        }
+                    }
+                ]
+            },
+            "links": [
+                {
+                    "rel": "More information on the graph target lines setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#graph_target_lines"
+                }
+            ]
+        },
         "graph_title": {
             "type": "string",
             "title": "Graph title",
@@ -504,6 +579,18 @@
                 }
             ]
         },
+        "placeholder": {
+            "title": "Placeholder indicator",
+            "type": "string",
+            "description": "Entering text here identifies this as a 'placeholder' indicator. The text will be displayed on the goal page, in place of a link to the indicator page.",
+            "format": "textarea",
+            "links": [
+                {
+                    "rel": "More information the placeholder setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#placeholder"
+                }
+            ]
+        },
         "precision": {
             "options": {"collapsed": true},
             "type": "array",
@@ -576,6 +663,17 @@
                     "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#recommended-special-fields"
                 }
             ]
+        },
+        "x_axis_label": {
+            "type": "string",
+            "title": "X axis label",
+            "description": "A label beneath the X axis on charts. This overrides the same site configuration setting.",
+            "links": [
+                {
+                    "rel": "More information on the X axis label setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#x_axis_label"
+                }
+            ]
         }
     },
     "additionalProperties": true,

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

@@ -31,12 +31,22 @@
             "options": {"collapsed": true},
             "type": "object",
             "title": "Analytics",
-            "description": "If these settings are used, usage statistics will be sent to Google Analytics.",
+            "description": "If these settings are used, usage statistics will be sent to Google Analytics. These are optional, and you don't have to use all of them. Typically you would just use one, such as the 'ua' option.",
             "properties": {
-                "ga_prod": {
+                "ua": {
                     "type": "string",
-                    "title": "Google Analytics tracking ID",
-                    "description": "The tracking ID (UA code) for your property on Google Analytics."
+                    "title": "Universal Analytics (ua) tracking ID",
+                    "description": "The tracking ID for the analytics.js approach, for your property on Google Analytics. Typically starts with 'UA-'."
+                },
+                "gtag": {
+                    "type": "string",
+                    "title": "gtag.js (gtag) tracking ID",
+                    "description": "The tracking ID for the gtag.js approach, for your property on Google Analytics. Typically starts with 'G-'."
+                },
+                "gtm": {
+                    "type": "string",
+                    "title": "Google Tag Manager (gtm) tracking ID",
+                    "description": "Your tracking ID for Google Tag Manager. Typically starts with 'GTM-'. Though this is included as an analytics approach, it requires additional configuration within Google Tag Manager in order to capture analytics."
                 }
             },
             "links": [
@@ -106,6 +116,26 @@
                 }
             ]
         },
+        "cookie_consent_form": {
+            "options": {"collapsed": true},
+            "type": "object",
+            "title": "Cookie consent form",
+            "description": "A cookie consent form for users",
+            "properties": {
+                "enabled": {
+                    "type": "boolean",
+                    "title": "Enabled",
+                    "description": "Whether the cookie consent form will be enabled",
+                    "format": "checkbox"
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the cookie_consent_form setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#cookie_consent_form"
+                }
+            ]
+        },
         "country": {
             "options": {"collapsed": true},
             "type": "object",
@@ -736,6 +766,30 @@
                 }
             ]
         },
+        "hide_single_series": {
+            "title": "Hide single series",
+            "type": "boolean",
+            "description": "This setting can be used to hide the 'Series' toggle on indicators where there is only one choice.",
+            "format": "checkbox",
+            "links": [
+                {
+                    "rel": "More information on the hide single series setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_single_series"
+                }
+            ]
+        },
+        "hide_single_unit": {
+            "title": "Hide single unit",
+            "type": "boolean",
+            "description": "This setting can be used to hide the 'Unit' toggle on indicators where there is only one choice.",
+            "format": "checkbox",
+            "links": [
+                {
+                    "rel": "More information on the hide single unit setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_single_unit"
+                }
+            ]
+        },
         "indicator_config_form": {
             "options": {"collapsed": true},
             "type": "object",
@@ -1310,6 +1364,17 @@
                     "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#validate_site_config"
                 }
             ]
+        },
+        "x_axis_label": {
+            "type": "string",
+            "title": "X axis label",
+            "description": "A label beneath the X axis on charts. This is overridden by the same indicator configuration setting.",
+            "links": [
+                {
+                    "rel": "More information on the X axis label setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#x_axis_label"
+                }
+            ]
         }
     },
     "additionalProperties": true,

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

@@ -65,6 +65,38 @@ module JekyllOpenSdgPlugins
       list[incremented]
     end
 
+    # Wrapper of get_previous_item specifically for indicators.
+    def get_previous_indicator(list, index)
+      indicator = get_previous_item(list, index)
+      # Skip placeholder indicators.
+      is_placeholder = (indicator.has_key?('placeholder') and indicator['placeholder'] != '')
+      while (is_placeholder)
+        index -= 1
+        if index < 0
+          index = list.length() - 1
+        end
+        indicator = get_previous_item(list, index)
+        is_placeholder = (indicator.has_key?('placeholder') and indicator['placeholder'] != '')
+      end
+      return indicator
+    end
+
+    # Wrapper of get_next_item specifically for indicators.
+    def get_next_indicator(list, index)
+      indicator = get_next_item(list, index)
+      # Skip placeholder indicators.
+      is_placeholder = (indicator.has_key?('placeholder') and indicator['placeholder'] != '')
+      while (is_placeholder)
+        index += 1
+        if index >= list.length()
+          index = 0
+        end
+        indicator = get_next_item(list, index)
+        is_placeholder = (indicator.has_key?('placeholder') and indicator['placeholder'] != '')
+      end
+      return indicator
+    end
+
     # The Jekyll baseurl is user-configured, and can be inconsistent. This
     # ensure it is consistent in whether it starts/ends with a slash.
     def normalize_baseurl(baseurl)
@@ -277,6 +309,7 @@ module JekyllOpenSdgPlugins
           end
 
           is_standalone = (meta.has_key?('standalone') and meta['standalone'])
+          is_placeholder = (meta.has_key?('placeholder') and meta['placeholder'] != '')
 
           # Set the goal for this language, once only.
           if !is_standalone && already_added[language].index(goal_number) == nil
@@ -327,6 +360,14 @@ module JekyllOpenSdgPlugins
             # Allow metadata 'sort' field to override the default sort.
             indicator_sort = meta['sort']
           end
+          if meta.has_key?('graph_annotations') && meta['graph_annotations'].length > 0
+            meta['graph_annotations'].each do |annotation|
+              if annotation.has_key?('borderDash') && annotation['borderDash'].is_a?(String)
+                annotation['borderDash'] = [2, 2]
+                opensdg_notice('The "borderDash" property in graph annotations must be an array. Using [2, 2].')
+              end
+            end
+          end
           available_indicator = {
             'number' => indicator_number,
             'slug' => indicator_number.gsub('.', '-'),
@@ -438,8 +479,8 @@ module JekyllOpenSdgPlugins
             doc.data['target'] = available_targets[language].find {|x| x['number'] == target_number}
             indicator_index = available_indicators[language].find_index {|x| x['number'] == indicator_number}
             doc.data['indicator'] = available_indicators[language][indicator_index]
-            doc.data['next'] = get_next_item(available_indicators[language], indicator_index)
-            doc.data['previous'] = get_previous_item(available_indicators[language], indicator_index)
+            doc.data['next'] = get_next_indicator(available_indicators[language], indicator_index)
+            doc.data['previous'] = get_previous_indicator(available_indicators[language], indicator_index)
 
           elsif collection == 'goals'
             # For goals we also set the current goal.

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.4.0".freeze
+  VERSION = "1.5.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.4.0
+  version: 1.5.0.pre.beta1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-15 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -101,9 +101,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.1.4
 signing_key: