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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a89cf02d816079a37d7a46f926a77b8e084ea6521b9a8dbe2a6616b8fbddb0f
-  data.tar.gz: 62d0c38503090c81c54e7d15bc32dbf50f87b9257f659829bf98b2c6a4658e67
+  metadata.gz: f6de9152fa38e922c20c0a0ad30146daf4fa4366dcd3d7adfdf40f2c2db47485
+  data.tar.gz: 3b667053f64fac03603e2510fc7d64129d4693975aa88673d2b98e191df305d7
 SHA512:
-  metadata.gz: a289cf63df4aae969859ef27dfcb357a56286c1fcbb81598332ff9ad20eea765f62b87e7e03eb60682852b8fca3055a8dc18956a45112843c4bd1dc1a12ef323
-  data.tar.gz: 32c575404cddbc955955ce28845853424580f639c8d8cfa003e83f43e9d6a42d048219273e6f367234391f5e23e14a75d575d9e21bf4e7f941a34ea87f9573f8
+  metadata.gz: 47e4c01c0e3a26dadc816e509eb4fe7256357f627a2ad37a5cc4cfe0825bc59a017b157a798654aa2e3a810c213c2f376a731fa3e089e4e7cf01c222d133270b
+  data.tar.gz: 321ff77fc2b09632bb75e41f2a13cca2ac6fbe4b85e487539ebeb13e7181e3c199b95f00d30d9203b21148cb13b5b0ccd1e3a3191ff4450172fe226e36e05d0c

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

@@ -8,20 +8,12 @@ module JekyllOpenSdgPlugins
 
     def generate(site)
       # If site.create_goals is set, create goals per the metadata.
-      if site.config['languages'] and site.config['create_goals'] and site.config['create_goals'].key?('layout') and site.config['create_goals']['layout'] != ''
+      if site.config['languages'] and site.config['create_goals']
         # Compile the list of goals.
         goals = {}
-        # Are we using translated builds?
         metadata = {}
-        if opensdg_translated_builds(site)
-          # If we are using translated builds, the 'meta' data is underneath
-          # language codes. We just use the first language.
-          default_language = site.config['languages'][0]
-          metadata = site.data[default_language]['meta']
-        else
-          # Otherwise the 'meta' data is not underneath any language code.
-          metadata = site.data['meta']
-        end
+        default_language = site.config['languages'][0]
+        metadata = site.data[default_language]['meta']
         metadata.each do |inid, indicator|
           if indicator.has_key?('standalone') and indicator['standalone']
             next
@@ -30,7 +22,7 @@ module JekyllOpenSdgPlugins
           goals[goal] = true
         end
         # Decide what layout to use for the goal pages.
-        layout = site.config['create_goals']['layout']
+        layout = 'goal'
         # See if we need to "map" any language codes.
         languages_public = Hash.new
         if site.config['languages_public']
@@ -78,8 +70,6 @@ module JekyllOpenSdgPlugins
       self.data['goal_number'] = goal.to_s
       self.data['language'] = language
       self.data['layout'] = layout
-      # Backwards compatibility:
-      self.data['sdg_goal'] = self.data['goal_number']
     end
   end
 end

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

@@ -16,9 +16,9 @@ module JekyllOpenSdgPlugins
 
       translations = site.data['translations']
       # If site.create_indicators is set, create indicators per the metadata.
-      if (language_config and indicator_config and indicator_config.key?('layout') and indicator_config['layout'] != '')
+      if (language_config and indicator_config)
         # Decide what layout to use for the indicator pages.
-        layout = indicator_config['layout']
+        layout = 'indicator'
         # See if we need to "map" any language codes.
         languages_public = Hash.new
         if site.config['languages_public']
@@ -32,14 +32,7 @@ module JekyllOpenSdgPlugins
             language_public = languages_public[language]
           end
           metadata = {}
-          if opensdg_translated_builds(site)
-            # If we are using translated builds, the metadata is underneath a
-            # language code.
-            metadata = site.data[language]['meta']
-          else
-            # Otherwise the 'meta' data is not underneath any language code.
-            metadata = site.data['meta']
-          end
+          metadata = site.data[language]['meta']
           # Loop through the indicators (using metadata as a list).
           metadata.each do |inid, meta|
             permalink = inid
