open-sdg - 2.3.3

Fixes a bug in the data edit form: #2118

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning 9 months ago

open-sdg - 2.3.2

Hotfix release for polyfill.io replacement.

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning 10 months ago

open-sdg - 2.2.1

Hotfix release for polyfill.io replacement.

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning 10 months ago

open-sdg - 2.3.1

Hotfix release for these bugfixes:

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning 10 months ago

open-sdg - 2.3.0

This document is intended for developers, to help with the process of upgrading to version 2.3.0 of Open SDG, from 2.2.0 or higher.

Upgrade data repository to sdg-build 2.3.0

In your data repository, update your requirements.txt file to:

git+https://github.com/open-sdg/[email protected]

Upgrade translations to sdg-translations 2.3.0

In your data repository's config file, update the version of sdg-translations in the "translations" section:

translations:
  - class: TranslationInputSdgTranslations
    source: https://github.com/open-sdg/sdg-translations.git
    tag: 2.3.0

Update version of Open SDG to 2.3.0

In your site repository's _config.yml file, update the version of Open SDG in remote_theme, like so:

remote_theme: open-sdg/[email protected]

Update version of jekyll-open-sdg-plugins to 2.3.0

In your site repository's Gemfile, update the version of jekyll-open-sdg-plugins like so:

gem "jekyll-open-sdg-plugins", "2.3.0"

Updating overridden files

If you are overriding certain files, you may need to adjust your version in order to benefit from the latest features, bugfixes, and design changes. If you are unsure, check the _includes and _layouts folders in your site repository. If they contain any of the following files, you may want to incorporate the latest changes into your overrides. The links below will show you the latest changes for each file.

Note that we strive to avoid any breaking changes, so this process of updating overridden files is optional. However we strongly recommend keeping your overridden files as current as possible.

New features

This release introduces some optional features that you may be interested in adding to your platform.

Indicator iframes

This feature allows you to create iframe-friendly versions of each indicator. An iframe is an HTML element that loads another HTML page within the same page. It essentially puts another webpage within the parent page.

The URLs of the iframe-friendly versions will be the same link but with "-iframe" at the end e.g. "/1-1-1" & "/1-1-1-iframe". An example of how to embed this into a new page is shown below:

---
title: My page
permalink: /my-page/
layout: page
---
Indicator 1.1.1 should be embedded below:

<script type="text/javascript" src="https://pym.nprapps.org/pym.v1.min.js"></script>
<div id="my-iframe-container"></div>
<script>
    var pymParent = new pym.Parent('my-iframe-container', '{{ site.baseurl }}/1-1-1-iframe', {});
</script>

It is also possible to do an iframe directly, however you would lose out on the benefit of the Pym.js library, which is supposed to prevent vertical scrollbars. If you wanted to do this, it would be something like this:

---
title: My page
permalink: /my-page/
layout: page
---
Indicator 1.1.1 should be embedded below:

<iframe src="{{ site.baseurl }}/1-1-1-iframe"></iframe>

observation_attributes

Open SDG now has the functionality to display observation attributes for indicator data in charts, tables and maps. This setting controls the data columns that should be considered "observation attributes", as well as the labels that should be used for these columns when displaying their values in the footer beneath charts and tables.

There are two steps to displaying observation attributes in your data:

Add the relevant information into your data - this is achieved by adding a COMMENT_OBS column to the indicator data file which is filled in with wording (e.g. Estimated value, Forecast value etc.) for those lines of data that are observation attributes.
Include the observation_attribute setting in your site configuration - add the following lines to the site_config.yml in the site repository:

observation_attributes: 
  - field: COMMENT_OBS 
    label: ''

The default is to display ‘note 1(2,3 etc.)’ after each data point in the tooltips of the chart, table and graph, that is an observation attribute. The number of the note corresponds to a type of observation attribute entered into the COMMENT_OBS column as outlined below:

[note 1] Estimated value 
[note 2] Forecast value 
[note 3] Unvalidated value 
[note 4] Low reliability 
[note 5] Experimental value 
[note 6] Imputed value

You can change the label in the setting to say something other than the default ‘note’ as desired too.

Reporting status page - Option to remove "out of scope" disaggregations

Open SDG users will now have the option to show or remove the "Out of Scope" tag on their Reporting Status page in the Disaggregation status. This can now be used to only show indicators where a disaggregation is explicitly mentioned in the indicator title. This will hide the out of scope indicators from the bar on the screen. This should hopefully better represent how many indicators are disaggregated.

To omit "out of scope" from the disaggregation status page, in the data config file, set ignore_out_of_scope_disaggregation_stats to true.

ignore_out_of_scope_disaggregation_stats: true

To change the label of the totals in the disaggregation status page, in the site configuration file (eg, _data/site_config.yml), in the reporting_status section add a disaggregation_indicator_count_label to the reporting_status section. The default is "indicators", so for example you might want to use "indicators in scope".

reporting_status:
    disaggregation_indicator_count_label: indicators in scope

use_new_config_forms

New and improved site configuration forms have been developed to make changes to your site as user friendly as possible. The original forms are still available if you do not change the setting as indicated below and you still access the forms in the same way.

