Skip to main content

Writing slider descriptions

Sliders are the visual representation of Inputs in the ETM. Modellers can add a description to sliders. This description becomes visible when users select the information button presented as a question mark next to each slider. For clarity, it is important that all slider descriptions follow the same structure and writing style. The guidelines for writing texts should be followed when writing slider descriptions.

Guidelines​

A good slider description contains the following aspects:

  1. Informs users about the slider functionality
  2. Shortly explains what type of technique is modelled with the slider (use full name to explain abbreviation if necessary, especially if we use the abbreviation in a slider name)
  3. Indicates which other sliders affect the properties of this technology (including links to sliders)
  4. Indicates where users might find more detailed information (links to documentation or Refmanager)

Slider descriptions should explicitly not contain the following:

  • Long explanation on how to set the slider, this should be covered in the documentation
  • Technical and financial properties
  • Region specific information
  • Links to non-ETM websites
  • Scenario-specific information

  1. Purpose (max 20 words)

    Clearly state the slider's purpose in a brief sentence.

  2. Background (50 - 100 words)

    Provide information on why this slider / technology is relevant and how it relates to other sliders (if relevant). Include links to documentation if relevant.

  3. Connections to other sliders (1 sentence and/or bullet list)

    Clearly explain any connections to other sliders within the model, providing links or references.

  4. Connections to charts (1 sentence and/or bullet list)

    Refer to relevant charts or tables, if this is not already depicted as the default chart or table of the specific slide.

Example of a good slider description

This slider adjusts the total installed capacity of Autothermal Reformers (ATR).

ATR is a production method for hydrogen. It is similar to steam methane reforming (SMR) but has a lower efficiency. The advantage of ATR is that this technology has a higher CO2 capture potential due to its simpler production stream which contains a high CO2 concentration.

Go to the Emissions section to set CCS for ATR.

YAML file structure​

The slider descriptions are written in YAML files in which they are connected to their slider key. Specific guidelines and instructions regarding the applied structure in the YAML files and regarding referring to other sections or pages are presented here.

YML syntax​

The slider text is written under description. Note that the preferred syntax to use is |, which indicates that a value could cover multiple lines. The slider text is provided on the next line and indented with two spaces from description. 

description: |
  This slider adjusts the total installed capacity of Authothermal Reformers (ATR).
Avoid outdated syntax

Note that it is possible to come across outdated syntax where "" (inline strings) with \r\m (carriage return and line feed) is applied instead of | syntax. The use of | syntax is preferred due to its better readability. The outdated syntax should therefore be avoided when writing slider texts.

HTML for formatting​

Within the YAML format, HTML is used for formatting text. For example:

  • <br/><br/> to insert a blank line for separating paragraphs
  • <a> tags to insert hyperlinks
  • <sub></sub> for sub scripts

Referring to sections in the ETM​

Refer to other sections within the ETM as follows:

Go to the <a href="/scenario/demand/industry/steel">Industry</a> section to set the production routes for steel production.

Opening charts or tables​

It is possible to add a clickable link to a specific chart that will open that chart. See the example below.

See <a href="#" class="open_chart" data-chart-key="hourly_flexibility_electricity" data-chart-location="side">this</a> chart for more information.

Referring to external pages​

An example to refer to external pages (such as the docs or Refman) is provided below. This setup will open the external page in a new tab. 

Information about the behaviour of electricity storage technologies can be found in the <a href="https://docs.energytransitionmodel.com/main/electricity-storage" target=\"_blank\">documentation</a>.