Mermaid image accessible descriptions
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- html, xml
- Domain
- accessibility
Research direction
Start with the <description> and <shortdescription> handling for mermaid diagrams, and with the sample-article that the issue points to. Read the linked Mermaid accessibility docs to see how title and description are embedded in the SVG. The issue has no decision yet, so a newcomer should first propose which of the three approaches to take; done means a chosen approach, demonstrated on the sample article.
Written by the indexing model from the issue text.
Description
Currently, mermaid diagrams just dump <description> or <shortdescription> into the text (see sample-article for examples).
Mermaid has its own way to add accessible title/description that will be embedded into the SVG produced:
https://mermaid.js.org/config/accessibility.html
So one approach would be for the author to add info there. Potentially, that is the most flexible as an author could provide different descriptions for different subdiagrams. But it would leave the info outside of PreTeXt's easy reach.
Alternatively, we could try to inject PTX authored descriptions into the mermaid source (yuck).
Or, we could try to figure out a way to provide an accessible label for the entire image block. i.e.
<image box>
<mermaid pre/>
<description div/>
</image box>
Where the description is visually hidden but set as the @labeled-by for the image box. Not sure if that would work well with screen readers or not. Would need testing.
Loosely related to https://github.com/PreTeXtBook/pretext/pull/2568
- Dominant language
- XSLT
- Stars
- 466
- Forks
- 251
- Avg merge
- 4m
- Merged PRs (30d)
- 13
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from PreTeXtBook/pretext
-
The print preview leaves writing space short by the margins of hidden headers, footers and solutionsOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PreTeXtBook/pretext#3329 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
PreTeXtBook/pretext#3305 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PreTeXtBook/pretext#3297 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
PreTeXtBook/pretext#3285 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PreTeXtBook/pretext#3283 ·
Maintainers usually reply within 1 day
All issues in PreTeXtBook/pretext
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
vigetlabs/wordpress-site-starter#331 ·
Maintainers usually reply within 17 days
-
accessibility area:react bug
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
accessibility good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
styling
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Fchat-Horizon/Horizon#1059 ·
Maintainers usually reply within 2 days
-
accessibility admin ux audit
Difficulty 2/5 Half a day Newbie friendliness 78/100
endora-commerce/endora-commerce#1541 ·
Maintainers usually reply within 1 day