-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Add drop cap help text in paragraph block #6415
Add drop cap help text in paragraph block #6415
Conversation
I have help text Drop Cap is not set. / Drop Cap is set. Definitely need help what wording we should use. |
Thanks for jumping onto this one, @samikeijonen! It seems like most useful help text is the one that describes what's happening as a result of the toggle being changed, rather than simply a "set"/"not set" binary. In this case, perhaps something like "The paragraph will display with a drop cap" / "...will not display..."? That's a little verbose, but heading in the right direction. |
Thanks @pento! I updated the help text. |
Thanks, @samikeijonen! Having it longer than a line does make it seem a bit verbose. I've tagged this PR for a copy review, to get some fresh ideas. For reference, here's what it currently looks like: |
Yeah I noticed the same. In other languages (like here in Finnish) it will get even longer. So it's probably going to get in two lines anyways. I can start adding similar help text to other block settings also. |
The docs for the switch were recently updated to suggest the pattern of being able to provide toggled vs. untoggled help text, which is used here, cool. This is especially helpful in cases where both states of the switch can benefit from a contextual description. In the case of the gallery crop, I think that's a decent use: While I do agree that "Drop Cap" needs help text — not everyone knows that term — are we sure that it needs contextual help text for both states? If yes, then I think we should tune the verbiage further, and instead of just "The paragraph will display a drop cap", go into explaining exactly what this means. For example:
If we do want contextual help text, perhaps something in the vein of:
And then:
Here's how the switches w. help text work on Android: https://cloudup.com/cGoqxCgwPjG
This is all to say that the help text for these components can be still more nuanced than just showing on/off state. |
I personally like these:
And then:
|
@jasmussen: Yah, the idea is to add contextual help text that describes the state of the switch, per the discussion here: #2146 (comment) I'm cool with those phrases. 🙂 |
WFM. For other situations, I think we should what we can do with contextual help text to be more than just binary, though. I know WordPress doesn't have a Wi-Fi toggle, but if it did, it could show both "Off" and "Connected to Free Public Wifi" or even connected to "The Promised LAN". The point I'm trying to make is that with the more verbose help text, we can be not only contextual, but go beyond that. There might also be situations where the label is sufficient context for the switch. |
The sum it up, help text should
|
I completely agree that we need to off two levels of explanation here, (1) what a drop cap is and (2) whether you've got them enabled or not. On the "what it is" front, I wonder if we want to explain not just what it is, but why you'd use one -- if you have no idea what a drop cap is to begin with, you also won't know why it's a thing you might want to try. So something like: A "drop cap" makes the first letter of this paragraph larger and bolder, adding elegance/style to your text. Add style to your text by making the first letter of this paragraph larger and bolder -- the large letter is called a "drop cap." A "drop cap" will give this paragraph a larger first letter, adding style and drawing your reader's eye to the text. For the actual toggle, I like @jasmussen's suggestions. |
Let me know if there is something that needs to be done. |
Thanks @pento. I'll start checking other help texts. |
Description
Adds drop cap help text as mentioned in #2146.
How has this been tested?
npm test
without errors.Screenshots
Types of changes
Adds help text under Drop Cap in paragraph
Checklist: