matrix-org / matrix-org/matrix-spec

Allow providing a text alternative/caption for all media/non-text-content

Open
#883 1 comment 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

Suggestion

I would like to specify an alternative text for all media content uploaded to Matrix including casual uploads, user avatar and room avatar, and I think this should be supported to comply with WCAG 2.1 non-text content. I think that especially in the context of file uploads during chat (as in not avatar change) there should be an option to always have it visible.

Examples:

  • The Matrix experience naturally improves for an vision impaired user.
  • Terminal user interface applications could possibly show the alt-text where they cannot show an avatar?
  • Matrix Suomi is using the image below as an avatar. Just like I can describe it here on the web, I would like to be able to describe it for users who cannot see the image itself, e.g. "Matrix Finland logo combines the brackets from Matrix logo with the cross as seen in the flag of Finland."
    • Matrix Suomi logo combines the brackets from Matrix logo with the cross as seen in the flag of Finland
  • LGBT* flags are very diverse and I imagine not even all LGBT* people recognize all the flags under the umbrella. When one is used as a room avatar or similar, it could be named and possibly a bit of where it comes from explained. This could also be used for other less known symbols.
  • A furry could explain their fursona in greater detail than may be obvious from the text, especially in case of a less common "species".
  • WCAG 2.1 has additional details for Understanding Success Criterion 1.1.1: Non-text Content
    .

This is similar to matrix-org/matrix-spec#882 (media attribution fields) and I was discussing this with @Sorunome, but she pointed out that attribution is different from text explanation what is in the picture and the user may not understand to put attribution/copyright information to this field.

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 by reading the linked WCAG 2.1 non-text content guidance and the related matrix-org/matrix-spec#882 issue. Determine how alt text would apply to casual uploads, user avatars, and room avatars, including when it should be visible; the work is done when the specification defines an agreed protocol model and behavior for these cases.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.