@@ -61,24 +54,17 @@ module JekyllOpenSdgPlugins
         if do_indicator_config_forms || do_indicator_meta_forms || do_indicator_data_forms
 
           metadata = {}
-          if opensdg_translated_builds(site)
-            if site.data.has_key?('untranslated')
-              metadata = site.data['untranslated']['meta']
-            else
-              default_language = language_config[0]
-              metadata = site.data[default_language]['meta']
-            end
+          
+          if site.data.has_key?('untranslated')
+            metadata = site.data['untranslated']['meta']
           else
-            metadata = site.data['meta']
+            default_language = language_config[0]
+            metadata = site.data[default_language]['meta']
           end
 
           metadata_by_language = {}
           language_config.each do |language|
-            if opensdg_translated_builds(site)
-              metadata_by_language[language] = site.data[language]['meta']
-            else
-              metadata_by_language[language] = site.data['meta']
-            end
+            metadata_by_language[language] = site.data[language]['meta']
           end
 
           # Because we have config forms for indicator config or meta/data, we
@@ -159,8 +145,6 @@ module JekyllOpenSdgPlugins
       self.data['indicator_number'] = inid.gsub('-', '.')
       self.data['layout'] = layout
       self.data['language'] = language
-      # Backwards compatibility:
-      self.data['indicator'] = self.data['indicator_number']
     end
   end
 

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