As usual, there are two ways of updating to your site_config.yml file in order to make configuration changes to your site:

You can edit the _data/site_config.yml file directly, or
You can use the site configuration forms via your staging site.

You can use either method at any time for any change.

To turn on the new site configuration forms:

Go to the site_config.yml file in the _data folder in your site repository.
Include this line:

use_new_config_forms: true

You can then access the site configuration forms by going to your staging site and in the footer menu at the bottom of any page, click "Configuration".

From here you can navigate around the forms depending on what setting you would like to change. Every setting has its own section which may consist of checkboxes, text boxes, drop-downs, toggles and list items. You can interact with each of them to update any settings from the default. There is more information provided to give context and guidance for each setting which can be accessed by clicking on the drop-down at the bottom of each setting.

See the site configuration forms guidance page for more information.

Ruby 3

The Open SDG platform now supports Ruby 3, and if you would like to upgrade here are the instructions. Note that this is not required, but if you would like to be on the latest version then it is now possible. To upgrade to Ruby 3, you will need to make changes in your site repository:

Changes to your "Gemfile"
Changes to the "workflows" in the .github folder

Here is an illustration of the specific changes needed: https://github.com/open-sdg/open-sdg-site-starter/pull/98/files

Bug-fixes and improvements

Fixed an issue where maps were not displaying for some indicators
Fixed an issue where some series were not appearing
Country name now translated in table header
Header columns now pinned in tables
Added units and series columns to data download files
Improvements to checkbox selection on indicator pages
data_start_values on maps: geographical fields now ignored
Graph annotation label position functionality improved
Improvements to screenreader and voice control functionality
Allowed DataSchemaInputSdmxDsd as a data schema

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning about 1 year ago

open-sdg - 2.2.0

This document is intended for developers, to help with the process of upgrading to version 2.2.0 of Open SDG, from 2.1.0 or higher.

Upgrade data repository to sdg-build 2.2.0

In your data repository, update your requirements.txt file to:

git+https://github.com/open-sdg/[email protected]

Upgrade translations to sdg-translations 2.2.0

In your data repository's config file, update the version of sdg-translations in the "translations" section:

translations:
  - class: TranslationInputSdgTranslations
    source: https://github.com/open-sdg/sdg-translations.git
    tag: 2.2.0

Update version of Open SDG to 2.2.0

In your site repository's _config.yml file, update the version of Open SDG in remote_theme, like so:

remote_theme: open-sdg/[email protected]

Update version of jekyll-open-sdg-plugins to 2.2.0

In your site repository's Gemfile, update the version of jekyll-open-sdg-plugins like so:

gem "jekyll-open-sdg-plugins", "2.2.0"

Updating overridden files

If you are overriding certain files, you may need to adjust your version in order to benefit from the latest features, bugfixes, and design changes. If you are unsure, check the _includes and _layouts folders in your site repository. If they contain any of the following files, you may want to incorporate the latest changes into your overrides. The links below will show you the latest changes for each file.

Note that we strive to avoid any breaking changes, so this process of updating overridden files is optional. However we strongly recommend keeping your overridden files as current as possible.

New features

This release introduces some optional features that you may be interested in adding to your platform.

Proxy

Open SDG now has the functionality to mark indicator data as “proxy” data with a label and definition, meaning that it is somehow different than the expected UN global indicator.

To set an entire indicator to be a "proxy", this line is needed in each indicator configuration file in the metadata section on indicator pages:

proxy: proxy

If your data has multiple series and not all of them are proxies, this is needed instead, to define which series are proxies (for example):

proxy: both
proxy_series:
  - my first proxy series
  - my other proxy series

To change the text that appears for the proxy description as default, add this to the site_config.yml file in your site repository to customise the description text. Note: you will need to update the translation for this if you use any other languages on the site.

proxy_indicators:
  label: Proxy
  description: My alternate proxy description

Change log

Bugfix: Fix reference to map timedimension nezasa dependency #1962
Design: SDG image on reporting status overall row #1960
Bugfix: Fix for "Edit data" indicator form #1945
Feature: Proxy indicators feature #1944
Feature: Year range per disaggregation #1930
Bugfix: Use data_start_values for maps #1929
Feature: More details on custom map colors and support for functions #1924
Feature: Double-size chart image downloads #1898
Feature: Meta tag functionality #1892
Feature: Custom headings and subheadings for goal pages #1891
Bugfix: Use reporting status label in site configuration #1867

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning about 2 years ago

open-sdg - 2.1.1

This is a hotfix release to fix the map functionality.

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning about 2 years ago

open-sdg - 2.0.1

This is a hotfix release to fix the map functionality.

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning about 2 years ago

open-sdg - 2.1.0

