Open SDG features
Open SDG platforms are very customisable and there are a variety of optional features which can be easily configured.
By default, the site is created in English but this can be changed and multiple languages can be added.
An example of a site just using the English language (default) is the UK site.
An example of a site using multiple languages is the Armenian site.
Google Analytics functionality is built in to Open SDG so it's easy to start monitoring traffic to an Open SDG platform. A number of events can be tracked straight of out the box e.g. data downloads and more custom event tracking can easily be added.
For more information about using Google Analytics with an Open SDG platform, see the Analytics section.
Open SDG platforms have a search function, where users can search for terms to quickly help them find information.
By default, the following fields are searched:
- The title of an indicator, goal, or page i.e. words within an indicator title, short goal title, long goal title or page title e.g. FAQ
- The content of the indicator e.g. on the UK 3.4.2 indicator page the content is the text which starts with "In 2018..." and ends with "Further Quality and Methodology information is available."
- The content of pages such as the About or FAQ page i.e. everything on the page below the title e.g on the UK FAQ page, everything below the title (Frequently Asked Questions (FAQ)) is the page content
- The ID number of an indicator or goal e.g. 3 or 3.1.2
The search functionality also includes fuzzy search meaning the search function will also find pages that are likely to be relevant to a search term even when the term doesn't correspond exactly to the wanted information. For example, pages with searched fields that contain "smoke" or "smoker" may be returned when a user searches for "smoking". However, the project that is used for fuzzy search has implemented the feature for a set of languages, but not all. Currently, Open SDG languages supported include Arabic, English, French, German, Russian and Spanish (see the full list of supported languages). If a language is not supported, the search feature will still work but it will find fewer results as the search query must be exact. For example, "smoking" would not return "smoke".
It is possible to "boost" one or more fields in the search index, so that more relevant fields will appear in search results. See the search_index_boost configuration option for more information and guidance on how to configure this option.
It is also possible to index additional metadata fields, so that more fields are searched e.g. if you wanted the search to return pages where the graph title contains the search term. See the search_index_extra_fields configuration option for how to configure this.
Open SDG supports several types of charts for displaying indicator data:
By default, data uploaded to an Open SDG platform is displayed on a chart and a table. You can configure your platform and data to also display data on a map.
Some examples of data being shown on maps are:
For guidance on how set up your site and data in order to be able to display data on a map (as well as on a chart and table), see the Maps page.
Another way of showing data/information on a indicator page is by embedding content from other websites/applications.
An examples of embedded content as main content is a macro-economic dashboard on the UK's Open SDG platform
Content can also be embedded on a data tab next to the Chart and Table tabs.
Embedded features are configured in the metadata files. See the Metadata format page Embedded feature metadata section for more guidance.
Targets on goal pages¶
By default, targets are not shown on the goal pages. An example of this is the UK Open SDG platform.
However, Open SDG platforms can be configured to show targets on the goal pages. An example of this is Armenia's Open SDG platform
For guidance on how to display targets on your goal pages, see the Customisations page Optional feature: Goal page layouts section.
Reporting status options¶
By default, the reporting status options dispayed are Complete, In progress and Exploring data sources. However, these options can be changed to meet your needs. For example, options can be removed or another option, Not applicable, can be used.
An example of using the default options is Ghana's Reporting status page.
An example of removing one of the options is the UK's Reporting status page.
An example of using the Not applicable option is Rwanda's Reporting status page.
For more detailed information see the Reporting status page.
Display data for national indicators as well as global indicators¶
There are various approaches to publishing national and global indicators:
National indiators are displayed next to global indicators but are tagged as 'national' to distinguish them, for example in Armenia's platform.
Separate pages for national and global indicators within the same site, for example Poland's platform.
Accessibility High Contrast version¶
As well as the default contrast version, Open SDG also offers a high contrast version. By default two menu buttons show, to allow users to choose between the different contrast levels, for example on the US site. Another approach is to use a contrast toggle button, for example on the UK site.
For guidance on how to use the more accessible contrast button, see the Configuration page contrast_type section.
By default, there are four pages which show in the menu bar: Reporting status, About, Guidance and FAQ.
An example of using just the four default menu items is Kyrgyzstan's site
An example of menu items being added is UK's site
Even though only four pages are linked to in the menu by default, there are other pages provided for use (e.g. Contacts, News) as well as the option to easily create your own pages.
For guidance on how to add more pages to the menu, see the Configuration page menu section.
Filter by disaggregation¶
Open SDG platforms allow data to be displayed in a way in which it can be filtered by disaggregation. This allows user to compare different breakdowns for a particular indicator.
An example of providing disaggregation filtering is indicator 5.2.2 on the UK site.
This feature is configured with the data files. For guidance on how to provide disaggregation filtering, see the Data format page.
News, posts, and categories¶
Open SDG includes the ability to post news and updates to your site. In all respects, this functionality matches what is described in this Jekyll documentation.
The site starter includes 2 pages to support this functionality:
- a News page, which lists your posts (see an example and the code)
- a Categories page which lists the "categories" used in your posts (see an example and the code)
Note for multilingual sites: The News and Categories pages mentioned above, as well as any posts you create, will need to be duplicated for each of your languages, and translated individually.