quarto-dev / quarto-dev/quarto-cli

fig-alt support for diagrams

Open
#9,003 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

accessibility diagrams-mermaid enhancement figures
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

Discussed in https://github.com/quarto-dev/quarto-cli/discussions/9000

Originally posted by felixvuo March 7, 2024

Description

Here's a minimal document with a graphviz dot diagram. The fig-cap seems to work ok, but fig-alt does not give alternative text in the docx or html (and obviously not in pdf).

Is this something that should work? It would be really helpful - part of the motivation behind using quarto is to be able to produce accessible alternative formats for lectures, talks, etc.

---
title: "Minimum Working Example - Alt text"
author: "Me Myself"
format: 
  html:
    minimal: true
  beamer: 
    aspectratio: 169
  docx:
    toc: true
---

# First Things First

Here's a lovely diagram of something.

```{dot}
//| label: fig-tree
//| fig-alt: "A search tree rooted on node G"
//| fig-cap: "A game search tree"

graph G {
    node [label=""];    
    G -- a1;
    G -- a2;
    a1 -- a11;
    a1 -- a12;
    a1 -- a13;
    a2 -- a21;
    a2 -- a22;   
    G [label="G"];
}
```

That's all.
````</div>

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the minimal document and Graphviz diagram in the issue, then inspect its HTML, DOCX, and PDF output to compare how fig-cap and fig-alt are handled. Done means fig-alt produces appropriate alternative text in the supported output formats, including the expected behavior for PDF.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, javascript
Domain
accessibility
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.