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

move citation out of blockquote per spec #2806

Merged
merged 3 commits into from
Jul 17, 2024
Merged

move citation out of blockquote per spec #2806

merged 3 commits into from
Jul 17, 2024

Conversation

estelle
Copy link
Member

@estelle estelle commented Jul 12, 2024

@estelle estelle requested a review from a team as a code owner July 12, 2024 18:37
@estelle estelle requested review from dipikabh and removed request for a team July 12, 2024 18:37
@Josh-Cena
Copy link
Member

Josh-Cena commented Jul 12, 2024

This significantly changes the layout of the quote and I'm not sure if anyone would be doing this. Usually, when rendering a quote, you would expect the attribution to be styled as if it's part of the quote (gray color, left vertical line, right aligned, etc.), and not as if it's any other paragraph. This was why, before #2562, it was wrapped in another figure, so styles can be applied to the figure. figure/figcaption is also the spec-recommended structure when writing attribution. However based on mdn/content#28401 (comment), it seems this actually degrades screen reader performance? Maybe we should get the spec authors to clarify?

@estelle
Copy link
Member Author

estelle commented Jul 12, 2024

However based on mdn/content#28401 (comment), it seems this actually degrades screen reader performance?

That's why i didn't use figcaption.

changes the layout of the quote

I updated the CSS and HTML to make it look like a blockquote without adding any semantics for a screenreader to find.

@Josh-Cena
Copy link
Member

OK, I'm +1 on the current form, but do we want to clarify in content that although the spec says to use figure, it's actually bad for some screen readers?

@estelle
Copy link
Member Author

estelle commented Jul 13, 2024

OK, I'm +1 on the current form, but do we want to clarify in content that although the spec says to use figure, it's actually bad for some screen readers?

Not in the interactive example, as I assume most people don't actually read the content in the example.

@estelle estelle requested a review from Josh-Cena July 13, 2024 06:31
@Josh-Cena
Copy link
Member

@sideshowbarker Since you approved mdn/content#34813, could you take a quick look at this too? (You are probably also more knowledgeable about HTML than me.)

@sideshowbarker
Copy link
Collaborator

sideshowbarker commented Jul 17, 2024

@sideshowbarker Since you approved mdn/content#34813, could you take a quick look at this too? (You are probably also more knowledgeable about HTML than me.)

Maybe we should get the spec authors to clarify?

  1. Given that at https://html.spec.whatwg.org/multipage/grouping-content.html#the-blockquote-element:the-blockquote-element-4 the spec text itself is unambiguous:

    Attribution for the quotation, if any, must be placed outside the blockquote element.

  2. Over many years of discussions about the spec that I’ve followed (going back 17 years or more), I’ve seen this debated many times — with some people expressing very strong disagreement with it (including some prominent “standardista” influencers) — but the resolution has nevertheless always been to keep that attribution-must-be-placed-outside-the-blockquote requirement in there

…then I’m certain the answer from the spec authors would just be, “That’s what the spec says”. I think they’d probably even not suggest that anyone open a new issue if they disagree — because there have already been issues for it, and they’ve been resolved, and it doesn’t seem like there’s any new information which merits re-visiting those.

So I think as far as MDN goes, we have an obligation to conform to the spec requirements, and I’ll go ahead and merge this.

@sideshowbarker sideshowbarker merged commit ba0fb4b into main Jul 17, 2024
6 checks passed
@sideshowbarker sideshowbarker deleted the bq branch July 17, 2024 02:50
Copy link

Congratulations on your first merged pull request. 🎉 Thank you for your contribution! Did you know we have a project board with high-impact contribution opportunities? We look forward to your next contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example given on blockquote page is incorrect according to the HTML spec
3 participants