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

Merge Accessibility Add-On into p5.js #4703

Merged
merged 74 commits into from
Aug 26, 2020
Merged
Show file tree
Hide file tree
Changes from 71 commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
d46134a
create basic textOutput
Jul 14, 2020
8be1f90
include color_namer from p5.accessibility
Jul 14, 2020
3a379af
reduce color_name
Jul 15, 2020
39ebabc
added description of elements
Jul 17, 2020
e29343c
add square
Jul 18, 2020
1f89f51
add fill, rect, point, line
Jul 18, 2020
29f16d0
add _getLineLenght
Jul 19, 2020
938c0a4
improve text description
Jul 19, 2020
c735879
support triangle
Jul 19, 2020
9d87a30
rename html elements
Jul 19, 2020
bcf5aa6
add html structure and table with element details
Jul 19, 2020
72c8d24
add table output
Jul 20, 2020
3489ea4
add table map
Jul 20, 2020
dc16e54
add comments, move create html to outpus, add links to grid elements.
Jul 20, 2020
9b6fc9b
add links to text output shapes
Jul 20, 2020
89a54a7
remove h1s
Jul 20, 2020
ca2b099
rename table output to grid output
Jul 27, 2020
c833d5e
get centroid of triangle
Jul 27, 2020
5686c54
calculate centroid of quads
Jul 27, 2020
5c91d36
fix grid mapping
Jul 27, 2020
3804540
use plural for shape counters
Jul 27, 2020
2159ac2
fix ingredients and add function description for reference
Jul 28, 2020
b746af8
fix Math and append issues + add docs
Jul 29, 2020
9582177
add comments to functions
Jul 30, 2020
622c8f0
add web accessibility to issue templates
Jul 30, 2020
66da3c6
validate parameters
Jul 30, 2020
ce8570f
comment out comparison of ingredients
Aug 3, 2020
4336fb2
quick fixes
Aug 6, 2020
252503c
update at the end of setup and draw
Aug 6, 2020
7dc0938
make helper functions local
Aug 6, 2020
256933f
use template literals and make functions local
Aug 6, 2020
0245d68
update html only when content is different
Aug 6, 2020
c400ac7
add examples
Aug 6, 2020
0a68f6e
bring back get line length function
Aug 7, 2020
2e9de5d
use dummy dom
Aug 7, 2020
033b1c7
fix use of dummy dom
Aug 10, 2020
ef8df67
use dist()
Aug 10, 2020
31b423f
local functions in color_namer.js
Aug 10, 2020
714b5a0
use fallback and label
Aug 10, 2020
f5a6fcd
fully support instance mode
Aug 11, 2020
c7dca37
tests prototype
Aug 12, 2020
387de01
add dummy and ingredients to instance
Aug 12, 2020
843511f
combine createOutputl and createLabel function
Aug 12, 2020
3d824f5
combine _createTextOutput() and _createGridOutput() with _createOutput()
Aug 12, 2020
7a0243b
merge update output functions
Aug 12, 2020
10a0e80
add unit tests
Aug 12, 2020
ae4cb09
fixes typos
Aug 12, 2020
3b872f8
Update spec.js
lm-n Aug 17, 2020
6bf2972
Merge pull request #1 from processing/main
lm-n Aug 17, 2020
2fd9744
use this.dummyDOM in describe() and fix tests
Aug 17, 2020
f605391
integrate describe functions and output functions
Aug 17, 2020
a8d69df
fixes errors in describe and describe Element
Aug 17, 2020
f8f074f
added comments
Aug 17, 2020
ba951e8
modify readme and document accessibility in contributor docs
Aug 17, 2020
9ad5e0b
updated web_accessibility.md
Aug 18, 2020
2aef015
fix grid output for line
Aug 19, 2020
c78f0f7
document accessible outputs in contributor docs
Aug 19, 2020
6bae71c
add describe and describeElement to contributor docs
Aug 19, 2020
0885478
update web accessibility links
Aug 19, 2020
dd94fb0
delete to-do list comment
Aug 19, 2020
99401c2
update reference
Aug 19, 2020
0eed3bc
store html elements
Aug 21, 2020
1bcbf7a
update contributor docs and reference
Aug 21, 2020
f909628
rename variables in color_namer.js
Aug 21, 2020
eb56f3a
rename element ids
Aug 21, 2020
291691a
add functions to prototype and fix returning dummyDOM
Aug 24, 2020
51f7dba
comments on colorNamer and describe
Aug 25, 2020
86a54fc
Create luismn_gsoc_2020.md
lm-n Aug 25, 2020
f67786f
add 2020 GSoC wrap-up
lm-n Aug 25, 2020
1727734
update links in web accessibility docs
lm-n Aug 25, 2020
d9d9ab0
Merge pull request #2 from lm-n/gsocWorkProduct
lm-n Aug 25, 2020
9e6d83a
fix typos in contributor docs
lm-n Aug 26, 2020
5158d3f
change order of comments to match indentation
lm-n Aug 26, 2020
f9e7deb
fix linting issues
Aug 26, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/existing-feature-enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ To check any option, replace the "[ ]" with a "[x]". Be sure to check out how it

