Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update fallbacks for display.name and friends #3017

Closed
larsyencken opened this issue Dec 7, 2023 · 1 comment · Fixed by #3016
Closed

Update fallbacks for display.name and friends #3017

larsyencken opened this issue Dec 7, 2023 · 1 comment · Fixed by #3016

Comments

@larsyencken
Copy link
Contributor

larsyencken commented Dec 7, 2023

Problem

There has been confusion as to what the display.name field should be used for and what title_public should be used for.

This led to substantial discussion and a few options being floated here.

Change to fallbacks

The option we picked means the following changes:

About this data

  • From: [display.name > title] - [description_short]
  • To: [title_public > grapher_config.title > display.name > title] - [title_variant] - [attribution_short] - [description_short]

Table tab

  • From: [display.name > title]
  • To: [title_public > display.name > title] - [title_variant] - [attribution_short]

Heading of a 1-indicator chart

  • From: [grapher_config.title > display.name > title] - [grapher_config.subtitle > description_short]
  • To: [grapher_config.title > title_public > display.name > title] - [grapher_config.subtitle > description_short]

NOTE: Here we reverse the hierarchy of grapher_config.title and title_public. This can be confusing, but this way we don't need to define both title_public and grapher_config.title for indicators with long names. And it also lets us have a data page with a title different from the chart title.

Legend in a chart

  • From: [display.name > title]
  • To: [display.name > title_public > title]

No change

Admin page:

  • No change: [title]

Data page title

  • No change: [title_public > grapher_config.title > display.name > title] - [attribution_short] - [title_variant]

Theoretically in future

Search result

  • From: [title_public > grapher_config.title > display.name > title] - [title_variant]
  • To: [title_public > grapher_config.title > display.name > title] - [title_variant] - [attribution_short] - [description_short]
@larsyencken
Copy link
Contributor Author

@danyx23 Could you give this a quick eyes over to confirm this is alternative 3 as you understood it? If there's anything that needs editing, please just edit inline above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants