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

Improve copy for managing a block's style variations #48050

Closed
richtabor opened this issue Feb 13, 2023 · 10 comments · Fixed by #48367
Closed

Improve copy for managing a block's style variations #48050

richtabor opened this issue Feb 13, 2023 · 10 comments · Fixed by #48367
Assignees
Labels
Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json Needs Copy Review Needs review of user-facing copy (language, phrasing) [Type] Copy Issues or PRs that need copy editing assistance

Comments

@richtabor
Copy link
Member

What problem does this address?

The copy in question is: "Manage style variations, saved block appearence presets."

There's a typo (appearence should be appearance), and grammar — but I think we can do better all around. It's not clear where "block appearance presets" came from, but it seems like a fancier way to say "style variations".

This copy is essentially help text for a control that is available within Global Styles — for blocks that have style variations (such as the core/button block). You click the style variation below it to personalize a variation.

Perhaps something like this could work (where "Button" is the block's name:

"Customize variations of the Button block."

Visual

CleanShot 2023-02-13 at 16 39 36

@richtabor richtabor added [Type] Copy Issues or PRs that need copy editing assistance Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json labels Feb 13, 2023
@richtabor richtabor moved this to ❓ Triage in WordPress 6.2 Editor Tasks Feb 13, 2023
@tomdevisser
Copy link
Member

+1, although I wonder if an explanation is needed here at all. We're also not adding explanations to all the options above like "Customize the typography of the Button block.", "Customize the colors of the Button block.", etc. At most I would add a link below the button that says "Learn more about style variations" linking to the docs, like the editor does in multiple places.

Screenshot 2023-02-14 at 6 19 47 PM
Screenshot 2023-02-14 at 6 20 19 PM

@annezazu annezazu added the Needs Copy Review Needs review of user-facing copy (language, phrasing) label Feb 16, 2023
@carolynannewells
Copy link

Hello! Carolyn from the Publications team here! We saw that this had a copy review ping.

I would suggest a very simple explanation: "You can customize this block's appearance"

@richtabor
Copy link
Member Author

richtabor commented Feb 17, 2023

We're also not adding explanations to all the options above like "Customize the typography of the Button block.",

We do for the custom CSS entry point below. I do think we could use some descriptive detail, and perhaps we could add a link in the future — when you can create block style variations as well. Right now those docs would be more technical than applicable to editing the style imo.

I would suggest a very simple explanation: "You can customize this block's appearance"

It's not quite the right intent. You can customize the variations of this block, which can be applied when editing. I was thinking something like: Customize variations of the {NAME} block.

@richtabor richtabor moved this from ❓ Triage to 📥 Todo in WordPress 6.2 Editor Tasks Feb 17, 2023
@ndiego
Copy link
Member

ndiego commented Feb 20, 2023

"Customize variations of the Button block."

Sounds good, but I do want to call out the confusion between a "Block Style" and a "Block Variation". This panel description sort of makes it sound like you are customizing a block variant as opposed to a block style.

Perhaps it should be:

Customize style variations of the {NAME} block.

@richtabor
Copy link
Member Author

Sounds good, but I do want to call out the confusion between a "Block Style" and a "Block Variation". This panel description sort of makes it sound like you are customizing a block variant as opposed to a block style.

True, although "block variations" as a term is not surfaced with the UI — more of a technical facet.

@tomdevisser
Copy link
Member

I agree with @ndiego, great addition. I hear you on the term being technical @richtabor, and it's true and should be considered. This however is such a small change that the omitted risk of confusion with devs in my opinion outweighs having a slightly more verbose description.

@richtabor
Copy link
Member Author

This however is such a small change that the omitted risk of confusion with devs in my opinion outweighs having a slightly more verbose description.

Noted. Though I don't think this is dev-centric tooling.

@ndiego
Copy link
Member

ndiego commented Feb 23, 2023

@richtabor I say let's just go ahead with your suggestion Customize variations of the {NAME} block. String freeze is next week and it would be great to get this updated for 6.2.

@ntsekouras
Copy link
Contributor

Customize variations of the {NAME} block.

For the above I think it's better to do Customize variations of the block: {NAME}, due to i12n issues. We have often encountered this problem.

Having said that, this message is in a place where we have already selected a specific block and IMO it's redundant. No strong opinion though..

@tomdevisser tomdevisser self-assigned this Feb 23, 2023
tomdevisser added a commit to tomdevisser/gutenberg that referenced this issue Feb 23, 2023
The copy in question was: "Manage style variations, saved block appearence presets."

There's a typo (appearence should be appearance), and grammar — but I think we can do better all around. It's not clear where "block appearance presets" came from, but it seems like a fancier way to say "style variations".

Together we came to the best copy for this issue, considering accessibility.

I also made the copy translatable.

Props richtabor, ndiego, ntsekouras.
Fixes WordPress#48050.
@tomdevisser
Copy link
Member

Added a PR #48367

@ndiego ndiego moved this from 📥 Todo to 🏗️ In Progress in WordPress 6.2 Editor Tasks Feb 23, 2023
@github-project-automation github-project-automation bot moved this from 🏗️ In Progress to ✅ Done in WordPress 6.2 Editor Tasks Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json Needs Copy Review Needs review of user-facing copy (language, phrasing) [Type] Copy Issues or PRs that need copy editing assistance
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

6 participants