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: Adding alt text to images in scores documentation #754

Open
Steph-Chong opened this issue Nov 24, 2024 · 3 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Steph-Chong
Copy link
Collaborator

Steph-Chong commented Nov 24, 2024

It would be great if alt text could be added to all images (plots, charts etc.) in the scores documentation.

At the moment, I believe all images in the scores documentation are currently from Jupyter Notebook tutorials.

Ideally the Alt Text should work in:

  • Jupyter (JupyterLab/Juptyter Notebook)
  • Tutorials as rendered in Read the Docs
  • Binder

(Note: if I have overlooked any images in the scores documentation that aren't in the tutorials, please post a comment below saying so!)

@tennlee tennlee added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 24, 2024
@cbare
Copy link

cbare commented Nov 25, 2024

I did a bit of research on this.

Matplotlib has issue 24309, open as of this writing, to add alt-text to their docs. As near as I can understand, there's a checklist of items needed to make that possible.

Also, note that images can have a title attribute, which is displayed as a tooltip and an alt attribute used in place of the image for accessibility. See usage info here: https://accessibility.psu.edu/images/imageshtml/

@tennlee
Copy link
Collaborator

tennlee commented Nov 25, 2024

jupyter/nbconvert#1112 may also be relevant

@tennlee
Copy link
Collaborator

tennlee commented Dec 17, 2024

I did a bit of research on this.

Matplotlib has issue 24309, open as of this writing, to add alt-text to their docs. As near as I can understand, there's a checklist of items needed to make that possible.

Also, note that images can have a title attribute, which is displayed as a tooltip and an alt attribute used in place of the image for accessibility. See usage info here: https://accessibility.psu.edu/images/imageshtml/

@cbare thanks very much for those notes. Sorry I took a little time to circle back to this issue. Knowing about the title attribute sounds interesting, I'm sure this will help out with future investigations.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants