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

Characteristics of Roles section needs tidying up #1263

Open
carmacleod opened this issue May 7, 2020 · 1 comment · May be fixed by #1733
Open

Characteristics of Roles section needs tidying up #1263

carmacleod opened this issue May 7, 2020 · 1 comment · May be fixed by #1733
Assignees
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Projects
Milestone

Comments

@carmacleod
Copy link
Contributor

The Characteristics of Roles section has some inconsistencies that should be fixed up.

Problem 1:

A few (3) of the characteristics definitions have a "Value" type listed:

In 2 of those cases (Abstract and Presentational Children), this looks odd and out of place, and should probably just be deleted ("boolean" can be inferred from reading the prose). However, the list of values for the "Accessible Name Calculation" definition needs to be kept.

Looking back at the same section in ARIA 1.1, it looks like these sections were more formally defined in the past. Informal is fine, but we should make sure they're consistent with each other and with the characteristics tables in the role definitions.

Problem 2:

The names of these definition sections do not always exactly match the name used in the role characteristics tables. For example, Presentational Children is not the same as "Children Presentational".

This is particularly problematic in the case of Accessible Name Calculation which is "Name From" in the tables.

These definition names should all be identical to the characteristics table entries that they are defining.

Problem 3:

Probably because the section for Accessible Name Calculation is poorly named, it seems to have some extraneous subsections that I believe should be deleted. There's no reason to link to the accessible description or text alternative calculation in this (the "Name From" definition) section, so those 2 subsections (5.8.2 and 5.8.3) should be deleted.

Suggestion:

Consider also linking from the characteristics tables to the characteristic definitions. For example, "Supported States and Properties" in each table should link to the Supported States and Properties definition.

@jnurthen jnurthen added the editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo label May 7, 2020
@jnurthen jnurthen added this to the ARIA 1.3 milestone May 7, 2020
@pkra pkra self-assigned this Apr 29, 2022
pkra added a commit to pkra/aria that referenced this issue Apr 29, 2022
@pkra pkra linked a pull request Apr 29, 2022 that will close this issue
@spectranaut spectranaut added this to pkra in ARIA 1.3 Jun 7, 2022
@pkra
Copy link
Member

pkra commented Jun 21, 2022

#1733 addresses most of this except the suggestion:

Consider also linking from the characteristics tables to the characteristic definitions. For example, "Supported States and Properties" in each table should link to the Supported States and Properties definition.

Doing this in the PR would add a lot of noise. Also, we might consider doing this for all characteristics.

pkra added a commit to pkra/aria that referenced this issue Jun 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial a change to an example, note, spelling, grammar, or is related to publishing or the repo
Projects
Development

Successfully merging a pull request may close this issue.

3 participants