Adding describe() as default function to increase accessibility

processing / p5.js-web-editor

The p5.js Editor is a website for creating p5.js sketches, with a focus on making coding accessible and inclusive for artists, designers, educators, beginners, and anyone else! You can create, share, or remix p5.js sketches without needing to download or configure anything.

https://editor.p5js.org

GNU Lesser General Public License v2.1

1.41k stars 1.35k forks source link

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

Open katiejliu opened 7 months ago

katiejliu commented 7 months ago

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

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

welcome[bot] commented 7 months ago

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.

KatieLuo commented 7 months ago

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

nickmcintyre commented 7 months ago

+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 commented 7 months ago

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 commented 7 months ago

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?