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

Changes image size description, as it causes confusion #48478

Merged

Conversation

tomdevisser
Copy link
Member

Right now this setting causes confusion as it doesn't change the visual size, but the image dimensions, see #48395 and #48477.

Fixes #48477

Right now this setting causes confusion as it doesn't change the visual size, but the image dimensions, see WordPress#48395.
@tomdevisser tomdevisser self-assigned this Feb 27, 2023
@tomdevisser tomdevisser added [Type] Copy Issues or PRs that need copy editing assistance Needs Copy Review Needs review of user-facing copy (language, phrasing) [Block] Media & Text Affects the Media & Text Block labels Feb 27, 2023
Copy link
Contributor

@aaronrobertshaw aaronrobertshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the proposed improvement @tomdevisser 👍

Apart from the small typo in the suggested copy, I wonder if we could reduce its verbosity a little. At present, it wraps with an orphan and takes up three lines of real estate in the sidebar.

Maybe something like the following could work?

Select image resolution to load. This does not affect visual size.

Before After
Screenshot 2023-02-28 at 10 19 01 am Screenshot 2023-02-28 at 10 18 52 am

It might also be worth getting @WordPress/gutenberg-design to weigh in on its visual impact on the sidebar.

packages/block-library/src/image/image.js Outdated Show resolved Hide resolved
@tomdevisser
Copy link
Member Author

Maybe something like the following could work?

Select image resolution to load. This does not affect visual size.

I agree, changed it!

@jasmussen
Copy link
Contributor

Nice one, and the new description keeps it on two lines.

@richtabor
Copy link
Member

We actually have the same control in the Post Featured Image block as well, with this description:

CleanShot 2023-02-28 at 13 26 03

@richtabor
Copy link
Member

Maybe the label should be "Resolution"? Instead of trying to infer that the control affects the resolution in the description?

@tomdevisser
Copy link
Member Author

Maybe the label should be "Resolution"? Instead of trying to infer that the control affects the resolution in the description?

We talked about this in the issue, but because the function is register_image_size and the Settings screen also shows Image Sizes, I think it makes sense to keep the label as is and change just the description like it is in the latest commit.

@jasmussen
Copy link
Contributor

I do like the idea of revisiting. Resolution does seem like a better word. But we might also land this one in the mean time, and explore in a separate PR whether resolution is appropriate, or whether, to Tom's point, it should remain "Image Size". That would let this move forward, while still capturing the conversation 🤔

@aaronrobertshaw
Copy link
Contributor

But we might also land this one in the mean time, and explore in a separate PR whether resolution is appropriate, or whether, to Tom's point, it should remain "Image Size"

That sounds like a good plan to me.

Before we land this one though I think we need to confirm which phrase is used for the help text, this PR's or the text from the Post Featured Image block as Rich highlighted. Either way it might be good to make them all consistent.

@tomdevisser
Copy link
Member Author

Before we land this one though I think we need to confirm which phrase is used for the help text, this PR's or the text from the Post Featured Image block as Rich highlighted. Either way it might be good to make them all consistent.

In my opinion we should change everything to be consistent with the description we landed on in this PR. It's way more clear to me than the shorter version in the Post Featured Image block. But if the majority thinks otherwise, I could live with both.

What do you think @richtabor @jasmussen @aaronrobertshaw ?

@jasmussen
Copy link
Contributor

I always like short and sweet. The single line Rich suggests sounds good to me.

@aaronrobertshaw
Copy link
Contributor

I always like short and sweet. The single line Rich suggests sounds good to me.

+1 for the Post Featured Image's text.

The reference to the size being for the source image conveys to me this setting doesn't correlate to the visual size.

@hanneslsm
Copy link

If I might chime in, I'd vote for the the version from @tomdevisser or rather 2-line version of @aaronrobertshaw
The issue came up because there "size" just sounds too much like the dimensions or file size. Both might not be the case, since dimensions can be set via the "image settings" above (even though a "small"-"sized"-image is pixelated then) and with good compression the file size also not an argument anymore.

I'd vote for a description that has "resolution" because that's easy to understand for a user.
If changing to Select the size of the source image this PR might make the descriptions consistent (which is good) but does not solve the problem in avoiding confusions.

@tomdevisser
Copy link
Member Author

I'd vote for a description that has "resolution" because that's easy to understand for a user.
If changing to Select the size of the source image this PR might make the descriptions consistent (which is good) but does not solve the problem in avoiding confusions.

I agree with this. :) Especially to non-native English speakers and end-users, resolution is easier to understand and more often used in relation to images than "source".

@tomdevisser
Copy link
Member Author

@aaronrobertshaw Do you need anything else to merge this PR?

Copy link
Contributor

@aaronrobertshaw aaronrobertshaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for keeping this one moving @tomdevisser 👍

Do you need anything else to merge this PR?

My understanding of the plan is to make the smaller change for the moment, in terms of wording, which was for this to match the Post Featured Image block.

We can then continue the discussion regarding "resolution" as we don't have a clear consensus yet.

Either way, the current state of the PR doesn't quite tick the consistency box yet. We need Image, Post Featured Image, and Media and Text blocks to all display the same help text. There's also the Gallery block that exposes an image size control to consider.

@paaljoachim
Copy link
Contributor

paaljoachim commented Mar 13, 2023

I actually had a client tell me how confusing the Image Size drop down was when she used the Media & Text block.
Example.
Default selected size is large. It looks alright in the backend, but previewing the frontend the image is a bit blurred.
I had to tell her that she needs to go into the Media & Text block -> Image Size drop down and select Full Size (I hoped that would help). The result when checking the frontend when Full Size was selected showed a nice sharp image.

My feeling is that Image Size controls should used be removed, as it creates confusion. Changing the wording does not help much. As changing the image size to thumbnail, medium etc the result will likely just be a blurred image and not a visual smaller image. Saying that it changes the resolution, well that does not help as most will have no idea of that that means.

As I see it in general removing the Image Size controls and instead just adding in the Image dimension controls would help.

I made an issue for the Image Setting inside the Media & Text block here:
#49020

@richtabor
Copy link
Member

Either way, the current state of the PR doesn't quite tick the consistency box yet. We need Image, Post Featured Image, and Media and Text blocks to all display the same help text. There's also the Gallery block that exposes an image size control to consider.

Agreed. Let's use the Post Featured Image's help text as the standard across the board. Get those in place, then perhaps follow-up with potentially renaming the labels, as indicated here.

It should read: Select the size of the source image.

@jasmussen
Copy link
Contributor

Agreed with Rich, and to connect the dots that matches the design over here: #48618 (comment)

Copy link
Member

@richtabor richtabor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's change the copy to Select the size of the source image. in both spots. 👍

packages/block-library/src/image/image.js Outdated Show resolved Hide resolved
packages/block-library/src/media-text/edit.js Outdated Show resolved Hide resolved
@richtabor richtabor self-requested a review March 28, 2023 21:06
Copy link
Member

@richtabor richtabor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@richtabor richtabor merged commit ec068b8 into WordPress:trunk Mar 28, 2023
44 checks passed
@github-actions github-actions bot added this to the Gutenberg 15.5 milestone Mar 28, 2023
@tomdevisser tomdevisser deleted the update/mediatext-img-size-description branch March 28, 2023 22:27
@femkreations femkreations added the Needs User Documentation Needs new user documentation label Jun 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Block] Media & Text Affects the Media & Text Block Needs Copy Review Needs review of user-facing copy (language, phrasing) Needs User Documentation Needs new user documentation [Type] Copy Issues or PRs that need copy editing assistance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update "image size" description on the Media & Text block
7 participants