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

Use describe() to create accessible canvas descriptions in inline documentation #5139

Closed
4 of 59 tasks
lm-n opened this issue Mar 29, 2021 · 1 comment · Fixed by #5140
Closed
4 of 59 tasks

Use describe() to create accessible canvas descriptions in inline documentation #5139

lm-n opened this issue Mar 29, 2021 · 1 comment · Fixed by #5140

Comments

@lm-n
Copy link
Member

lm-n commented Mar 29, 2021

How would this new feature help increase access to p5.js?

This change from using @alt to using describe() in inline documentation will help model best practices for making p5.js sketches accessible to screen reader users. While @alt creates an extra <span> element after the canvas with the canvas description, describe() follows best accessibility practices (https://developer.mozilla.org/en-US/docs/Web/HTML/Element/canvas) by making the description a fallback text or sub DOM of the <canvas> html element.

Most appropriate sub-area of p5.js?

  • Accessibility (Web Accessibility)
  • Build tools and processes
  • Color
  • Core/Environment/Rendering
  • Data
  • DOM
  • Events
  • Friendly error system
  • Image
  • IO (Input/Output)
  • Localization
  • Math
  • Unit Testing
  • Typography
  • Utilities
  • WebGL
  • Other (specify if possible)

Feature enhancement details:

  • Update EN Contributor Docs
    Update documentation:
  • Color Creating and Reading examples
  • Color Setting examples
  • Shape 2D primitives examples
  • Shape Attributes examples
  • Shape Curves examples
  • Shape Vertex examples
  • Shape 3D primitives examples
  • Shape 3D models examples
  • Constants examples
  • Environment examples
  • Structure examples
  • DOM examples
  • Rendering examples
  • Foundation examples
  • Transform examples
  • Data Local Storage examples
  • Data Dictionary examples
  • Data Array Function examples
  • Data Conversion examples
  • Data String Functions examples
  • Events Acceleration examples
  • Events Keyboard examples
  • Events Mouse examples
  • Events Touch examples
  • Image examples
  • Image Loading and displaying pixels examples
  • IO (Input) examples
  • IO (Output) examples
  • IO Table examples
  • IO Time and Date examples
  • Math Calculation examples
  • Math Vector examples
  • Math Noise examples
  • Math Random examples
  • Math Trigonometry examples
  • Typography Attributes examples
  • Typography Loading and Display examples
  • Lights Camera - Interaction examples
  • Lights Camera - Lights examples
  • Lights Camera - Material examples
  • Lights Camera - Camera examples
@lm-n lm-n self-assigned this Mar 29, 2021
Zearin added a commit to Zearin/p5.js that referenced this issue Jan 22, 2022
**Summary:**
- This commit converts all the uses of `@alt` I found in 📁`src/color`.
- Since `@alt` was not linted for line length while `describe(…)` is, I had to add line breaks to the descriptions for the lint to pass (and allow the commit to go through).

**Related Issues & Pull Requests:**

- This is a small piece of the checklist described in Issue processing#5139 (by @lm-n).
- That issue, in turn, was begun in Pull Request processing#5140 (also by @lm-n).
- In Issue processing#5427, the idea requiring this for the inline docs got positive support from several members (including @lmccart, @outofambit, and @catarak).
@lm-n lm-n reopened this Jan 30, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 6, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 6, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 6, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 6, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 6, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 7, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 7, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Feb 7, 2022
@Qianqianye Qianqianye added this to the 1.5.0 milestone Jul 27, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Oct 8, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Oct 8, 2022
Zearin added a commit to Zearin/p5.js that referenced this issue Oct 8, 2022
@Qianqianye Qianqianye modified the milestones: 1.8.0, 1.9.0 Nov 23, 2023
@Qianqianye Qianqianye modified the milestones: 1.9.0, 1.9.1 Dec 1, 2023
@Qianqianye
Copy link
Contributor

Closing this issue since all the reference docs includes describe() now, with all the documentation PRs merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants