jekyll-open-sdg-plugins 1.2.0 → 1.3.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c1ce04469e6f2a44c30979e06c5a2782bb2fc0468baa4eb7d8521e4d87750d
-  data.tar.gz: 452f3790764b11cfe9934fb95f310f294b4c8ecca7b200d916b64e85e0354a43
+  metadata.gz: 1579412cd0fc422e1af1ee418f9dcf89d10a8491ff0ce362c269ca49ad3b8f9d
+  data.tar.gz: c67a8ba97b93d0264e28f9cd764cd90f6a7db755ad10e1e5823a1cd4a25b927d
 SHA512:
-  metadata.gz: 9e6baf613af1260e093345739182b08d84d41008495bb2e224b0b4181cb086348636277bbc16e0fe9b67f3d94ca2dae93c84609de49b52c03dc3477b11e818e2
-  data.tar.gz: 6be0fc2e582b7fa8dfb1c945f656ea9220b6d1e277e8953b3d6ab4b6f4a8ac0f66b4d255f2a3b12814343a030ea71789c93441f1f7cb3098634ce5425e66ef5e
+  metadata.gz: 77a40b3a54553c73cc1ff3a560310f97e709b94be07c1b539ed92b0423803ba628454484b3910dc62b4175463fd520c7cd4c5a90c9f051cb6fde6bf6842c6f2a
+  data.tar.gz: d556a58a95a4627a25d947c8dd66470b3f3a580f56baa3c86da25b2b82499a5913a4ef3ec42083676cf7b7e3dffd2f8c9b944a8499e9492ab00a64d6ab0d1191

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

@@ -23,6 +23,9 @@ module JekyllOpenSdgPlugins
           metadata = site.data['meta']
         end
         metadata.each do |inid, indicator|
+          if indicator.has_key?('standalone') and indicator['standalone']
+            next
+          end
           goal = inid.split('-')[0].to_i
           goals[goal] = true
         end

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

@@ -34,8 +34,13 @@ module JekyllOpenSdgPlugins
           end
           # Loop through the indicators (using metadata as a list).
           metadata.each do |inid, meta|
+            permalink = inid
+            if meta.has_key?('permalink') and meta['permalink'] != ''
+              permalink = meta['permalink']
+            end
             # Add the language subfolder for all except the default (first) language.
-            dir = index == 0 ? inid : File.join(language_public, inid)
+            dir = index == 0 ? permalink : File.join(language_public, permalink)
+
             # Create the indicator page.
             site.collections['indicators'].docs << IndicatorPage.new(site, site.source, dir, inid, language, layout)
           end
@@ -64,9 +69,13 @@ module JekyllOpenSdgPlugins
                 language_public = languages_public[language]
               end
               metadata.each do |inid, meta|
-                dir = File.join('config', inid)
+                permalink = inid
+                if meta.has_key?('permalink') and meta['permalink'] != ''
+                  permalink = meta['permalink']
+                end
+                dir = File.join('config', permalink)
                 if index != 0
-                  dir = File.join(language_public, 'config', inid)
+                  dir = File.join(language_public, 'config', permalink)
                 end
                 site.collections['pages'].docs << IndicatorConfigPage.new(site, site.source, dir, inid, language, meta, layout)
               end

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

@@ -3,6 +3,17 @@
     "title": "Open SDG indicator configuration",
     "description": "This form will produce an indicator's configuration for your Open SDG implementation.",
     "properties": {
+        "composite_breakdown_label": {
+            "type": "string",
+            "title": "Composite breakdown label",
+            "description": "Used as a label for the COMPOSITE_BREAKDOWN column, if it appears in the indicator data.",
+            "links": [
+                {
+                    "rel": "More information on the composite breakdown label setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#composite-breakdown-label"
+                }
+            ]
+        },
         "computation_units": {
             "type": "string",
             "title": "Unit of measurement",
@@ -492,6 +503,17 @@
             "title": "Page content",
             "description": "Content which displays in the main content area of the indicator page."
         },
+        "permalink": {
+            "type": "string",
+            "title": "Permalink",
+            "description": "Overrides the normal path of the indicator page. Not recommended, execpt for 'standalone' indicators.",
+            "links": [
+                {
+                    "rel": "More information the permalink setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#standalone-indicators"
+                }
+            ]
+        },
         "reporting_status": {
             "type": "string",
             "title": "Reporting status",
@@ -504,6 +526,29 @@
                 }
             ]
         },
