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.

Sign up for GitHub

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

How to label your p5 canvas tutorial revisions #1435

Merged
merged 9 commits into from
Dec 26, 2023
Merged

How to label your p5 canvas tutorial revisions #1435

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d8fda3d
Revisions to tutorial to match new technical writing guide
katlich112358 Nov 5, 2023
05ffb72
Merge branch 'how-to-label-your-p5-canvas-tutorial' of https://github…
katlich112358 Nov 5, 2023
3bc69f9
"revisions"
katlich112358 Nov 19, 2023
9cbded3
update, concatenation
katlich112358 Nov 25, 2023
e37c210
code revisions
katlich112358 Nov 25, 2023
be4e706
Final edits (updating Steps for Labeling)
katlich112358 Dec 10, 2023
f4dce86
Merge branch 'main' into how-to-label-your-p5-canvas-tutorial
katlich112358 Dec 16, 2023
84e90b4
Proofread revisions
katlich112358 Dec 23, 2023
2abb895
Merge branch 'how-to-label-your-p5-canvas-tutorial' of https://github…
katlich112358 Dec 23, 2023
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
589 changes: 322 additions & 267 deletions src/data/en.yml
View file
Open in desktop

Large diffs are not rendered by default.

659 changes: 289 additions & 370 deletions src/data/es.yml
View file
Open in desktop

Large diffs are not rendered by default.

490 changes: 201 additions & 289 deletions src/data/hi.yml
View file
Open in desktop

Large diffs are not rendered by default.

314 changes: 184 additions & 130 deletions src/data/it.yml
View file
Open in desktop

Large diffs are not rendered by default.

490 changes: 201 additions & 289 deletions src/data/ko.yml
View file
Open in desktop

Large diffs are not rendered by default.

505 changes: 209 additions & 296 deletions src/data/zh-Hans.yml
View file
Open in desktop

Large diffs are not rendered by default.

200 changes: 83 additions & 117 deletions src/templates/pages/learn/labeling-canvases.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ slug: learn/