#### Most appropriate sub-area of p5.js?

- [ ] Accessibility (Web Accessibility)
- [ ] Color
- [ ] Core/Environment/Rendering
- [ ] Data
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ To check any option, replace the "[ ]" with a "[x]". Be sure to check out how it

#### Most appropriate sub-area of p5.js?

- [ ] Accessibility (Web Accessibility)
- [ ] Color
- [ ] Core/Environment/Rendering
- [ ] Data
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/found-a-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ To check any option, replace the "[ ]" with a "[x]". Be sure to check out how it

#### Most appropriate sub-area of p5.js?

- [ ] Accessibility (Web Accessibility)
- [ ] Color
- [ ] Core/Environment/Rendering
- [ ] Data
Expand Down
1 change: 0 additions & 1 deletion contributor_docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ The overarching p5.js project includes some repositories other than this one:
- [p5.js-website](https://github.com/processing/p5.js-website) This repository contains most of the code for the [p5.js website](http://p5js.org), with the exception of the reference manual. It is maintained by [Lauren Lee McCarthy](https://github.com/lmccart).
- [p5.js-sound](https://github.com/processing/p5.js-sound) This repository contains the p5.sound.js library. It is maintained by [Jason Sigal](https://github.com/therewasaguy).
- [p5.js-web-editor](https://github.com/processing/p5.js-web-editor) This repository contains the source code for the [p5.js web editor](https://editor.p5js.org). It is maintained by [Cassie Tarakajian](https://github.com/catarak). Note that the older [p5.js editor](https://github.com/processing/p5.js-editor) is now deprecated.
- [p5.accessibility](https://github.com/processing/p5.accessibility) A library that makes the p5 canvas more accessible to people who are blind and visually impaired.



Expand Down
2 changes: 2 additions & 0 deletions contributor_docs/project_wrapups/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ This folder contains wrapup reports for projects from p5.js related [Google Summ

*Note for contributors: Embedded images and media are welcome. Please host these files externally rather than placing in this repo to avoid adding growing the repository filesize too much.*

### Google Summer of Code 2020
* [p5.js accessibility and canvas descriptions](https://github.com/processing/p5.js/blob/main/contributor_docs/project_wrapups/luismn_gsoc_2020.md) by Luis Morales-Navarro, 2020

### Google Summer of Code 2019
* [Search Bar for Sketches in the p5.js Web Editor](https://github.com/processing/p5.js/blob/main/contributor_docs/project_wrapups/rachellim_gsoc_2019.md) by Rachel Lim, 2019
Expand Down
53 changes: 53 additions & 0 deletions contributor_docs/project_wrapups/luismn_gsoc_2020.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# p5.js accessibility and canvas descriptions
GSoC 2020 | [Luis Morales-Navarro](https://luismn.com/)

### Overview:
During this Google Summer of Code, I worked with [Kate Hollenbach](https://github.com/kjhollen)
to improve the accessibility features of p5.js. We focused on merging the
text output and table output functionalities of [p5.accessibility](https://github.com/processing/p5.accessibility)
into p5.js and created functions that support p5.js users in writing their own screen reader accessible canvas descriptions.

### Background:
#### p5.js and Accessibility: from an editor feature to an add-on to the library
The work done during this summer is part of the project's [efforts to make p5.js more accessible for persons with dissabilities](https://contributors-zine.p5js.org/#reflection-claire-kearney-volpe).
Early work by Claire Kearney-Volpe, Taeyoon Choi, and Atul Varma identified the need to make p5.js sketches
and the canvas accessible to screen readers and people who are blind. I met Claire in late 2016 when
they were working with Mathura Govindarajan to add accessibility features to the p5.js editor. I joined them
and together with the support of dedicated contributors and advisors (including Cassie Tarajakan, Lauren McCarthy,
Josh Mielle, Sina Bahram, and Chancey Fleet) we implemented three accessible canvas outputs (a text output, a grid
output and a sound output) on the alpha editor.

Later on, through a 2018 Processing Foundation Fellowship Claire, Mathura and I developed p5.accessibility.js a p5.js add-on.
p5.accessibility.js (developed with contributions from Antonio Guimaraes, Elizabeth G Betts, Mithru Vigneshwara, and Yossi Spira)
helped us bring the work we had done with accessible outputs in the editor to any p5.js sketch that included the add-on.
However, the add-on was still an add-on that required users to include an extra file and edit their html.

At the 2019 p5.js Contributors Conference, as a community, we reinforced the project's commitment to access and inclussion.
Together with Claire, Sina, Lauren, Kate, Olivia McKayla Ross and Evelyn Masso we outlined the pathway forward.
Among short-term actions, we identified the need for functions that allow users to write their own descriptions
and the importance of merging the add-on into the p5.js library.

### Contributions:
During the course of Summer of Code, my work focused on creating library generated screen reader accessible outputs
for basic shapes on the canvas and functions to support user-generated screen reader accessible descriptions of canvas content.
I worked on the following PRs:
- [Add describe() and describeElement() #4654](https://github.com/processing/p5.js/pull/4654): This PR adds the functions describe() and describeElement(), tests for these functions, documentation and examples.
- [Merge Accessibility Add-On into p5.js #4703](https://github.com/processing/p5.js/pull/4703): This PR adds the functions textOutput() and gridOutput(), helper functions to create and update, the outputs and tests, documentation and examples. At first the plan was to update the add-on and prepare it for merging it with p5.js in the near future. However, we realized it was more time effective to recreate the functionality of the text output and grid output in p5.js than upgrading the add-on which relied on ["monkey patching," entities and interceptors](https://medium.com/processing-foundation/making-p5-js-accessible-e2ce366e05a0). Now, the outputs are fully integrated to the library.

More information on how these accessibility features work is available in the [web accessibility contributor docs](https://github.com/processing/p5.js/blob/main/contributor_docs/web_accessibility.md).

### Future
- There is a lot of work that can be done to improve the accessibility of p5.js sketches. In the [Web accessibility next steps conversation #4721 Issue](https://github.com/processing/p5.js/issues/4721) we have outlined some ideas and questions.
- The work done during the summer focused on code and code issues but it is important to iteratively test these features with members of the community, particularly novices and learners who are blind. It is also important to create more resources for learning and teaching that support accessibility.
- Immediate next steps include:
- A tutorial on how to describe things on the canvas.
- Changes in the way screen-reader descriptions are created in the reference. Using the describe() function instead of relying on @alt
- Maybe adding describe() to the templates on the website and editor
- Upgrading the tutorial on using p5 with a screen reader
- Changing the way the accessibility settings work on the editor

### Acknowledgements
I am grateful to Kate Hollenbach for their guidance, feedback and assistance, to Lauren McCarthy for their feedback and to Claire Kearney-Volpe for helping me come up with this project. Thanks to Sina Bahram for their input —our conversations at 2019 p5.js Contributors Conference inspired the describe() and describeElement() functions—, and to Akshay Padte for their advice on unit testing. This GSoC project would not have been possible without Chancey Fleet and Claire (who started thinking of ways to make p5.js sketches screen reader accessible in late 2015), the work of Mathura Govindarajan, and of many other contributors and supporters in the p5.js community.

:heart:

lm-n marked this conversation as resolved.
Show resolved Hide resolved
1 change: 1 addition & 0 deletions contributor_docs/sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@
- [WebGL Architecture](webgl_mode_architecture.md)
- [Supported Browsers](supported_browsers.md)
- [Custom Builds](custom_p5_build.md)
- [Web Accessibility](web_accessibility.md)
Loading