@@ -33,20 +33,11 @@ module JekyllOpenSdgPlugins
       if (site.config['languages'] and site.config['create_pages'])
 
         default_pages = [
-          {
-            'folder' => '/',
-            'layout' => 'frontpage'
-          },
           {
             'folder' => '/reporting-status',
             'layout' => 'reportingstatus',
             'title' => 'status.reporting_status',
           },
-          {
-            'filename' => 'indicators.json',
-            'folder' => '/',
-            'layout' => 'indicator-json',
-          },
           {
             'folder' => '/search',
             'layout' => 'search',
@@ -55,15 +46,32 @@ module JekyllOpenSdgPlugins
         ]
         pages = default_pages
         if (site.config['create_pages'].is_a?(Hash) and site.config['create_pages'].key?('pages'))
-          # Backwards compatability to support the deprecated "pages" key.
-          pages = site.config['create_pages']['pages']
-        elsif site.config['create_pages'].is_a?(Array)
+          opensdg_error('The create_pages setting is not in the correct format. Please consult the latest documentation: https://open-sdg.readthedocs.io/en/latest/configuration/#create_pages')
+        end
+        if site.config['create_pages'].is_a?(Array)
           pages = site.config['create_pages']
         end
 
         # Clone pages so that we don't edit the original.
         pages = pages.clone
 
+        # Automate the frontpage and indicators.json if not already there.
+        frontpage = pages.find { |page| page['folder'] == '/' && page['filename'] == nil }
+        if frontpage == nil || frontpage['layout'] == 'frontpage-alt'
+          pages.push({
+            'folder' => '/',
+            'layout' => 'frontpage',
+          })
+        end
+        indicatorjson = pages.find { |page| page['layout'] == 'indicator-json' }
+        if indicatorjson == nil
+          pages.push({
+            'folder' => '/',
+            'layout' => 'indicator-json',
+            'filename' => 'indicators.json'
+          })
+        end
+
         # Hardcode the site configuration page if it's not already there.
         form_settings = site.config['site_config_form']
         config_page = pages.find { |page| page['layout'] == 'config-builder' }

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

@@ -59,27 +59,6 @@ module JekyllOpenSdgPlugins
       return build
     end
 
-    # Predict (before data has been fetched) whether the site is using
-    # translated builds or not.
-    def site_uses_translated_builds(path)
-
-      is_remote = opensdg_is_path_remote(path)
-      endpoints = get_endpoints()
-      # For a quick test, we just use 'meta'.
-      meta = endpoints['meta']
-      endpoint = is_remote ? path + '/' + meta : File.join(path, fix_path(meta))
-
-      begin
-        json_file = is_remote ? open(endpoint) : File.open(endpoint)
-      rescue StandardError => e
-        # If we didn't find an untranslated 'meta', we assume translated builds.
-        return true
-      end
-
-      # Other wise assume untranslated builds.
-      return false
-    end
-
     def generate(site)
 
       # For below, make sure there is at least an empty hash at
@@ -99,85 +78,47 @@ module JekyllOpenSdgPlugins
       is_remote = opensdg_is_path_remote(build_location)
 
       build_location = is_remote ? build_location : File.join(Dir.pwd, build_location)
-      translated_builds = site_uses_translated_builds(build_location)
 
-      if translated_builds
-        # For translated builds, we get a build for each language, and
-        # place them in "subfolders" (so to speak) of site.data.
-        subfolders = site.config['languages'].clone
-        subfolders.append('untranslated')
-        subfolders.each do |language|
-          data_target = site.data[language]
-          translated_build = is_remote ? build_location + '/' + language : File.join(build_location, language)
-          data_source = fetch_build(translated_build)
-          if !data_source.empty?
-            if data_target
-              data_target.deep_merge(data_source)
-            else
-              site.data[language] = data_source
-            end
-          end
-        end
-        # We move the language-specific translations to the
-        # site.data.translations location, where all translations are kept.
-        site.config['languages'].each do |language|
-          translation_target = site.data['translations'][language]
-          translation_source = site.data[language]['translations']
-          if translation_target
-            translation_target.deep_merge(translation_source)
+      # We get a build for each language, and place them in "subfolders"
+      # (so to speak) of site.data.
+      subfolders = site.config['languages'].clone
+      subfolders.append('untranslated')
+      subfolders.each do |language|
+        data_target = site.data[language]
+        translated_build = is_remote ? build_location + '/' + language : File.join(build_location, language)
+        data_source = fetch_build(translated_build)
+        if !data_source.empty?
+          if data_target
+            data_target.deep_merge(data_source)
           else
-            site.data['translations'][language] = translation_source
+            site.data[language] = data_source
           end
         end
-        # And there are some parts of the build that don't need to be translated
-        # and should be moved to the top level.
-        first_language = site.config['languages'][0]
-        site.data['reporting'] = site.data[first_language]['reporting']
-        site.data['schema'] = site.data[first_language]['schema']
-        site.data['zip'] = site.data[first_language]['zip']
-      else
-        # For untranslated builds, we download one build only, and place it
-        # in the "root" (so to speak) of site.data. Nothing else is needed.
-        target = site.data
-        source = fetch_build(build_location)
-        if !source.empty?
-          target.deep_merge(source)
-        end
       end
-
-      # Finally support the deprecated 'remote_translations' option.
-      # This is deprecated because translations should now be in the
-      # data repository, where they will be fetched in fetch_build().
-      if site.config['remote_translations']
-        key = 'translations'
-        target = site.data[key]
-        site.config['remote_translations'].each do |endpoint|
-          begin
-            source = JSON.load(open(endpoint))
-            if target
-              target.deep_merge(source)
-            else
-              site.data[key] = source
-            end
-          rescue StandardError => e
-            puts e.message
-            abort 'Unable to fetch remote translation from: ' + endpoint
-          end
+      # We move the language-specific translations to the
+      # site.data.translations location, where all translations are kept.
+      site.config['languages'].each do |language|
+        translation_target = site.data['translations'][language]
+        translation_source = site.data[language]['translations']
+        if translation_target
+          translation_target.deep_merge(translation_source)
+        else
+          site.data['translations'][language] = translation_source
         end
       end
+      # And there are some parts of the build that don't need to be translated
+      # and should be moved to the top level.
+      first_language = site.config['languages'][0]
+      site.data['reporting'] = site.data[first_language]['reporting']
+      site.data['schema'] = site.data[first_language]['schema']
+      site.data['zip'] = site.data[first_language]['zip']
     end
   end
 
-  # This makes sure that the contents of the "local_data_folder" get copied
+  # This makes sure that the contents of any local data build get copied
   # into the Jekyll build, so that they can be served from the website.
   Jekyll::Hooks.register :site, :post_write do |site|
-    if site.config['local_data_folder']
-      source = File.join(Dir.pwd, site.config['local_data_folder'], '.')
-      destination = site.config['destination']
-      FileUtils.cp_r(source, destination)
-    # Do the same in the case that "remote_data_prefix" is being used for a local
-    # data folder (since "local_data_folder" is deprecated and undocumented).
-    elsif site.config['remote_data_prefix']
+    if site.config['remote_data_prefix']
       if !opensdg_is_path_remote(site.config['remote_data_prefix'])
         source = File.join(Dir.pwd, site.config['remote_data_prefix'], '.')
         destination = site.config['destination']

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

@@ -2,6 +2,56 @@
 
 require "jekyll"
 
+# Takes a string that might be a textual representation of a
+# site configuration, such as "baseurl" or "country.name".
+def opensdg_parse_site_config(key, site)
+
+  # Safety code - abort now if key is nil.
+  if key.nil?
+    return ""
+  end
+
+  # Also make sure it is a string, and other just return it.
+  if not key.is_a? String
+    return key
+  end
+
+  # More safety code - abort now if key is empty.
+  if key.empty?
+    return ""
+  end
+
+  # Keep track of the last thing we drilled to.
+  drilled = site.config
+
+  # Keep track of how many levels we have drilled.
+  levels_drilled = 0
+  levels = key.split('.')
+
+  # Loop through each level.
+  levels.each do |level|
+
+    # If we have drilled down to a scalar value too soon, abort.
+    break if drilled.class != Hash and drilled.class != Jekyll::Configuration
+
+    if drilled.has_key? level
+      # If we find something, continue drilling.
+      drilled = drilled[level]
+      levels_drilled += 1
+    end
+
+  end
+
+  # If we didn't drill the right number of levels, return the
+  # original string.
+  if levels.length != levels_drilled
+    return key
+  end
+
+  # Otherwise we must have drilled all they way.
+  return drilled
+end
+
 # Takes a translation key and returns a translated string according to the
 # language of the current page. Or if none is found, returns the original
 # key.
@@ -49,29 +99,26 @@ def opensdg_translate_key(key, translations, language)
     return key
   end
 
+  # If the result is still not a string, return the original string.
+  if drilled.class != String
+    return key
+  end
+
   # Otherwise we must have drilled all they way.
   return drilled
 end
 
-# Takes a site object and decides whether it is using translated builds.
-def opensdg_translated_builds(site)
-  # Assume the site is using translated builds.
-  translated_builds = true
-  site.config['languages'].each do |language|
-    # If any languages don't have a key in site.data, the site is not using
-    # translated builds.
-    if !site.data.has_key? language
-      translated_builds = false
-    end
-  end
-  return translated_builds
-end
-
 # Print a notice during compilation.
 def opensdg_notice(message)
   Jekyll.logger.warn message.yellow
 end
 
+# Print an error that should halt the build.
+def opensdg_error(message)
+  Jekyll.logger.error message.red
+  exit 1
+end
+
 # Get the public language codes for a site, keyed by the actual language codes.
 def opensdg_languages_public(site)
   languages_public = site.config['languages_public']

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

@@ -3,30 +3,6 @@
     "title": "Open SDG site configuration",
     "description": "This form will produce the site configuration for your Open SDG implementation.",
     "properties": {
-        "accessible_charts": {
-            "title": "Accessible charts",
-            "type": "boolean",
-            "description": "This setting can be set to `true` to enable chart functionality that is intended to increase accessibility by adding support for screenreaders and keyboard navigation.",
-            "format": "checkbox",
-            "links": [
-                {
-                    "rel": "More information on the accessible charts setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#accessible_charts"
-                }
-            ]
-        },
-        "accessible_tabs": {
-            "title": "Accessible tabs",
-            "type": "boolean",
-            "description": "This setting can be set to `true` to enable tab functionality that is compliant with the WAI-ARIA best practices. This adds improved keyboard navigation of the tabs.",
-            "format": "checkbox",
-            "links": [
-                {
-                    "rel": "More information on the accessible tabs setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#accessible_tabs"
-                }
-            ]
-        },
         "analytics": {
             "options": {"collapsed": true},
             "type": "object",
@@ -97,25 +73,6 @@
                 }
             ]
         },
