search

CCALI / a2jauthor

CALI A2JAuthor document automation authoring and viewing platform
https://www.a2jauthor.org
Other
4 stars 1 forks source link

Avoid using header elements to communicate subtitles #231

Closed chasenlehara closed 2 years ago

chasenlehara commented 2 years ago

As a screen reader user, I want subtitles to be marked up correctly, so that they are not added to the list of headings when they are not headers.

Currently, subtitles are h3s under an h2, which is using heading elements for a visual effect.

It doesn’t seem like there is a ton of consensus around how to best communicate subtitles to screen readers. A solution for this will require more investigation.

The current markup may be ok, with the exception of using italic styles vs. <em>. It may be good for us to check the color contrast.

chasenlehara commented 2 years ago

After testing this more, I’m not sure this is an issue we need to address. I think authors may want to take this into consideration, but we don’t necessarily need to change the markup. This is related to https://github.com/CCALI/a2jauthor/issues/230#issuecomment-995432911