+        "sort": {
+            "type": "string",
+            "title": "Sort order",
+            "description": "Override the default order in which this indicator is displayed in lists. This can be left blank, and it will be automatically determined.",
+            "links": [
+                {
+                    "rel": "More information on the sort setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#sorting-in-lists"
+                }
+            ]
+        },
+        "standalone": {
+            "title": "Standalone indicator",
+            "type": "boolean",
+            "description": "Whether the indicator is standalone (separate from the SDGs) or not.",
+            "format": "checkbox",
+            "links": [
+                {
+                    "rel": "More information the standalone setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#standalone-indicators"
+                }
+            ]
+        },
         "tags": {
             "options": {"collapsed": true},
             "type": "array",

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

@@ -167,6 +167,12 @@
                     },
                     "description": "The layout to use for the goal pages."
                 },
+                "previous_next_links": {
+                    "title": "Previous/next links",
+                    "type": "boolean",
+                    "description": "This setting can be used to show navigation links to the previous/next goals.",
+                    "format": "checkbox"
+                },
                 "goals": {
                     "options": {"collapsed": true},
                     "type": "array",
@@ -213,6 +219,12 @@
                         ]
                     },
                     "description": "The layout to use for the indicator pages."
+                },
+                "previous_next_links": {
+                    "title": "Previous/next links",
+                    "type": "boolean",
+                    "description": "This setting can be used to show navigation links to the previous/next indicators.",
+                    "format": "checkbox"
                 }
             },
             "links": [
@@ -306,6 +318,30 @@
                 }
             ]
         },
+        "data_fields": {
+            "options": {"collapsed": true},
+            "type": "object",
+            "title": "Data fields",
+            "description": "Control the names of fields used for special purposes in data.",
+            "properties": {
+                "units": {
+                    "type": "string",
+                    "title": "Units",
+                    "description": "Field to reserve for units of measurement. Defaults to 'Units'."
+                },
+                "series": {
+                    "type": "string",
+                    "title": "Series",
+                    "description": "Field to reserve for the SDG series. Defaults to 'Series'."
+                }
+            },
+            "links": [
+                {
+                    "rel": "More information on the data fields setting",
+                    "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#data_fields"
+                }
+            ]
+        },
         "date_formats": {
             "options": {"collapsed": true},
             "type": "array",
@@ -580,7 +616,7 @@
             "title": "Graph color set",
             "description": "This setting can be used to customize the color set used in the charts.",
             "examples": [],
-            "enum": ["default", "sdg", "goal", "custom"],
+            "enum": ["default", "accessible", "sdg", "goal", "custom"],
             "links": [
                 {
                     "rel": "More information on the graph color set setting",
@@ -617,6 +653,35 @@
                 }
             ]
         },