-        "contrast_type": {
-            "type": "string",
-            "title": "Contrast type",
-            "description": "The type of high-contrast toggle to use.",
-            "enum": ["default", "single", "long"],
-            "options": {
-                "enum_titles": [
-                    "Default - two 'A' buttons side-by-side",
-                    "Single - one 'A' button which toggles on/off",
-                    "Long - text toggling between 'High contrast' and 'Default contrast'"
-                ]
-            },
-            "links": [
-                {
-                    "rel": "More information on the contrast type setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#contrast_type"
-                }
-            ]
-        },
         "cookie_consent_form": {
             "options": {"collapsed": true},
             "type": "object",
@@ -168,27 +125,6 @@
             "title": "Create goals",
             "description": "This setting can be used to automatically create the goal pages.",
             "properties": {
-                "layout": {
-                    "type": "string",
-                    "title": "Layout",
-                    "enum": [
-                        "",
-                        "goal",
-                        "goal-by-target",
-                        "goal-by-target-vertical",
-                        "goal-with-progress"
-                    ],
-                    "options": {
-                        "enum_titles": [
-                            "Do not automatically create goals",
-                            "goal",
-                            "goal-by-target",
-                            "goal-by-target-vertical",
-                            "goal-with-progress"
-                        ]
-                    },
-                    "description": "The layout to use for the goal pages."
-                },
                 "previous_next_links": {
                     "title": "Previous/next links",
                     "type": "boolean",
@@ -227,21 +163,6 @@
             "title": "Create indicators",
             "description": "This setting can be used to automatically create the indicator pages.",
             "properties": {
-                "layout": {
-                    "type": "string",
-                    "title": "Layout",
-                    "enum": [
-                        "",
-                        "indicator"
-                    ],
-                    "options": {
-                        "enum_titles": [
-                            "Do not automatically create indicators",
-                            "indicator"
-                        ]
-                    },
-                    "description": "The layout to use for the indicator pages."
-                },
                 "previous_next_links": {
                     "title": "Previous/next links",
                     "type": "boolean",
@@ -414,6 +335,12 @@
                     "type": "string",
                     "title": "Message",
                     "description": "A short disclaimer message."
+                },
+                "hidden": {
+                    "type": "boolean",
+                    "title": "Hidden",
+                    "description": "Hide the disclaimer.",
+                    "format": "checkbox"
                 }
             },
             "links": [
@@ -471,24 +398,6 @@
                 }
             ]
         },
-        "favicons": {
-            "type": "string",
-            "title": "Favicons",
-            "description": "The type of favicons to use.",
-            "enum": ["legacy", "favicon.io"],
-            "options": {
-                "enum_titles": [
-                    "Legacy",
-                    "Favicon.io (recommended)"
-                ]
-            },
-            "links": [
-                {
-                    "rel": "More information on the favicons setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#favicons"
-                }
-            ]
-        },
         "footer_language_toggle": {
             "type": "string",
             "title": "Footer language toggle",
@@ -579,28 +488,6 @@
                 }
             ]
         },
