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

Subhead should support multiple use #8140

Closed
chrisvanpatten opened this issue Jul 23, 2018 · 12 comments
Closed

Subhead should support multiple use #8140

chrisvanpatten opened this issue Jul 23, 2018 · 12 comments
Labels
[Feature] Blocks Overall functionality of blocks Needs Design Feedback Needs general design feedback. [Type] Enhancement A suggestion for improvement. [Type] Question Questions about the design or development of the editor.

Comments

@chrisvanpatten
Copy link
Member

Subheads currently have supports.multiple = false but I believe this should be true.

The main use-case would be an article or page with multiple sections, which need a subhead for each section of content.

@chrisvanpatten
Copy link
Member Author

This has a PR now, #8143, for those with labeling powers :)

@Soean
Copy link
Member

Soean commented Jul 23, 2018

No it was added as a single use block under the title #2091

Do we really need this Block? It is a paragraph with a class. I don't think many people, including me, really understand when to use this block.

@chrisvanpatten
Copy link
Member Author

@Soean I know it was made single use when it was originally added, I'm just saying maybe it should be multi-use so it can be used in content with multiple sections.

But in that case I also think removing it and make it a block style on the paragraph block would be fine.

Is that a Needs Design Feedback question?

(Also fwiw I think the idea of the subhead is much more common/understood by folks in journalism/newsrooms.)

@designsimply designsimply added [Type] Enhancement A suggestion for improvement. [Feature] Blocks Overall functionality of blocks [Type] Question Questions about the design or development of the editor. Needs Design Feedback Needs general design feedback. labels Jul 23, 2018
@designsimply
Copy link
Member

Added the Needs Design Feedback label to see about getting an answer to @Soean's question about whether the subheading block is really needed. If it is kept, what is its intended use case and what makes a subheading different than using a smaller heading such as h3, h4, h5, or h6?

@chrisvanpatten
Copy link
Member Author

the subhead (also known as subheader, standfirst, rider, kicker, bankhead) in journalism is an introductory or summary line or brief paragraph, located immediately below the headline, and typographically distinct from the body of the article

via

Whether it should be an h-tag or a paragraph is up to interpretation, although I'm of the opinion that a <p> is more correct, semantically. Headings/h-tags should be used to denote the title of a given section or sub-section, whereas the subhead supports and provides context for a heading. You'd really never have a subhead without a heading.

Another way to think about it: if you were generating a table of contents from H-tags (as we do in the Document Outline popover), you wouldn't want the subheads in there, therefore they are more appropriate as <p> tags.

@chrisvanpatten
Copy link
Member Author

Just for the sake of clarity, here are our options (I think):

  • Keep the subhead block, making it multiple use to support using it when a page has multiple sections
  • Keep the subhead block, but leave it as a single use
  • Remove the subhead block, and add "Subhead" as a Block Style on the Paragraph block
  • Remove the subhead block, without adding it as a Block Style

@karmatosed
Copy link
Member

Let's keep it for now as a single use. I have seen it used by people so for now keeping it makes sense. We can always revisit this decision.

@chrisvanpatten
Copy link
Member Author

@0aveRyan
Copy link
Contributor

0aveRyan commented Aug 21, 2018

It seems really confusing to explain to most users what the display/SEO ramifications are of using a Subheading, it's also very hard to see in the UI that it's only available once (and the plugin above presents a concern).

I like @chrisvanpatten's idea of adding it as a block style, I'd also add two other ideas:

  • Make the Subheading Block a plugin allowed to register it to the core/ block namepsace.
  • Make an Excerpt Block that allowed users to present the_excerpt in-body and bind input value to the sidebar excerpt box.

@mtias
Copy link
Member

mtias commented Aug 24, 2018

I have to say this block doesn't make a lot of sense to me in its current implementation. If it's mean to be a subtitle it should probably also enforce position — first block of the post. If it's more of a general purpose block, marking it as "use once" seems a bit arbitrary.

It seems like a valuable addition if / when the title can be a full block as well, and you use it in conjunction with a featured image block, an excerpt block, etc.

If that is the case, we might be ok just hiding it for now (not removing it, so it doesn't affect those that are already using it).

@0aveRyan
Copy link
Contributor

I'll reiterate I love the idea of this block and appreciate how it can be used (and now the nuance between this and a small Heading)... but with the limitations of the current name and single-use flag I think add much more confusion than value to most users.

@karmatosed
Copy link
Member

Looping back to this as we are considering removing it in #9308. Thanks everyone for working through this and highlighting the confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Blocks Overall functionality of blocks Needs Design Feedback Needs general design feedback. [Type] Enhancement A suggestion for improvement. [Type] Question Questions about the design or development of the editor.
Projects
None yet
Development

No branches or pull requests

6 participants