Skip to content

Commit

Permalink
Merge branch 'useDescribeOnPrimitives' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
lm-n committed Jan 30, 2022
2 parents 9814cd2 + 00b8dc1 commit 52a20ba
Show file tree
Hide file tree
Showing 3 changed files with 146 additions and 90 deletions.
54 changes: 49 additions & 5 deletions contributor_docs/inline_documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ noFill();
arc(50, 55, 60, 60, HALF_PI, PI);
arc(50, 55, 70, 70, PI, PI+QUARTER_PI);
arc(50, 55, 80, 80, PI+QUARTER_PI, TWO_PI);
describe('shattered outline of ellipse created using four arcs');
</code>
</div>
```
Expand All @@ -200,19 +201,28 @@ by a line break.
```
@example
<div>
<code>arc(50, 50, 80, 80, 0, PI+QUARTER_PI, OPEN);</code>
<code>
arc(50, 50, 80, 80, 0, PI+QUARTER_PI, OPEN);
describe('ellipse created using arc with its top right open');
</code>
</div>
<div>
<code>arc(50, 50, 80, 80, 0, PI, OPEN);</code>
<code>
arc(50, 50, 80, 80, 0, PI, OPEN);
describe('bottom half of an ellipse created using arc');
</code>
</div>
```

If you do not want the example to execute your code (i.e. you just want the code to show up), include the class "norender" in the div:
```
@example
<div class="norender">
<code>arc(50, 50, 80, 80, 0, PI+QUARTER_PI, OPEN);</code>
<code>
arc(50, 50, 80, 80, 0, PI+QUARTER_PI, OPEN);
describe('ellipse created using arc with its top right open');
</code>
</div>
```

Expand All @@ -230,8 +240,42 @@ function setup() {

If you need to link to external asset files, put them in [/docs/yuidoc-p5-theme/assets](https://github.com/processing/p5.js/tree/main/docs/yuidoc-p5-theme/assets) and then link to them with "assets/filename.ext" in the code. See the [tint example](http://p5js.org/reference/#/p5/tint).

### Adding alt-text
Finally, for every example you add, please add [alt-text](https://moz.com/learn/seo/alt-text) so visually impaired users can understand what the example is showing on the screen. This can be added with the tag `@alt` at the end of all of the examples for a given function (not an individual `@alt` tag under each), add a line break to separate the descriptions for multiple examples.
### Add a canvas description using describe()
Finally, for every example you add, you are required to use the p5.js function `describe()` in the example to create a screen-reader accessible description for the canvas. Include only one parameter: a string with a brief description of what is happening on the canvas. Do NOT add a second parameter.
```
@example
<div>
<code>
let xoff = 0.0;
function draw() {
background(204);
xoff = xoff + 0.01;
let n = noise(xoff) * width;
line(n, 0, n, height);
decribe('vertical line moves left to right with updating noise values');
}
</code>
</div>
<div>
<code>
let noiseScale=0.02;
function draw() {
background(0);
for (let x=0; x < width; x++) {
let noiseVal = noise((mouseX+x)*noiseScale, mouseY*noiseScale);
stroke(noiseVal*255);
line(x, mouseY+noiseVal*80, x, height);
}
describe('horizontal wave pattern effected by mouse x-position & updating noise values');
}
</code>
</div>
```
For more on `describe()` visit the [web accessibility contributor docs](https://p5js.org/contributor-docs/#/web_accessibility?id=user-generated-accessible-canvas-descriptions).

Previous documentation guidelines required adding [alt-text](https://moz.com/learn/seo/alt-text) to create screen-reader accessible canvas description. THIS IS NO LONGER RECOMMENDED. ALWAYS USE `describe()`. Previously, alt-text was added with the tag `@alt` at the end of all of the examples for a given function (not an individual `@alt` tag under each), and an added a line break to separate the descriptions for multiple examples.
```
@example
<div>
Expand Down
Loading

1 comment on commit 52a20ba

@lm-n
Copy link
Member Author

@lm-n lm-n commented on 52a20ba Jan 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Address #5139

  • Provide examples for transitioning from @alt to using describe() in reference
  • Uses describe() in color/settings.js and core/shape/2d_primitives.js

@limzykenneth @Zearin this should be an example for #5577

Please sign in to comment.