Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Accessibility: confusion between caption and alternative text leads to badly accessible images #497

Open
AmauryCarrade opened this issue Nov 11, 2023 · 1 comment
Labels
semver/major This is a breaking change status/verified This has been checked by a maintainer type/request This is great to have

Comments

@AmauryCarrade
Copy link
Member

At the time of writing, when you place an image alone on its paragraph with alt text, such as :

![Image’s alternative text](https://github.com/zestedesavoir/zmarkdown/assets/1417570/700c7266-12f4-4604-8e5e-3cbed4c4e204)

...the image is displayed as a centred figure, with the alternative text displayed below the image as a caption. If you want to display a centred image like this without the so-called "caption", you need to place it in a central block, as follows:

-> ![Image’s alternative text](https://github.com/zestedesavoir/zmarkdown/assets/1417570/700c7266-12f4-4604-8e5e-3cbed4c4e204) <-

This is annoying, and more importantly, it misleads people as to what an alternative text really is. Alternative texts are not captions, they both have a completely different purpose. A text alternative is a precise and concise description of the image, useful for those who can't see it, whereas a caption is a complement to the image, for example by giving a context, adding sources and credits, etc.

This confusion frequently arises when new zmarkdown users ask why rich text cannot be included in the alt text of images: they think that the alt text is a caption. Alternative text is mainly meant to be spoken out loud, written on a Braille display, or read by a robot (search engine, etc.)—writing it as rich text doesn't make sense.

I suggest that:

  • we remove this auto-caption feature from alt text to avoid this confusion (the Figure: attribute can still be used for a real caption);
  • on the user documentation side—but that's not a concern for this repository—we explain the difference.
@StaloneLab
Copy link
Member

I think we already mentioned this subject somewhere; anyway, I agree on the problem: the way we currently handle alternative texts and captions is misleading.
However, before changing this behavior, we need to think about what to do with the LaTeX, because we currently do not render the alternative text in LaTeX anywhere else than in the image caption, as far as I know (when no caption is given, otherwise it is not displayed at all).

Do you have an idea of what would be a good way to integrate this alternative text in LaTeX?
Depending on what is chosen, implementation of ZMarkdown side could be more or less complicated, and we might also decide to update the template.

As a final thought, I shall note that this is a non-backward-compatible change, so might wait a bit before being released, even if changes are ready soon.

@StaloneLab StaloneLab added type/request This is great to have semver/major This is a breaking change status/verified This has been checked by a maintainer labels Nov 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/major This is a breaking change status/verified This has been checked by a maintainer type/request This is great to have
Projects
None yet
Development

No branches or pull requests

2 participants