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

Adding describe() as default function to increase accessibility #3081

Open
katiejliu opened this issue Apr 12, 2024 · 5 comments
Open

Adding describe() as default function to increase accessibility #3081

katiejliu opened this issue Apr 12, 2024 · 5 comments
Labels
Area:Accessibility Category for accessibility related features and bugs Feature Request

Comments

@katiejliu
Copy link

Increasing Access

The new describe() function adds alt text to your sketch. https://p5js.org/reference/#/p5/describe

We should encourage users to make their sketches accessible by including the describe function as a default function in the text editor.

Feature request details

Screenshot 2024-04-12 at 12 54 06 PM

Add something similar to lines 4 and 5 to encourage users to make their sketches more accessible

Copy link

welcome bot commented Apr 12, 2024

Welcome! 👋 Thanks for opening your first issue here! And to ensure the community is able to respond to your issue, be sure to follow the issue template if you haven't already.

@raclim raclim added Area:Accessibility Category for accessibility related features and bugs Good First Issue labels Apr 12, 2024
@KatieLuo
Copy link

This would be helpful for screen-readers. Good suggestion!

@nickmcintyre
Copy link
Member

+1 this is a good suggestion! There was some previous discussion in #1954 and I took a crack at an implementation in #1959. I'm curious to hear people's thoughts about the best placeholder/instruction.

On the library side, there's an ongoing discussion about using describe() in all example code. The reference will have 100% coverage when the new p5.js website is launched.

@raclim
Copy link
Collaborator

raclim commented Apr 17, 2024

Thanks for bringing up the earlier issue @nickmcintyre, I had an inkling this might've been brought up earlier!

For the placeholder/instruction, I think @katiejliu's suggestion in the screenshot could be a good start. It could also potentially be condensed to describe("Add a general description to be rendered as alt-text"). Based on this comment, I'm wondering if it's better to wait on implementing this after the new p5.js website is launched?

@nickmcintyre
Copy link
Member

Sure thing, @raclim. Agreed it’d be best to wait for the new website.

Curious to see what form the proposed guidelines take. Not a fully-formed thought, but I wonder if they could be condensed into a short comment above describe() in the default sketch template. If not, maybe a link?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area:Accessibility Category for accessibility related features and bugs Feature Request
Projects
None yet
Development

No branches or pull requests

4 participants