Bugfix: Map search role removal #1857
Feature: Use new site config/default for empty metadata placeholder for sources #1856
Design: Focus styling for goal icon in indicator banner #1855
Design: Max width for map disaggregation on desktop #1854
Bugfix: Search suggestion stem fix #1853
Bugfix: Contrast fixes for data/config forms #1844
Design: Focus outline fix for goal icons on the reporting status page #1842
Feature: Use more fuzzy searching for maps #1839
Bugfix: Map disaggregation: name the function and the flag differently #1837
Feature: Pass a second parameter to dataRounding which includes indicator id #1831
Design: More margin above H2 when it is in content of 'page' and 'post' layouts #1819
Bugfix: Use raw value for chart tooltip #1813
Design: Remove play button from maps #1812
Design: Horizontal rule thickness fix on goal pages #1809
Feature: Year-slider starts with the most recent year #1808, #1830
Feature: Support for goal_content_heading site config #1803
Design: UX improvements for config and data form headers #1802
Design: Updates to the indicator progress on goal pages #1801
Design: Clarify button labels #1799
Security: Lodash and jQuery upgrades #1798
Design: Double focus outline (black in addition to yellow) #1797
Bugfix: Better pruning of map disaggregations to hide region columns #1795
Feature: Support local hrefs in metadata links #1794
Feature: Translations in leafletDisaggregationControls #1791
Bugfix: Remove extraneous markup #1784
Bugfix: Fix for metadata content overflow on high magnification #1777
Feature: Related indicators, publications, and sources #1776
Feature: Placeholder for empty metadata #1775
Design: Update data download card to use new translations #1774
Bugfix: Maintain focus when changing series #1765
Bugfix: Refresh keyboard navigation plugin on chart update #1762
Feature: Wrap Y axis labels to 40 characters per line #1739
Bugfix: Map series/unit behaviors #1724
Bugfix: High contrast cookie modal #1719

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning over 2 years ago

open-sdg - 2.0.0

Overview: https://open-sdg.readthedocs.io/en/latest/updates/#200
Upgrade instructions: https://open-sdg.readthedocs.io/en/latest/upgrades/upgrading-2-0-0/

Bugfix: Fix for rescaler plugin when changing series #1715
Feature: Alert about not supporting Internet Explorer #1710
Bugfix: Translate the chart tooltip labels #1709
Feature: Default to accessible chart colorset #1697
Bugfix: Draw annotations after datasets #1696
Design: Color/markup fixes for tags #1695
Bugfix: Fix aria-controls attributes on reporting status page #1687
Design: Map selection legend revamp moving name to the left #1680
Feature: Breadcrumbs on all pages #1679
Major upgrade: Deprecated code and settings removed - see upgrade instructions for details #1601, #1633, #1646, #1672, #1676
Bugfix: Alter the value for target lines on tables #1675
Bugfix: Allow keyboard access to cookie settings link in footer #1665
Bugfix: Fix closing tag in data footer #1664
Feature: No-javascript tweaks related to headline data #1663
Bugfix: Various chart-related fixes #1662
Bugfix: Style fixes for data edit form #1661
Bugfix: Pin to 2.6.1 of json-editor #1660
Feature: For no-js: hide hamburger toggle, expand hamburger menu, hide drop-downs #1655
Bugfix: Handle null values in current series/unit for footer fields #1652
Feature: Map disaggregation #1649 #1699 #1705 #1714
Design: Explicitly turn off text indent on paragraphs #1643
Design: Fix for alignment of search button on search page #1642
Design: Remove top padding on main-content #1640
Design: Move table column arrows to right #1639
Design: Do not float icon on goal page on mobile #1638
Design: Less space above frontpage card sections #1637
Design: Larger font size for main nav #1636
Feature: Back-to-top cleanup and added to goals/indicators/status pages #1635
Feature: Hide search and contrast, and switch to language-toggle links, when no javascript #1618
Bugfix: Do not change map title when series changes #1606
Feature: Support for site config and translation keys inside content/translations #1605 #1703
Bugfix: Fix breadcrumb markup in bootstrap 5 posts #1589

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning almost 3 years ago

open-sdg - 1.8.1

This hotfix release resolves an issue with the configuration forms (site configuration, indicator configuration, and indicator metadata) that was preventing the output from being downloaded. (#1658)

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning almost 3 years ago

open-sdg - 1.8.0

Bugfix: Better catching of invalid map values #1588
Feature: Dispaly time-series attributes in footer #1569
Feature: Include file for custom disclaimer content #1568
Feature: Include file for custom footer content #1563
Design: Styles updates for data notices #1561
Feature: Dynamic unit of measurement in data footer #1560
Feature: Support for Bootstrap 5 #1558, #1575, #1577, #1581, #1582, #1584
Feature: Indicator config 'graph_types' for dynamic chart type per unit/series #1548
Feature: Support for Chart.js 3 #1548, #1564, #1565, #1567
Maintenance: Docker config for VS Code #1525
Bugfix: Page-not-found fix and high-contrast version of color wheel #1522
Feature: Change more font-sizes to use variables #1496
Bugfix: Remove graph limits if there should be none #1485
Feature: Indicator config 'footer_fields' for dynamic footer fields per unit/series #1484
Bugfix: Handle case where starting value does not exist in selected series #1479

Sustainable Development - Sustainable Development Goals - JavaScript
Published by brockfanning about 3 years ago