+        "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",
@@ -855,7 +920,23 @@
             "title": "Main menu",
             "description": "The links to display in the main menu.",
             "items": {
-                "$ref": "#/definitions/menu_item"
+                "title": "Menu item",
+                "allOf": [
+                    { "$ref": "#/definitions/menu_item" },
+                    {
+                        "properties": {
+                            "dropdown": {
+                                "title": "Dropdown menu",
+                                "type": "array",
+                                "description": "Enter menu items here to turn this into a dropdown.",
+                                "items": {
+                                    "$ref": "#/definitions/menu_item",
+                                    "title": "Dropdown menu item"
+                                }
+                            }
+                        }
+                    }
+                ]
             },
             "links": [
                 {

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

@@ -43,6 +43,24 @@ module JekyllOpenSdgPlugins
       sort_order
     end
 
+    # Get previous item from an array, or loop to the end.
+    def get_previous_item(list, index)
+      decremented = index - 1
+      if decremented < 0
+        decremented = list.length() - 1
+      end
+      list[decremented]
+    end
+
+    # Get next item from an array, or loop to the beginning.
+    def get_next_item(list, index)
+      incremented = index + 1
+      if incremented >= list.length()
+        incremented = 0
+      end
+      list[incremented]
+    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)
@@ -209,6 +227,7 @@ module JekyllOpenSdgPlugins
         goal_number = get_goal_number(indicator_number)
         target_number = get_target_number(indicator_number)
         is_global_indicator = global_inids.index(indicator_number) != nil
+
         # To get the name of global stuff, we can use predicable translation
         # keys from the SDG Translations project. Eg: global_goals.1-title
         goal_translation_key = 'global_goals.' + goal_number
@@ -253,8 +272,10 @@ module JekyllOpenSdgPlugins
             end
           end
 
+          is_standalone = meta.has_key?('standalone') and meta['standalone']
+
           # Set the goal for this language, once only.
-          if already_added[language].index(goal_number) == nil
+          if !is_standalone && already_added[language].index(goal_number) == nil
             already_added[language].push(goal_number)
             available_goal = {
               'number' => goal_number,
@@ -269,7 +290,7 @@ module JekyllOpenSdgPlugins
             available_goals[language].push(available_goal)
           end
           # Set the target for this language, once only.
-          if already_added[language].index(target_number) == nil
+          if !is_standalone && already_added[language].index(target_number) == nil
             already_added[language].push(target_number)
             available_target = {
               'number' => target_number,
@@ -293,12 +314,21 @@ module JekyllOpenSdgPlugins
           else
             indicator_name = meta['indicator_name']
           end
+          indicator_path = indicator_number
+          if is_standalone && meta.has_key?('permalink') && meta['permalink'] != ''
+            indicator_path = meta['permalink']
+          end
+          indicator_sort = get_sort_order(indicator_number)
+          if meta.has_key?('sort') && meta['sort'] != ''
+            # Allow metadata 'sort' field to override the default sort.
+            indicator_sort = meta['sort']
+          end
           available_indicator = {
             'number' => indicator_number,
             'slug' => indicator_number.gsub('.', '-'),
             'name' => opensdg_translate_key(indicator_name, translations, language),
-            'url' => get_url(baseurl, language, indicator_number, languages, languages_public),
-            'sort' => get_sort_order(indicator_number),
+            'url' => get_url(baseurl, language, indicator_path, languages, languages_public),
+            'sort' => indicator_sort,
             'goal_number' => goal_number,
             'target_number' => target_number,
             'global' => global_indicator,
@@ -374,7 +404,11 @@ module JekyllOpenSdgPlugins
             target_number = get_target_number(indicator_number)
             doc.data['goal'] = available_goals[language].find {|x| x['number'] == goal_number}
             doc.data['target'] = available_targets[language].find {|x| x['number'] == target_number}
-            doc.data['indicator'] = available_indicators[language].find {|x| x['number'] == indicator_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)
+
           elsif collection == 'goals'
             # For goals we also set the current goal.
             if doc.data.has_key? 'goal_number'
@@ -389,7 +423,10 @@ module JekyllOpenSdgPlugins
             if goal_number.is_a? Numeric
               goal_number = goal_number.to_s
             end
-            doc.data['goal'] = available_goals[language].find {|x| x['number'] == goal_number}
+            goal_index = available_goals[language].find_index {|x| x['number'] == goal_number}
+            doc.data['goal'] = available_goals[language][goal_index]
+            doc.data['next'] = get_next_item(available_goals[language], goal_index)
+            doc.data['previous'] = get_previous_item(available_goals[language], goal_index)
           end
         end
       end

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

@@ -1,3 +1,3 @@
 module JekyllOpenSdgPlugins
-  VERSION = "1.2.0".freeze
+  VERSION = "1.3.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.2.0
+  version: 1.3.0.pre.beta1
 platform: ruby
 authors:
 - Brock Fanning
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -100,9 +100,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: