jekyll-open-sdg-plugins 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 223b4a55da18c4e20ce1e07823c71ea9e12a935598dcbefe39eb37c4246f2757
-  data.tar.gz: 377bc37c6b248fd74f7762bfea0d26ca54ec023d5359da05ade3ce4385fdb204
+  metadata.gz: 84b88b5f39066164b92412735bb030d01c6dfc7210c2c543187aa0d7f53e253a
+  data.tar.gz: 7d663912c4f8b4426f47615b4bce831da3422104a880e33c51276fb244d6de02
 SHA512:
-  metadata.gz: 79d8089c8c040c0bd4fdff209e95ffd54adffa8b929dc1f4804a0c0c1a5b471728f73104d784ce50ed94af12f861764706823d01386ed4aa561a4b462dfa719a
-  data.tar.gz: 33fe8ac6009c5807c5036fdc539ec60300548560e4f8d09dd05560cb06e11ea038ea183c18f8e15ff3ed63ed9960999fb2cd4cbeac6ecdc002c0bc5b2bd1c061
+  metadata.gz: 203de7cb85bee411542589d9c712384a4e1df0e87e12a62ace92f48d7ae35adde6bb3582a789ff95cd450a2fe0236d6436737a9259cdb2b7b7761aac061951db
+  data.tar.gz: '0989f9bd7f936ad4f627ee0b0d6736ab6a96af59fc8edbac5b66f6b0f256f3ecc806d4a8004c3f8e359d2ec451a9d46999fa56471ad9454d9f8a45b211f157fa'

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

@@ -37,7 +37,13 @@ module JekyllOpenSdgPlugins
           end
           # Loop through the goals.
           goal_index = 0
-          goals.keys.sort.each do |goal|
+          # In the SDGs the goals are numeric, so try to sort them numerically.
+          begin
+            goals_sorted = goals.keys.sort_by { |k| k.to_i if Float(k) rescue k }
+          rescue
+            goals_sorted = goals.keys.sort
+          end
+          goals_sorted.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.
@@ -59,8 +65,17 @@ module JekyllOpenSdgPlugins
 
       goal_content = ''
       if site.config['create_goals'].has_key?('goals')
-        if !site.config['create_goals']['goals'][goal_index].nil?
-          goal_content = site.config['create_goals']['goals'][goal_index]['content']
+        # Try to find goal content by match the goal ID with a "goal" property on each item
+        # in the create_goals.goals site config. Otherwise fallback to the order they appear
+        # in that list.
+        goal_by_goal = site.config['create_goals']['goals'].detect {|g| g['goal'].to_s == goal.to_s }
+        goal_by_index = site.config['create_goals']['goals'][goal_index]
+        if !goal_by_goal.nil?
+          goal_content = goal_by_goal['content']
+        elsif !goal_by_index.nil?
+          if !goal_by_index.has_key?('goal') || goal_by_index['goal'].to_s == goal.to_s
+            goal_content = goal_by_index['content']
+          end
         end
       end
       @content = goal_content

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

@@ -690,6 +690,57 @@
                 }
             ]
         },
+        "publications": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Publications",
+            "description": "This setting controls the content of the 'Related publications' tab. It can contain any number of publications. You may have much of this information in the indicator metadata, but this configuration is available to supplement the metadata with a more structured way to list multiple publications.",
+            "items": {
+                "type": "object",
+                "title": "Publication",
+                "properties": {
+                    "title": {
+                        "type": "string",
+                        "title": "Title"
+                    },
+                    "link": {
+                        "type": "string",
+                        "title": "Link"
+                    },
+                    "description": {
+                        "type": "string",
+                        "title": "description",
+                        "format": "markdown"
+                    },
+                    "date": {
+                        "type": "string",
+                        "title": "Date"
+                    }
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the publications setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#publications"
+                }
+            ]
+        },
+        "related_indicators": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Related indicators",
+            "description": "This setting controls the 'Related indicators' tab. Specify indicators by using their indicator numbers, such as: 1.1.1",
+            "items": {
+                "type": "string",
+                "title": "Related indicator"
+            },
+            "links": [
+                {
+                    "rel": "More information on the related_indicators setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#related_indicators"
+                }
+            ]
+        },
         "reporting_status": {
             "type": "string",
             "title": "Reporting status",
@@ -713,6 +764,73 @@
                 }
             ]
         },
+        "sources": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Sources",
+            "description": "This setting controls the content of the 'Sources' tab. It can contain any number sources. You may have much of this information in the metadata, but this configuration is available to supplement the metadata with a more structured way to list multiple sources.",
+            "items": {
+                "type": "object",
+                "title": "Source",
+                "properties": {
+                    "organisation": {
+                        "type": "string",
+                        "title": "Organisation"
+                    },
+                    "periodicity": {
+                        "type": "string",
+                        "title": "Periodicity"
+                    },
+                    "earliest_available": {
+                        "type": "string",
+                        "title": "Earliest available data"
+                    },
+                    "geographical_coverage": {
+                        "type": "string",
+                        "title": "Geographical coverage"
+                    },
+                    "url": {
+                        "type": "string",
+                        "title": "URL"
+                    },
+                    "url_text": {
+                        "type": "string",
+                        "title": "URL text"
+                    },
+                    "release_date": {
+                        "type": "string",
+                        "title": "Release date"
+                    },
+                    "next_release": {
+                        "type": "string",
+                        "title": "Next release"
+                    },
+                    "statistical_classification": {
+                        "type": "string",
+                        "title": "Statistical classification"
+                    },
+                    "contact": {
+                        "type": "string",
+                        "title": "Contact"
+                    },
+                    "other_info": {
+                        "type": "string",
+                        "title": "Other information",
+                        "format": "markdown"
+                    },
+                    "logo": {
+                        "type": "string",
+                        "title": "Path to logo image"
+                    }
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the sources setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#sources"
+                }
+            ]
+        },
         "standalone": {
             "title": "Standalone indicator",
             "type": "boolean",

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

@@ -131,6 +131,11 @@
                     "description": "This setting can be used to show navigation links to the previous/next goals.",
                     "format": "checkbox"
                 },
