Skip to content
Timo Franz edited this page Aug 23, 2018 · 11 revisions

All application text is part of the application source code. Opposed to the application data that is dynamic content (pulled in at run time), the text is static content (pulled in at compile time) and any changes will only be reflected on the website if the website is rebuilt and re-deployed (see Development for details).

There are 2 principal types of static text:

  1. Formattable text for chart component descriptions and about page
  2. Simple text labels all kept together in a single JSON file

Formattable text

A markdown text file is available for each chart component description (displayed in the sidebar), for the about page content and about page sidebar content, stored in folder /src/text:

  • focus-areas.md: focus areas component description
  • insights.md: key insights component description
  • data-assets.md: data assets component description
  • data-servcies.md: data services component description
  • about.md: about page content. Please note: for alignment with the sidebar content it is recommended to start with an "h3" heading (markdown: ### Title)
  • about-aside.md: about page sidebar content

These pages support markdown which means that basic formatting options and links are supported. Common formatting options are

Simple labels

All basic labels are stored in a single JSON file: labels.json

The JSON file contains one key-value pair for each label in the form of "label.key": "The label text". Please note when editing: each line except for the last label must be terminated by a comma (,) - you may also use an online JSON validator (eg https://jsonlint.com) to validate the JSON file.

Here is an overview of all application labels

Label key Description
app.title the application title used as 'alt' image tag and link text for header logo
app.loading the loading text
app.sorry title message (shown with loadErrors)
app.loadErrors message when one or more loading errors occured
button.readMore the button label for the 'show more' button used only on small screens to show hidden page descriptions
answers.not_stated default value for survey question answer 'Not stated' that is also automatically inferred when given given answers not add up to 100% (within tolerance)
labelNotFound fallback label text should the application reference a label that is not defined here (eg when a line in labels.json file is accidentally deleted)
component.about.nav the about page link label in header navigation
component.about.title the about page title displayed in sidebar and page meta title
component.about.metaDescription about page meta description
component.about.longTitle about paged principal title on top of page
component.focus-areas.nav the focus areas page link label in header navigation
component.focus-areas.title the focus areas page title displayed in sidebar and page meta title
component.focus-areas.focus-area label for a single focus area
component.focus-areas.metaDescription focus areas page meta description
component.focus-areas.longTitle focus areas page principal title on top of page
component.focus-areas.selectSubjectLabel label for subject drop down select on focus areas page
component.focus-areas.subjectReference label for the reference subject (when single agency is selected) on focus areas page
component.focus-area.title single focus area page title displayed in sidebar and page meta title
component.focus-area.metaDescription single focus area page meta description
component.focus-area.selectSubjectLabel label for subject drop down select on single focus area page
component.insights.nav the key insights page link label in header navigation
component.insights.title the key insights page title displayed in sidebar and page meta title
component.insights.metaDescription the key insights page meta description
component.insights.longTitle key insights page principal title on top of page
component.insights.selectSurveyLabel label for survey drop down select on key insights page
component.services.nav the data services page link label in header navigation
component.services.title the data services page title displayed in sidebar and page meta title
component.services.metaDescription the data services page meta description
component.services.longTitle data services page principal title on top of page
component.assets.nav the data assets page link label in header navigation
component.assets.title the data assets page title displayed in sidebar and page meta title
component.assets.metaDescription the data assets page meta description
component.assets.longTitle data assets page principal title on top of page
component.notFound.title not found page title
component.notFound.metaDescription not found page meta description
component.notFound.text not found page text
component.surveyInformation.title survey information title as shown in sidebar
component.surveyInformation.current text between agency count and survey year {no} ... {year}
component.surveyInformation.aboutLink.before text before about link in sidebar
component.surveyInformation.aboutLink.after text after about link in sidebar
screenreader.navActive screenreader notification: announcing current page
screenreader.dataRequested screenreader notification: announcing data requested
screenreader.dataLoaded screenreader notification: announcing data loaded
screenreader.dataLoadError screenreader notification: announcing data loading error
screenreader.navigationOccured screenreader notification: announcing page navigation
screenreader.navigationQueryUpdated screenreader notification: announcing other view change, eg selected survey or selected agency
screenreader.skipToContent skip to content button label
screenreader.fsModal.button.dismiss full screen modal dismiss/close button title - on small screens only
screenreader.focus-area.button.dismiss single focus area dismiss/close button title
screenreader.focus-areas.chart-caption focus area chart caption
screenreader.focus-areas.chart-table-caption focus area screenreader table caption (read out for chart)
screenreader.focus-areas.chart-table-reference-hint focus area screenreader table label for reference hint
screenreader.assets.chart-caption data assets chart caption
screenreader.assets.chart-table-caption data assets screenreader table caption (read out for chart)
screenreader.services.chart-caption data services chart caption
screenreader.services.chart-table-caption data services screenreader table caption (read out for chart)
screenreader.insights.focus-area-label alt text label for focus area icon image (on top of insights element)
screenreader.header.homeLink home link label
Clone this wiki locally