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

Unify summary paragraphs across all object types #134

Open
mukrop opened this issue Nov 17, 2021 · 2 comments
Open

Unify summary paragraphs across all object types #134

mukrop opened this issue Nov 17, 2021 · 2 comments
Labels
2: medium priority Not essential, but we want to work on it a small bit Work for a single developer under an hour free-to-take Described piece of work you can do

Comments

@mukrop
Copy link
Member

mukrop commented Nov 17, 2021

Currently, the infographics uses caption, explainers have perex and studies have summaary and datasets and surveys have intro. This complicates getting a short summary text for the object.

  • Unify the naming to summary.
  • Adjust calls to previous names (layouts, header's description field, open graph summary tag, summary text in RSS/Atom feed).
  • Adjust all objects in both language repositories.
@mukrop mukrop added free-to-take Described piece of work you can do a small bit Work for a single developer under an hour 2: medium priority Not essential, but we want to work on it labels Nov 17, 2021
@mgrabovsky
Copy link
Member

mgrabovsky commented Nov 19, 2021

I've started working on this.

There doesn't seem to be an unambiguous choice for surveys. Studies and surveys use the intro attribute as a lead (perex in Czech), which is not necessarily the same as a short summary of the content. Moreover, studies use the summary attribute for a sort of "key takeaways" section, so we're going to have to rename it.

Here's a quick overview of the present state in each layout and the proposed changes:

Layout Old New
dataset caption summary
explainer perex summary
infographic caption summary
study caption summary
study intro lead❓
study summary key-takeaways❓
survey caption summary
survey intro lead❓

@mukrop
Copy link
Member Author

mukrop commented Jan 21, 2022

Yes, that makes sense. Do proceed that way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2: medium priority Not essential, but we want to work on it a small bit Work for a single developer under an hour free-to-take Described piece of work you can do
Projects
None yet
Development

No branches or pull requests

2 participants