Skip to content

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

Open
@AmauryCarrade

Description

@AmauryCarrade

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    semver/majorThis is a breaking changestatus/verifiedThis has been checked by a maintainertype/requestThis is great to have

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions