Skip to content

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

Open
@katiejliu

Description

@katiejliu

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

Activity

welcome

welcome commented on Apr 12, 2024

@welcome

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.

added
Area:AccessibilityCategory for accessibility related features and bugs
Good First IssueA beginner-friendly issue, great for first-time contributors
on Apr 12, 2024
KatieLuo

KatieLuo commented on Apr 12, 2024

@KatieLuo

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

removed
Good First IssueA beginner-friendly issue, great for first-time contributors
on Apr 12, 2024
nickmcintyre

nickmcintyre commented on Apr 17, 2024

@nickmcintyre
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

raclim commented on Apr 17, 2024

@raclim
Collaborator

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

nickmcintyre commented on Apr 19, 2024

@nickmcintyre
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?

SushantBansal-tech

SushantBansal-tech commented on Mar 6, 2025

@SushantBansal-tech

@raclim Can I Work on this issue

linked a pull request that will close this issue on Mar 9, 2025
added a commit that references this issue on May 12, 2025
added
Ready for WorkIssue is ready for development work
and removed
Needs DiscussionRequires further conversation or consensus
on May 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Area:AccessibilityCategory for accessibility related features and bugsFeature RequestProposal for adding a new functionalityReady for WorkIssue is ready for development work

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      Participants

      @nickmcintyre@KatieLuo@raclim@katiejliu@SushantBansal-tech

      Issue actions

        Adding describe() as default function to increase accessibility · Issue #3081 · processing/p5.js-web-editor