Re: patch: avoid multiple <h1>

[Ingo Schwarze <schwarze@usta.de>]

Hi Lewis,

J. Lewis Muir wrote on Wed, Jul 06, 2022 at 09:40:20AM -0500:

> The MDN page at
> 
>   https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements
> 
> seems to agree with you; in the "Usage notes" section, it says
> 
>   Use only one <h1> per page or view.  It should concisely describe the
>   overall purpose of the content.
> 
> and
> 
>   Using more than one <h1> is allowed by the HTML specification, but is
>   not considered a best practice.  Using only one <h1> is beneficial for
>   screen reader users.
> 
>   The HTML specification includes the concept of an outline formed
>   by the use of <section> elements.  If this were implemented it
>   would enable the use of multiple <h1> elements, giving user
>   agents--including screen readers--a way to understand that an <h1>
>   nested inside a defined section is a subheading.  This functionality
>   has never been implemented; therefore it is important to use your
>   headings to describe the outline of your document.

Thank you for that additional pointer, it's quite interesting and led me
to a few facts i did not yet know.

The most important takeaway probably is that what i committed is very
likely reasonable, as also confirmed by Anna.

One thing i didn't understand before following your pointer is that
wrapping <h1> inside nested <section> elements is particularly bad
because browsers do not support it.  What mandoc -T html did before
my commit wasn't quite as bad as that because at least all the <h1>
elements were on the same outline level, and all the headings on the
lower level used <h2>.

Yours,
  Ingo
--
 To unsubscribe send an email to tech+unsubscribe@mandoc.bsd.lv