Document row level headers #146
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This requires alphagov/tech-docs-gem#214 to be released first - the current version of the tech docs template doesn't support row headers in markdown tables. Alternatively we could document that you need to use HTML tables to set row level headings.
kr8n3r
added a commit
to alphagov/paas-team-manual
that referenced
this pull request
Mar 14, 2021
As per alphagov/tdt-documentation#146 example
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This requires alphagov/tech-docs-gem#214 to be released first - the current version of the tech docs template doesn't support row headers in markdown tables.
Alternatively we could document that you need to use HTML tables to set row level headings.
Context
Sometimes, tables have row-level headings as well as column level headings.
To be accessible, these need to be marked up as
<th>tags. Otherwise users of screen readers and other assistive technology may not be able to work out that they're table headings rather than ordinary table cells.This came up in a recent accessibility report.
Changes proposed in this pull request
Document how to use row level headers in markdown tables (alphagov/tech-docs-gem#214 needs to be released first).
Guidance to review