Mermaid image accessible descriptions

Aperta
#2,724 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
html, xml
Ambito
accessibility

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

Lingua principale
XSLT
Stelle
466
Fork
251
Merge medio
4m
PR unite (30g)
13

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di PreTeXtBook/pretext

Tutte le issue di PreTeXtBook/pretext

Issue simili

Altre issue su Accessibility

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.