-        "frontpage_heading": {
-            "type": "string",
-            "title": "Frontpage heading",
-            "description": "This setting can control the heading that appears on the front page. This setting is only used in the frontpage layout.",
-            "links": [
-                {
-                    "rel": "More information on the frontpage heading setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_heading"
-                }
-            ]
-        },
-        "frontpage_instructions": {
-            "type": "string",
-            "title": "Frontpage instructions",
-            "description": "This setting can control the instructions that appear on the front page. This setting is only used in the frontpage layout.",
-            "links": [
-                {
-                    "rel": "More information on the frontpage instructions setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_instructions"
-                }
-            ]
-        },
         "frontpage_introduction_banner": {
             "options": {"collapsed": true},
             "type": "object",
@@ -732,35 +619,6 @@
                 }
             ]
         },
-        "header": {
-            "options": {"collapsed": true},
-            "type": "object",
-            "title": "Header",
-            "description": "This setting can be used to customise the header.",
-            "properties": {
-                "include": {
-                    "type": "string",
-                    "title": "Include file",
-                    "enum": [
-                        "header-default.html",
-                        "header-menu-left-aligned.html"
-                    ],
-                    "options": {
-                        "enum_titles": [
-                            "Default header",
-                            "Menu left-aligned"
-                        ]
-                    },
-                    "description": "The header style to use on all pages."
-                }
-            },
-            "links": [
-                {
-                    "rel": "More information on the header setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#header"
-                }
-            ]
-        },
         "header_language_toggle": {
             "type": "string",
             "title": "Header language toggle",
@@ -1044,6 +902,12 @@
             "title": "Map options",
             "description": "Site-wide configuration of map behavior and style.",
             "properties": {
+                "disaggregation_controls": {
+                    "title": "Disaggregation controls",
+                    "type": "boolean",
+                    "description": "Whether the map should provide a button and form for changing the displayed disaggregation.",
+                    "format": "checkbox"
+                },
                 "minZoom": {
                     "title": "Minimum zoom",
                     "type": "integer",
@@ -1245,17 +1109,6 @@
                 }
             ]
         },