+                "goal_content_heading": {
+                    "type": "string",
+                    "title": "Goal content heading",
+                    "description": "Text entered here will appear as an H2 heading above any content configured below in 'goals'."
+                },
                 "goals": {
                     "options": {"collapsed": true},
                     "type": "array",
@@ -145,6 +150,11 @@
                                 "title": "Content",
                                 "format": "markdown",
                                 "description": "Markdown content or a translation key for this goal."
+                            },
+                            "goal": {
+                                "type": "string",
+                                "title": "Goal",
+                                "description": "Optionally specify the goal ID this content applies to. Can be left blank if using the correct order of the goals (1, 2, 3, etc.)."
                             }
                         }
                     }
@@ -385,6 +395,28 @@
                 }
             ]
         },
+        "empty_metadata_placeholder": {
+            "type": "string",
+            "title": "Empty metadata placeholder",
+            "description": "This setting controls the text that will display for any metadata field which has no content. Note that this is not used if 'hide_empty_metadata' is true.",
+            "links": [
+                {
+                    "rel": "More information on the empty metadata placeholder setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#empty_metadata_placeholder"
+                }
+            ]
+        },
+        "empty_metadata_placeholder_sources": {
+            "type": "string",
+            "title": "Empty metadata placeholder (sources)",
+            "description": "This setting controls the text that will display for any sources field which has no content. Note that this is not used if 'hide_empty_metadata' is true.",
+            "links": [
+                {
+                    "rel": "More information on the empty metadata placeholder (sources) setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#empty_metadata_placeholder_sources"
+                }
+            ]
+        },
         "environment": {
             "type": "string",
             "minLength": 1,
@@ -667,6 +699,22 @@
                 }
             ]
         },
+        "ignored_disaggregations": {
+            "options": {"collapsed": true},
+            "type": "array",
+            "title": "Ignored disaggregations",
+            "description": "An optional list of data columns that should not appear as disaggregation drop-downs in the left sidebar.",
+            "items": {
+                "type": "string",
+                "title": "Ignored disaggregation"
+            },
+            "links": [
+                {
+                    "rel": "More information on the ignored_disaggregations setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#ignored_disaggregations"
+                }
+            ]
+        },
         "indicator_config_form": {
             "options": {"collapsed": true},
             "type": "object",
@@ -1120,6 +1168,11 @@
                     "type": "string",
                     "description": "A heading to display before the progress status on indicator pages."
                 },
+                "status_help": {
+                    "title": "Status help",
+                    "type": "string",
+                    "description": "An explanatory column header above the progress status on goal pages."
+                },
                 "status_types": {
                     "options": {"collapsed": true},
                     "type": "array",

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

@@ -433,6 +433,32 @@ module JekyllOpenSdgPlugins
               available_indicator[key] = opensdg_translate_key(value, translations, language)
             end
           end
+          # Translate the ignored_disaggregations site configuration for this particular indicator.
+          if site.config.has_key?('ignored_disaggregations') && site.config['ignored_disaggregations'].is_a?(Array)
+            translated_ignored_disaggregations = []
+            site.config['ignored_disaggregations'].each do |key|
+              translated = opensdg_translate_key(key, translations, language)
+              if translated == key && key.is_a?(String)
+                # If no translation happened, also try the SDMX convention of using the dimension code
+                # for both the "translation group" and the "translation key". Eg, "OBS_STATUS.OBS_STATUS"
+                sdmx_key = key + '.' + key
+                sdmx_translation = opensdg_translate_key(sdmx_key, translations, language)
+                if sdmx_translation != sdmx_key
+                  translated = sdmx_translation
+                else
+                  # If still no translation happened, also try the "data" translation group.
+                  data_key = 'data.' + key
+                  data_translation = opensdg_translate_key(data_key, translations, language)
+                  if data_translation != data_key
+                    translated = data_translation
+                  end
+                end
+              end
+              translated_ignored_disaggregations.push(translated)
+            end
+            available_indicator['ignored_disaggregations'] = translated_ignored_disaggregations
+          end
+
           available_indicators[language].push(available_indicator)
         end
       end

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

@@ -13,6 +13,12 @@ module Jekyll
       translations = site.data['translations']
       language = @context.environments.first["page"]['language']
       translated = opensdg_translate_key(key, translations, language)
+
+      # Stop now if we do not have a string.
+      unless translated.is_a?(String)
+        return translated
+      end
+
       # Also look for references to site configuration within the translation,
       # as "%" parameters.
       translated = translated.gsub(/%([a-zA-Z0-9_.]+)/) do |match|

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-open-sdg-plugins
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-25 00:00:00.000000000 Z
+date: 2022-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Jekyll plugins for use with the Open SDG platform