doc: improve table accessibility #35146
Conversation
|
Review requested:
|
|
Nit: Quick question on this ❓ ,
|
What does "this" refer to? |
The |
I'm not vehemently opposed to including the They add no value to assistive technology in this context. Many authors misunderstand them, thinking for example that you can't or shouldn't include Since they are optional in this situation, I chose to omit them. All that said: If there's a good argument for including them, sure. |
|
(We should also style the tables so that headers are visually differentiated from data, but that's a separate PR.) |
|
The |
|
@Trott, I'm not trying to be a stickler here, but given the name of the PR title and branch, I would hope we do our best here. |
It's a common misconception, but
|
|
Hmm, you might be right, but I distinctly remember listening to a screen reader speak out that it was inside of a table head. Evidence to your point: https://developer.mozilla.org/en-US/docs/Learn/HTML/Tables/Advanced#Tables_for_visually_impaired_users I guess all that would be left to justify them would be if you'd use these tags as CSS selectors for your styling PR. |
Trott
force-pushed
the
accessible-table
branch
from
110357e to
b123e08
Compare
|
Landed in b123e08 |
The compatibility matrix in the N-API doc needs row headers for accessibility purposes. Unfortunately, those aren't possible in markdown without resorting to HTML markup. So this converts the table from markdown to HTML. This is less convenient for documentation authors and for other readers of the raw markdown docs, but I believe accessibility for the viewers of our HTML docs outweighs that concern. PR-URL: nodejs#35146 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Zeyu Yang <[email protected]>
The compatibility matrix in the N-API doc needs row headers for accessibility purposes. Unfortunately, those aren't possible in markdown without resorting to HTML markup. So this converts the table from markdown to HTML. This is less convenient for documentation authors and for other readers of the raw markdown docs, but I believe accessibility for the viewers of our HTML docs outweighs that concern. PR-URL: #35146 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Zeyu Yang <[email protected]>
The compatibility matrix in the N-API doc needs row headers for accessibility purposes. Unfortunately, those aren't possible in markdown without resorting to HTML markup. So this converts the table from markdown to HTML. This is less convenient for documentation authors and for other readers of the raw markdown docs, but I believe accessibility for the viewers of our HTML docs outweighs that concern. PR-URL: nodejs#35146 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Daijiro Wachi <[email protected]> Reviewed-By: Derek Lewis <[email protected]> Reviewed-By: Zeyu Yang <[email protected]>
The compatibility matrix in the N-API doc needs row headers for
accessibility purposes. Unfortunately, those aren't possible in markdown
without resorting to HTML markup. So this converts the table from
markdown to HTML. This is less convenient for documentation authors and
for other readers of the raw markdown docs, but I believe accessibility
for the viewers of our HTML docs outweighs that concern.
Checklist