Skip to content

Rewrite of the features appendix#808

Open
mattgarrish wants to merge 10 commits intomainfrom
editorial/clarify-feature-find
Open

Rewrite of the features appendix#808
mattgarrish wants to merge 10 commits intomainfrom
editorial/clarify-feature-find

Conversation

@mattgarrish
Copy link
Copy Markdown
Member

@mattgarrish mattgarrish commented Apr 21, 2026

I've gone over the appendix again to try and better clarify that it's not a guide to setting the feature values.

I've relabeled the appendix "Introduction to accessibility features". "Identifying accessibility features" sounds too much like you can use it as a guide to when to set the metadata. I've also gone over all the features and made them more explanatory in nature.

Hopefully, this better separates the body - which is all about how to determine when the metadata applies - from the appendix - which was only meant to show examples of what the features correspond to in the content.

Fixes #807


Preview | Diff

@mattgarrish mattgarrish requested a review from clapierre April 21, 2026 16:18
Comment thread package-metadata-authoring-guide/index.html Outdated
Comment thread package-metadata-authoring-guide/index.html
Comment thread package-metadata-authoring-guide/index.html
every time. It is enabled by having all the headings marked up at their correct level.</p>

<p>HTML provides the <a data-cite="html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements"><code>h1</code> through
<code>h6</code> elements</a> for marking up headings.</p>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

since the number one rule of ARIA is not to use ARIA, I think our 2nd example here should at least be for a heading level not covered by H1-6 so maybe a level="7" ?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

HTML doesn't have seven levels of heading, so there's no guarantee what happens once you create a level beyond 6. ARIA shouldn't be used to create new semantics.

I don't know if it's changed, but Jaws used to treat anything above 6 as an h2.

Anyway, it's not worth getting into these kinds of issues in a metadata guide. Let's leave it as something we know is valid.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Yeah, I guess so, just bugs me that we are showing an example where I would flag this saying it should be done using real HTML established semantics instead of trying to invent your own, but I hear you.

Copy link
Copy Markdown
Member Author

@mattgarrish mattgarrish Apr 22, 2026

Choose a reason for hiding this comment

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

I've changed the example so it doesn't look like an alternative representation of the h2 markup that came before it. The aria attributes wouldn't exist if there weren't cases where they're needed, so we don't need to question the appropriateness of its use in this document. I'm just concerned that if we use something like a level 7 it'll invite issues from people who don't think it's valid or will want to point out that it doesn't work everywhere, which is all off-topic for this guide.

Comment thread package-metadata-authoring-guide/index.html
@clapierre
Copy link
Copy Markdown
Collaborator

Nicely done Matt.

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.

The alternativeText feature

2 participants