<h1>{{#i18n "labeling-canvases-title"}}{{/i18n}}</h1>

<p>{{#i18n "labeling-canvases-intro-1"}}{{/i18n}} <a class = "code" href="{{root}}/reference/#/p5/describe">describe()</a>,
<a class = "code" href="{{root}}/reference/#/p5/describeElement">describeElement()</a>, <a class = "code" href="{{root}}/reference/#/p5/gridOutput">gridOutput()</a>,
{{#i18n "labeling-canvases-intro-2"}}{{/i18n}} <a class = "code" href="{{root}}/reference/#/p5/textOutput">textOutput()</a> {{#i18n "labeling-canvases-intro-3"}}{{/i18n}}</p>
<h2>{{#i18n "labeling-canvases-intro"}}{{/i18n}}</h2>
<p>{{#i18n "labeling-canvases-intro-1"}}{{/i18n}}</p>

<h2>{{#i18n "labeling-canvases-what-is-labeling"}}{{/i18n}}</h2>
<p>{{#i18n "labeling-canvases-what-is-labeling-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-what-is-labeling-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-what-is-labeling-3"}}{{/i18n}} <a href="{{root}}/learn/p5-screen-reader.html">Using p5 with a screen reader</a>.</p>

<h2>{{#i18n "labeling-canvases-why-labeling-matters"}}{{/i18n}}</h2>
<p>{{#i18n "labeling-canvases-why-labeling-matters-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-why-labeling-matters-2"}}{{/i18n}}</p>

<h2>{{#i18n "labeling-canvases-available-labels"}}{{/i18n}}</h2>
<p>{{#i18n "labeling-canvases-available-labels-1"}}{{/i18n}}:</p>
Expand All @@ -31,130 +32,107 @@ slug: learn/
<li>{{#i18n "labeling-canvases-available-labels-li-4"}}{{/i18n}}</li>
</ul>

<h2>{{#i18n "labeling-canvases-best-practices"}}{{/i18n}}</h2>

<h3>{{#i18n "labeling-canvases-best-practices-what-requires-labeling"}}{{/i18n}}</h3>
<p>{{#i18n "labeling-canvases-best-practices-what-requires-labeling-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-best-practices-what-requires-labeling-2"}}{{/i18n}}</p>


<!-- Code example below copied from Reference page: https://p5js.org/reference/#/p5/describe-->
<h2>{{#i18n "labeling-canvases-prerequisites"}}{{/i18n}}</h2>
<p>{{#i18n "labeling-canvases-prerequisites-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-prerequisites-2"}}{{/i18n}}</p>

<script type="text/p5" data-p5-version="{{ version }}">
function setup() {
createCanvas(100, 100);
describe("A blue square in the center of a black canvas.");
}

function draw() {
background(255,192,203);
background(250);
noStroke();
fill(200,0,0);

describeElement("Heart","Red heart in the bottom right corner.");
ellipse(67, 67, 20, 20);
ellipse(83, 67, 20, 20);
triangle(91, 73, 75, 95, 59, 73);
rect(67, 67, 20, 20);
}
</script>

<p>{{#i18n "labeling-canvases-best-practices-what-requires-labeling-3"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-best-practices-what-requires-labeling-4"}}{{/i18n}}</p>
<h2>{{#i18n "labeling-canvases-steps-for-labeling"}}{{/i18n}}</h2>

<h3>{{#i18n "labeling-canvases-steps-for-labeling-step-1"}}{{/i18n}}</h3>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-3"}}{{/i18n}}</p>

<script type="text/p5" data-p5-version="{{ version }}">
function setup() {
createCanvas(100, 100);
describe("A red heart in the bottom right corner of a white background.");
}

function draw() {
background(255,192,203);
background(250);
noStroke();
fill(200,0,0);

textSize(12);
textStyle(NORMAL);
describeElement("Text", "The text 'Hello world!' in the upper left corner of a pink canvas.'");
text('Hello world!', 5, 30);
ellipse(67, 67, 20, 20);
ellipse(83, 67, 20, 20);
triangle(91, 73, 75, 95, 59, 73);
}
</script>

<p>{{#i18n "labeling-canvases-best-practices-what-requires-labeling-5"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-4"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-5"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-6"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-7"}}{{/i18n}}</p>

<h3>{{#i18n "labeling-canvases-best-practices-dont-label"}}{{/i18n}}</h3>
<p>{{#i18n "labeling-canvases-best-practices-dont-label-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-best-practices-dont-label-2"}}{{/i18n}}</p>

<h3>{{#i18n "labeling-canvases-best-practices-using-labels"}}{{/i18n}}</h3>
<h4>{{#i18n "labeling-canvases-steps-for-labeling-step-1-complex"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-complex-1"}}{{/i18n}}</p>
<ul class="list_view">
<li>{{#i18n "labeling-canvases-steps-for-labeling-step-1-complex-li-1"}}{{/i18n}}</li>
<li>{{#i18n "labeling-canvases-steps-for-labeling-step-1-complex-li-2"}}{{/i18n}}</li>
<li>{{#i18n "labeling-canvases-steps-for-labeling-step-1-complex-li-3"}}{{/i18n}}</li>
<li>{{#i18n "labeling-canvases-steps-for-labeling-step-1-complex-li-4"}}{{/i18n}}</li>
</ul>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-1-complex-2"}}{{/i18n}}</p>

<h4>{{#i18n "labeling-canvases-best-practices-using-labels-all-canvases"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-best-practices-using-labels-all-canvases-1"}}{{/i18n}}</p>
<h3>{{#i18n "labeling-canvases-steps-for-labeling-step-2"}}{{/i18n}}</h3>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-2"}}{{/i18n}}</p>
<h4>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-de"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-de-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-de-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-de-3"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-de-4"}}{{/i18n}}</p>

<script type="text/p5" data-p5-version="{{ version }}">
function setup() {
createCanvas(100, 100);
//pProvides an overall description of the canvas.
katlich112358 marked this conversation as resolved.
Show resolved Hide resolved
describe("Text in the top right corner with red heart in the bottom right corner on a white background.");
}

function draw() {
background(250);
noStroke();
fill(200, 0, 0);

describe("Flower with red petals and a green stem on a white canvas.");

fill("#0DCC23");
rect(48, 50, 5, 50);

fill(200,0,0);
ellipse(40, 55, 18);
ellipse(40, 45, 18);
ellipse(50, 40, 18);
ellipse(60, 55, 18);
ellipse(60, 45, 18);
ellipse(50, 60, 18);

fill("#FFE200");
ellipse(50,50,15);
}
</script>

<p>{{#i18n "labeling-canvases-best-practices-using-labels-all-canvases-2"}}{{/i18n}}</p>

<h4>{{#i18n "labeling-canvases-best-practices-using-labels-simple"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-best-practices-using-labels-simple-1"}}{{/i18n}}</p>

<script type="text/p5" data-p5-version="{{ version }}">
function setup() {
createCanvas(100, 100);
}
textSize(12);
textStyle(NORMAL);
// Specific label for text.
describeElement("Text", "The text 'Hello world!' in the upper left corner of a white canvas.");
text('Hello world!', 5, 30);

function draw() {
background(250);
noStroke();

textOutput(LABEL);
// Specific label for the heart.
describeElement("Heart", "A red heart in the bottom right corner.");
ellipse(67, 67, 20, 20);
ellipse(83, 67, 20, 20);
triangle(91, 73, 75, 95, 59, 73);

fill("#0DCC23");
rect(48, 50, 5, 50);

fill(200,0,0);
ellipse(40, 55, 18);
ellipse(40, 45, 18);
ellipse(50, 40, 18);
ellipse(60, 55, 18);
ellipse(60, 45, 18);
ellipse(50, 60, 18);

fill("#FFE200");
ellipse(50,50,15);
}
</script>

<p>{{#i18n "labeling-canvases-best-practices-using-labels-simple-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-best-practices-using-labels-simple-3"}}{{/i18n}}</p>

<h4>{{#i18n "labeling-canvases-best-practices-using-labels-interactive"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-best-practices-using-labels-interactive-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-de-5"}}{{/i18n}}</p>
<h4>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-go-to"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-using-go-to-1"}}{{/i18n}}</p>
<h4>{{#i18n "labeling-canvases-steps-for-labeling-step-2-animated"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-animated-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-animated-2"}}{{/i18n}}</p>

<!-- Code example below copied from Reference page: https://p5js.org/reference/#/p5/describe-->

<script type="text/p5" data-p5-version="{{ version }}">
let x = 0;

Expand All @@ -170,58 +148,46 @@ function draw() {
fill(0, 255, 0);
ellipse(x, 50, 40, 40);
x = x + 0.1;
describe('green circle at x pos ' + round(x) + ' moving to the right', LABEL);
// Label updates with shape’s translation.
describe("A green circle at x position " + round(x) + ", moving to the right", LABEL);
}
</script>

<p>{{#i18n "labeling-canvases-best-practices-using-labels-interactive-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-best-practices-using-labels-interactive-3"}}{{/i18n}}</p>

<h4>{{#i18n "labeling-canvases-best-practices-using-labels-complex"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-best-practices-using-labels-complex-1"}}{{/i18n}}</p>

<ul class="list_view">
<li>{{#i18n "labeling-canvases-best-practices-using-labels-complex-ul-1"}}{{/i18n}}</li>
<li>{{#i18n "labeling-canvases-best-practices-using-labels-complex-ul-2"}}{{/i18n}}</li>
<li>{{#i18n "labeling-canvases-best-practices-using-labels-complex-ul-3"}}{{/i18n}}</li>
</ul>
<p>{{#i18n "labeling-canvases-best-practices-using-labels-complex-2"}}{{/i18n}}</p>

<h3>{{#i18n "labeling-canvases-how-not-to-use-labels"}}{{/i18n}}</h3>
<h4>{{#i18n "labeling-canvases-steps-for-labeling-step-2-do-donts"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-do-donts-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-2-do-donts-2"}}{{/i18n}}</p>

<h4>{{#i18n "labeling-canvases-how-not-to-use-labels-sub"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-how-not-to-use-labels-sub-1"}}{{/i18n}}</p>
<h3>{{#i18n "labeling-canvases-steps-for-labeling-step-3"}}{{/i18n}}</h3>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-3-1"}}{{/i18n}}</p>

<h4>{{#i18n "labeling-canvases-how-not-to-use-labels-info-overkill"}}{{/i18n}}</h4>
<p>{{#i18n "labeling-canvases-how-not-to-use-labels-info-overkill-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-how-not-to-use-labels-info-overkill-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-how-not-to-use-labels-info-overkill-3"}}{{/i18n}}</p>

<h2>{{#i18n "labeling-canvases-testing-labels"}}{{/i18n}}</h2>
<p>{{#i18n "labeling-canvases-testing-labels-1"}}{{/i18n}}</p>

<script type="text/p5" data-p5-version="{{ version }}">
<script type="text/p5" data-p5-version="{{ version }}">
function setup() {
createCanvas(100, 100);
}

function draw() {

// LABEL shows the label next to the canvas.
gridOutput(LABEL);

background(255,192,203);
background(250);
noStroke();
fill(200,0,0);
fill(200, 0, 0);

ellipse(67, 67, 20, 20);
ellipse(83, 67, 20, 20);
triangle(91, 73, 75, 95, 59, 73);
}
</script>

<p>{{#i18n "labeling-canvases-testing-labels-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-testing-labels-3"}}{{/i18n}}</p>
<br>
<p>{{#i18n "labeling-canvases-note"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-3-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-3-3"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-steps-for-labeling-step-3-4"}}{{/i18n}}</p>

<h2>{{#i18n "labeling-canvases-conclusion"}}{{/i18n}}</h2>
<p>{{#i18n "labeling-canvases-conclusion-1"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-conclusion-2"}}{{/i18n}}</p>
<p>{{#i18n "labeling-canvases-conclusion-3"}}{{/i18n}}</p>

<!-- this script only needs to get added once even if there are multiple widget instances -->
<script src="//toolness.github.io/p5.js-widget/p5-widget.js"></script>
Expand Down
Loading