-        "non_global_metadata": {
-            "type": "string",
-            "title": "Non-global metadata",
-            "description": "This setting can be used to control the text of the tab containing non-global metadata.",
-            "links": [
-                {
-                    "rel": "More information on the non-global metadata setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#non_global_metadata"
-                }
-            ]
-        },
         "progress_status": {
             "options": {"collapsed": true},
             "type": "object",
@@ -1443,18 +1296,6 @@
                 }
             ]
         },
-        "series_toggle": {
-            "title": "Series toggle",
-            "type": "boolean",
-            "description": "This setting enables the special treatment of the 'Series' column in the data. If set to true, when an indicator's data includes a 'Series' column, it will be displayed above 'Units' as radio buttons.",
-            "format": "checkbox",
-            "links": [
-                {
-                    "rel": "More information on the series toggle setting",
-                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#series_toggle"
-                }
-            ]
-        },
         "site_config_form": {
             "options": {"collapsed": true},
             "type": "object",
@@ -1462,6 +1303,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/sdg_variables.rb

@@ -294,7 +294,7 @@ module JekyllOpenSdgPlugins
       # country-specific metadata doesn't use any of these fields.
       protected_keys = ['goals', 'goal', 'targets', 'target', 'indicators',
         'indicator', 'language', 'name', 'number', 'sort', 'global', 'url',
-        'goal_number', 'target_number'
+        'goal_number', 'target_number', 'indicator_number'
       ]
 
       # Figure out from our translations the global indicator numbers.
@@ -304,7 +304,7 @@ module JekyllOpenSdgPlugins
 
       # For available indicators, we simply map the "indicators" collection.
       available_inids = site.collections['indicators'].docs.select { |x| x.data['language'] == default_language }
-      available_inids = available_inids.map { |x| x.data['indicator'] }
+      available_inids = available_inids.map { |x| x.data['indicator_number'] }
       available_indicators = {}
       available_targets = {}
       available_goals = {}
@@ -355,20 +355,7 @@ module JekyllOpenSdgPlugins
           # arbitrary (it's because they came from filenames) and could maybe
           # be changed eventually to dot-delimited for consistency.
           meta_key = indicator_number.gsub('.', '-')
-          # The location of the metadata is different depending on whether we are
-          # using "translated_builds" or not.
-          if opensdg_translated_builds(site)
-            meta = site.data[language]['meta'][meta_key]
-          else
-            meta = site.data['meta'][meta_key]
-            # Also for untranslated builds, we need to support the "subfolder"
-            # approach for metadata translation. (This is handled at build-time
-            # for translated builds.)
-            if meta.has_key? language
-              meta = meta.merge(meta[language])
-              meta.delete(language)
-            end
-          end
+          meta = site.data[language]['meta'][meta_key]
 
           is_standalone = (meta.has_key?('standalone') and meta['standalone'])
           is_placeholder = (meta.has_key?('placeholder') and meta['placeholder'] != '')
@@ -489,12 +476,8 @@ module JekyllOpenSdgPlugins
           else
             doc.data['remote_data_prefix'] = normalize_baseurl(baseurl)
           end
-          if opensdg_translated_builds(site)
-            doc.data['remote_data_prefix_untranslated'] = File.join(doc.data['remote_data_prefix'], 'untranslated')
-            doc.data['remote_data_prefix'] = File.join(doc.data['remote_data_prefix'], language)
-          else
-            doc.data['remote_data_prefix_untranslated'] = doc.data['remote_data_prefix']
-          end
+          doc.data['remote_data_prefix_untranslated'] = File.join(doc.data['remote_data_prefix'], 'untranslated')
+          doc.data['remote_data_prefix'] = File.join(doc.data['remote_data_prefix'], language)
 
           # Set the logo for this page.
           logo = {}
@@ -525,11 +508,8 @@ module JekyllOpenSdgPlugins
             # For indicators we also set the current indicator/target/goal.
             if doc.data.has_key? 'indicator_number'
               indicator_number = doc.data['indicator_number']
-            elsif doc.data.has_key? 'indicator'
-              # Backwards compatibility.
-              indicator_number = doc.data['indicator']
             else
-              raise "Error: An indicator does not have 'indicator_number' property."
+              opensdg_error("Error: An indicator does not have 'indicator_number' property.")
             end
             # Force the indicator number to be a string.
             if indicator_number.is_a? Numeric
@@ -551,11 +531,8 @@ module JekyllOpenSdgPlugins
             # For goals we also set the current goal.
             if doc.data.has_key? 'goal_number'
               goal_number = doc.data['goal_number']
-            elsif doc.data.has_key? 'sdg_goal'
-              # Backwards compatibility.
-              goal_number = doc.data['sdg_goal']
             else
-              raise "Error: A goal does not have 'goal_number' property."
+              opensdg_error("Error: A goal does not have 'goal_number' property.")
             end
             # Force the goal number to be a string.
             if goal_number.is_a? Numeric

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

@@ -41,6 +41,11 @@ module JekyllOpenSdgPlugins
           end
       end
 
+      # Abort early if some required settings are not there.
+      unless site.config.has_key?('languages') && site.config['languages'].length > 0
+        opensdg_error('The "languages" site configuration must have at least one language. See the documentation here: https://open-sdg.readthedocs.io/en/latest/configuration/#languages')
+      end
+
       # Hardcode some variables.
       site.config['disaggregation_status'] = {}
       site.config['disaggregation_status']['status_types'] = [
@@ -61,6 +66,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/translate_date.rb

@@ -26,25 +26,13 @@ module Jekyll
       #     language: es
       #     format: "%d de %b de %Y"
       #
-      # However the following deprecated structure is also supported:
-      #
-      # date_formats:
-      #   standard:
-      #     en: "%b %d, %Y"
-      #     es: "%d de %b de %Y"
-      #     etc...
       date_format = '%b %d, %Y'
       if config.has_key?('date_formats')
-
-        # @deprecated start
-        # In a deprecated form of date_formats, it was a nested hash keyed first
-        # by the format type and then by the language.
-        if config['date_formats'].is_a?(Hash) && config['date_formats'].has_key?(format_type)
-          if config['date_formats'][format_type].has_key?(language)
-            date_format = config['date_formats'][format_type][language]
-          end
+        
+        # Abort if this setting is using an old format.
+        if config['date_formats'].is_a?(Hash)
+          opensdg_error('The "date_formats" site configuration must be in a list format. See the documentation here: https://open-sdg.readthedocs.io/en/latest/configuration/#date_formats')
         end
-        # @deprecated end
 
         # In the current form of data_formats, it is an array of hashes, each
         # containing "type", "language", and "format" keys.

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

@@ -9,10 +9,36 @@ module Jekyll
     def t(key)
 
       # Determine the language of the current page.
-      translations = @context.registers[:site].data['translations']
+      site = @context.registers[:site]
+      translations = site.data['translations']
       language = @context.environments.first["page"]['language']
+      translated = opensdg_translate_key(key, translations, language)
+      # Also look for references to site configuration within the translation,
+      # as "%" parameters.
+      translated = translated.gsub(/%([a-zA-Z0-9_.\-]+)/) do |match|
+        # Special case for trailing dots.
+        trailing_dot = match.end_with?('.')
+        key_candidate = match.delete_suffix('.').delete_prefix('%')
+        # Check to see if it is a site configuration.
+        translated_word = opensdg_parse_site_config(key_candidate, site)
+        # Check to see if the value of the site config may have been
+        # a translation key itself. But do a safety check to avoid
+        # infinite loops.
+        if translated_word != key
+          translated_word = opensdg_translate_key(translated_word, translations, language)
+        end
+        # Replace the word if something changed.
+        if key_candidate != translated_word
+          match = translated_word
+          # Making sure to add back any trailing dots.
+          if trailing_dot
+            match = match + '.'
+          end
+        end
+        match
+      end
 
-      return opensdg_translate_key(key, translations, language)
+      return translated
     end
   end
 end

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

@@ -23,11 +23,7 @@ module JekyllOpenSdgPlugins
           language = site.config['languages'][0]
         end
         metadata = {}
-        if opensdg_translated_builds(site)
-          metadata = site.data[language]['meta']
-        else
-          metadata = site.data['meta']
-        end
+        metadata = site.data[language]['meta']
         # Loop through the indicators (using metadata as a list).
         validation_failed = false
         metadata.each do |inid, meta|

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.7.0".freeze
+  VERSION = "2.0.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: 2.0.0.pre.beta1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-06-17 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: