Skip to content

Latest commit

 

History

History
85 lines (70 loc) · 3.99 KB

v3.excelInfo.md

File metadata and controls

85 lines (70 loc) · 3.99 KB

Content management with the Excel workbook

Introduction

This Excel workbook is meant for the content administration. Giving the user a partial control over the application. The worksheets are used for the following:

  • the Sankey translations
  • the main modal: description text, image path, metadata and database hyperlinks
  • the tutorial contents

System access

The data is grouped and stored in worksheets. The worksheets name is not important, but the order is important. The worksheet ID is the index of the worksheet in the Excel workbook. The first worksheet has the ID 0, the second worksheet has the ID 1, etc. The worksheet ID is used in the script as a variable name. The user must assure that the worksheets order is never altered. The data is linked to the worksheets in the following order:

  1. modal (id 0)
  2. indicators (id 1)
  3. metadata (id 2)
  4. datasets (id 3)
  5. tutorial (id 4)

Worksheets structure

The first row is always the header row, containing keys to access the data.

  • the user must assure that the header row is never altered

The second row can be used as the optional info about the data.

  • the sub-header row is purely informative and is not used in the script
  • NB! Do not insert the sub-header row for the tutorial worksheet.

The data rows are used to store the data.

  • the user can alter the data rows as needed (except the first column)

The first column is always the "primary key".

  • The primary key is used in the script as a variable name. The user must assure that the primary key is never altered, missing and stays unique.

The user can rearrange the rows as needed, but the first row must always be the header row.

The user can rearrange the columns as needed, but the first column must always be the primary key.

Content of worksheets

modal (id 0)

The modal worksheet is used to store the information for the main modal box (node and flow modals). Giving control over the images and tabs: description, metadata, data source. Columns description:

  • CODE: is the primary key, used to identify one of the following:
    • the material flow
    • the Sankey diagram node
    • the Sankey diagram flow
  • EN, DE, FR (language code): is the HTML contents to be used in the description tab
  • PICTURE: is the name of the image to be used in the main modal box
    • the name must be without the file extension (The file extension is added in the script.)
    • the name must not include space or special characters
  • CREDIT: is the credit text to be used under the image

indicators (id 1)

This worksheet is used to store the labels for the indicators. Giving control over the labels. Usage:

  • all charts (timeline, pie, bar): indicator labels in the legend and the tooltip

Columns description:

  • CODE: is the primary key used to identify the indicator
  • EN, DE, FR (language code): is the HTML of the label

metadata (id 2) & datasets (id 3)

These sheets are used to store the links to the metadata and datasets page. These links are used in the main modal box, metadata and dataset tabs. Columns description:

  • CODE: is the primary key
  • href: is the used hyperlink
  • EN, DE, FR (language code): is the link title for accessibility

tutorial (id 4)

The tutorial worksheet is used to compose the tutorial cards. If you add or remove a row, the tutorial card will be added or removed. I.e. the tutorial cards number is coming from the worksheet and order is determined by the row order.

  • NB! Do not insert the sub-header row for the tutorial worksheet.

Columns description:

  • ELEMENT: is the primary key and is used to identify the referring HTML element
  • _title: is the title of the tutorial card
  • _intro: is the HTML contents to be used in the intro tab