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

Add Hide teaser help text in More block #6561

Closed

Conversation

samikeijonen
Copy link
Contributor

@samikeijonen samikeijonen commented May 3, 2018

Description

Adds Hide teaser help text in More block as mentioned in #2146.

How has this been tested?

  • Run npm test without errors.
  • Tested toggling the Hide teaser help in More block.

Types of changes

Adds Hide teaser help text in More block.

Screenshots

Toggle off

hide-teaser-toggle-off

Toggle on

hide-teaser-toggle-on

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.

@samikeijonen samikeijonen requested a review from pento May 3, 2018 13:52
@samikeijonen samikeijonen added [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Type] Copy Issues or PRs that need copy editing assistance Needs Copy Review Needs review of user-facing copy (language, phrasing) labels May 3, 2018
@samikeijonen
Copy link
Contributor Author

Couple of notes.

Label text and help text are now both pretty long. What if we have a short label text. For example Hide the teaser.

I'm not sure where to put getHideTeaserHelp function. I just added that in the last now.

@michelleweber
Copy link

How about "Use the "More" tag" for the main label or "Hide content with the "More" tag" -- there's already a term for it, so using "teaser" adds some confusion, I think -- and then for the status labels, something like:

  • Toggle to display partial post content on the home and index pages
  • Displaying partial post content on the home and index pages

I will think on this some more; I think we can be clearer still.

@samikeijonen
Copy link
Contributor Author

samikeijonen commented May 3, 2018

Agreed that teaser adds some confusion. At least it did for me.

"Use the "More" tag"

This would be little incorrect. The More tag block has already been added. So this setting is only for hiding the content before the more tag.

"Hide content with the "More" tag"

I like this more (heh :)).

@samikeijonen
Copy link
Contributor Author

hide teaser setting: new text is still pretty long

^ With other languages that would probably in two lines. Can we still think something shorter?

@samikeijonen
Copy link
Contributor Author

Oh I forgot to comment on these:

Toggle to display partial post content on the home and index pages
Displaying partial post content on the home and index pages

The "More" block have already been added so those would not be fully true. The setting is only for is the content going to be shown above the "More" tag in single view.

In other words: In home and index pages there is always going to be partial content, which is above the "more" tag.

@michelleweber
Copy link

Okay! Thanks very much for the explanations. So! I don't know that there's much of a way to shorten this without making the labels pretty useless or really rough-sounding; some things just need explanation. Some options...

Hide content before the "More" tag

  • Toggle this on to hide this content on single posts
  • Hiding content before the "More" tag on single posts

Hide intro content

  • Toggle this on to hide the content before the "More" tag on the individual post
  • Hiding content before the "More" tag on the individual post

@samikeijonen
Copy link
Contributor Author

I updated wording a little bit. How does this sound.

Hide intro content

  • Toggle to hide content before the "More" tag on single post.
  • Hiding the content before the "More" tag on single post.

I left Toggle to hide because that would be more inline with other help texts. I left single post because I think it's more common word that individual.

@jasmussen jasmussen requested a review from a team May 4, 2018 09:48
@jasmussen
Copy link
Contributor

This feature is very confusing, and as such the help text is very confusing to author as well.

In general I would suggest, the less text, the better, but if it's hard to understand what this toggle does in the first place, it's definitely in need of good help text.

CC: @karmatosed — with your vast backlog, do you recall what this does? What would a post with a more tag look like in an archive view, if you had this enabled?

@samikeijonen
Copy link
Contributor Author

samikeijonen commented May 4, 2018

What would a post with a more tag look like in an archive view, if you had this enabled?

In archive views it would look the same as you had it disabled. It doesn't affect archive views at all, only single views.

@jasmussen
Copy link
Contributor

The "confused" emoji Github reaction looks disapproving, which I'm not, so instead I'm just going to note that this just makes it even more confusing to me :D

So I hope Tammie or other gutenbergers will chime in and help elaborate.

@samikeijonen
Copy link
Contributor Author

Any tips how to proceed with this? The feature itself is pretty confusing and hard to understand so it needs different label text or label with help text.

@karmatosed
Copy link
Member

