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

Editorial: Remove parenthesis from headings #1108

Closed
LJWatson opened this issue Oct 30, 2019 · 5 comments · Fixed by w3c/aria-common#40
Closed

Editorial: Remove parenthesis from headings #1108

LJWatson opened this issue Oct 30, 2019 · 5 comments · Fixed by w3c/aria-common#40
Milestone

Comments

@LJWatson
Copy link
Contributor

A conversation on WebAIM prompted me to look at how easy it is to navigate the ARIA spec and locate content. The robust heading structure and linked table of contents are both really useful, but searching for a particular role, attribute, or property, isn't so easy.

The reason is that the table of contents doesn't drill down to the level of the individual roles and attributes, and the heading text puts the word "role" or "property" or whatever in parenthesis. For example:

note (role)>

When searching for something, it's more likely that someone will type in "Note role", and consequently not be able to find it. Could the parenthesis be removed possibly?

@pkra
Copy link
Member

pkra commented Oct 30, 2019

From the same WebAIM thread (I'm guessing): the "Notes" components have the word "Note" marked up as a heading; this creates a lot of noise when navigating by heading (e.g., there are 74 such Notes in the spec right now).

@jnurthen
Copy link
Member

See related #534

@jnurthen
Copy link
Member

@pkra doesn't sound like it is related to this issue. If you want to log it please do so in a separate issue

@pkra
Copy link
Member

pkra commented Oct 30, 2019

@jnurthen I just added this because the headings was a specific problem Lucy described on the thread. Obviously, Leonie's suggestion is great (and lower hanging fruit).

@LJWatson
Copy link
Contributor Author

LJWatson commented Oct 30, 2019 via email

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 a pull request may close this issue.

3 participants