Panning out, if it's so confusing should we have it as a feature? I know it's there to add a way to read more of the post, but maybe it just doesn't have optional behaviour? I just feel we're spiralling in complexity here.

@jasmussen
Copy link
Contributor

+1 I'm still not sure what it does. Is there a way we can find out how many people use this?

@samikeijonen
Copy link
Contributor Author

Here are screenshot what the setting mean. The More block have been added between the paragraphs.

Toggle of - single view of post

hide teaser toggle off

Toggle on - single view of post

hide teaser toggle on

Note that the first paragraph is not outputted now. This is what this setting is for.

In archive views this setting doesn't have any effect

Toggle on or off, the end result is the same.

hide teaser toggle archive


I honestly don't know is there similar setting in the current editor. If not, I'd say we can remove this setting.

@samikeijonen
Copy link
Contributor Author

The More block itself should naturally stay.

@jasmussen
Copy link
Contributor

Oh, I see!

So to summarize what's going on: There's a "stream" view (when you view the post on the blog homepage, or in archives), and there's the "full" view (when you're looking at the permalink). The More tag allows you to choose what shows up on the stream view, and what is then shown on the archive view. The additional toggle allows you to hide the text that comes before the More tag, on the archive view.

I feel like the fact that it's so hard to explain and so hard to understand suggests we should remove this feature.

@samikeijonen
Copy link
Contributor Author

The additional toggle allows you to hide the text that comes before the More tag, on the archive view.

On the single view :)

@jasmussen
Copy link
Contributor

On the single view :)

┻━┻ ︵ヽ(`Д´)ノ︵ ┻━┻

Copy link
Member

@tofumatt tofumatt left a comment

Choose a reason for hiding this comment

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

To chime in here: this feature seems very confusing and complex; I think we should just remove it rather than try to clarify it.

@samikeijonen
Copy link
Contributor Author

Is there a PR already to remove this feature?

@melchoyce melchoyce mentioned this pull request Nov 9, 2018
6 tasks
@gziolo
Copy link
Member

gziolo commented Nov 22, 2018

Can we use something like:

Hide the teaser on the single view page.

@afercia
Copy link
Contributor

afercia commented Nov 22, 2018

I'd like to suggest to review the term used here. "Teaser" doesn't make much sense for users and it's also difficult to translate. More details: #8974 (comment)

@youknowriad
Copy link
Contributor

Related #12785

We need a decision on this PR. Remove or update the wording.

@afercia
Copy link
Contributor

afercia commented Dec 28, 2018

See also #8974 (comment)

@afercia
Copy link
Contributor

afercia commented Dec 28, 2018

I'd like to propose something along the lines of the screenshot below:

screenshot 2018-12-28 at 14 44 09

As discussed at length during the implementation of the switch toggle, for better accessibility:

  • an UI control accessible name (the label) should not change dynamically
  • the state should indicated separately: a textual representation of the state is the only guarantee this information can be perceived by everyone

@gziolo
Copy link
Member

gziolo commented Jan 25, 2019

There is also this comment from @afercia #8974 (comment):

The help text has been changed in #11587, but still not so clear:

More
Mark the excerpt of this content.
Content before this block will be
shown in the excerpt on your
archives page.


Hide the teaser before the "More" tag

I'd like to suggest to change it into:

More
Content before this block will be
shown in the excerpt on your
archive pages.


Hide the excerpt on the full content page

I think it makes a lot of sense. Can this PR be updated to reflect this proposal?

@gziolo gziolo self-requested a review January 31, 2019 17:53
@gziolo gziolo changed the base branch from master to update/more-tag-copy February 1, 2019 07:15
@gziolo
Copy link
Member

gziolo commented Feb 1, 2019

I'm merging this PR into my own branch to apply changes.

@gziolo gziolo changed the base branch from update/more-tag-copy to master February 1, 2019 07:32
@gziolo
Copy link
Member

gziolo commented Feb 1, 2019

Moved to #13630 and updated with the recent version of master together with changes applied based on feedback from @afercia.

@gziolo gziolo closed this Feb 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). Needs Copy Review Needs review of user-facing copy (language, phrasing) [Type] Copy Issues or PRs that need copy editing assistance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants