Skip to content

Commit 7b2218e

Browse files
kfranqueirokfranqueiro
committed
Update errata format based on discussion with Mike/Alastair/Bruce
1 parent 6449897 commit 7b2218e

File tree

3 files changed

+27
-18
lines changed

3 files changed

+27
-18
lines changed

‎errata/21.html‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h1 id="title">Web Content Accessibility Guidelines (WCAG) 2.1 Errata</h1>
1818
<section id="abstract">
1919
<h2>Abstract</h2>
2020
<p>This document records all known errors in the <a href="https://www.w3.org/TR/WCAG21/">Web Content Accessibility Guidelines (WCAG) 2.1</a> specification.</p>
21-
<p>The errata are classified as Substantive or Editorial, and listed in reverse chronological order based on the date of publication to which they are applicable.</p>
21+
<p>The errata are classified as Substantive or Editorial, as classified by the W3C <a href="https://www.w3.org/policies/process/20231103/#correction-classes">Classes of Changes</a>, and listed in reverse chronological order based on the date of publication to which they are applicable.</p>
2222
<p>Each entry has the following information:</p>
2323
<ul>
2424
<li>The date it was added to the errata page.</li>
@@ -65,21 +65,21 @@ <h3>Substantive Errata</h3>
6565
<section id="editorial-{{ trDate }}">
6666
<h3>Editorial Errata</h3>
6767
<ul>
68-
<li>2023-04-18: In <a href="{{ trUrl }}#parsing">4.1.1 Parsing</a> one note should be deleted, and two notes added, including: "This Success Criterion should be considered as always satisfied for any content using HTML or XML."</li>
69-
<li>2022-02-02: In <a href="{{ trUrl }}#issue-container-generatedID-43">a note in the definition of accessibility supported</a>, references to "Conformance Criterion" were changed to "Conformance Requirement".</li>
70-
<li>2022-02-22: In the <a href="{{ trUrl }}#dfn-relative-luminance">definition of relative luminance</a>, the red threshold was updated from 0.03928 to 0.04045.</li>
71-
<li>2019-05-09: In <a href="{{ trUrl }}#orientation">1.3.4 Orientation</a>, the note referencing "binary display orientation" has been clarified to read "content is not necessarily restricted to landscape or portrait display orientation".</li>
72-
<li>2018-08-06: In <a href="{{ trUrl }}#content-on-hover-or-focus">1.4.13 Content on Hover or Focus</a>, the word "dismissable" should be "dismissible".</li>
73-
<li>2018-08-06: In <a href="{{ trUrl }}#robust">4. Robust</a>, the word "by" is repeated but should be present only once.</li>
74-
<li>2018-08-06: In <a href="{{ trUrl }}#cc2">5.2.2 Full pages</a>, the third note began with "New" which should be removed.</li>
75-
<li>2018-07-11: In the <a href="{{ trUrl }}#intro">Introduction</a>, several (but not all) references to "WCAG 2.0" should be "WCAG 2.1".</li>
76-
<li>2018-07-11: In the <a href="{{ trUrl }}#numbering-in-wcag-2-1">0.5.2 Numbering in WCAG 2.1</a>, the words "critera" and "ccriteria" should be "criteria".</li>
77-
<li>2018-07-11: In <a href="{{ trUrl }}#reflow">1.4.10 Reflow</a>, the first note had a supernumary "Note" indicator which should be removed.</li>
78-
<li>2018-07-11: In <a href="{{ trUrl }}#conformance-required">5.3.1 Required Components of a Conformance Claim</a> the editorial note "In WCAG 2.0 this was a dated URI, which may need to be adjusted when this becomes a Rec." should be removed.</li>
79-
<li>2018-07-11: In the definition for <a href="{{ trUrl }}#dfn-keyboard-interface">keyboard interface</a>, the second (of three) note should be an example of the first note, leaving only two actual notes.</li>
80-
<li>2018-07-11: In the definition for <a href="{{ trUrl }}#dfn-technologies">technology</a>, the third note should instead be an example.</li>
81-
<li>2018-06-08: In <a href="{{ trUrl }}#input-purposes">7. Input Purposes for User Interface Components</a>, the word "county" should be "country".</li>
82-
<li>In the <a href="{{ trUrl }}#sotd">Status of This Document</a> the paragraph beginning "This document has been reviewed by W3C Members..." appears twice. The first instance of this paragraph should be removed.</li>
68+
<li>2023-04-18: In <a href="{{ trUrl }}#parsing">4.1.1 Parsing</a>, removing one note and adding two new notes, including: "This Success Criterion should be considered as always satisfied for any content using HTML or XML."</li>
69+
<li>2022-02-02: In <a href="{{ trUrl }}#issue-container-generatedID-43">a note in the definition of accessibility supported</a>, updating "Conformance Criterion" references to "Conformance Requirement".</li>
70+
<li>2022-02-22: In the <a href="{{ trUrl }}#dfn-relative-luminance">definition of relative luminance</a>, updating the red threshold from 0.03928 to 0.04045.</li>
71+
<li>2019-05-09: In <a href="{{ trUrl }}#orientation">1.3.4 Orientation</a>, clarifying the note referencing "binary display orientation" to read "content is not necessarily restricted to landscape or portrait display orientation".</li>
72+
<li>2018-08-06: In <a href="{{ trUrl }}#content-on-hover-or-focus">1.4.13 Content on Hover or Focus</a>, correcting the word "dismissable" to "dismissible".</li>
73+
<li>2018-08-06: In <a href="{{ trUrl }}#robust">4. Robust</a>, removing repetition of the word "by".</li>
74+
<li>2018-08-06: In <a href="{{ trUrl }}#cc2">5.2.2 Full pages</a>, removing "New" from the beginning of the third note.</li>
75+
<li>2018-07-11: In the <a href="{{ trUrl }}#intro">Introduction</a>, correcting several (but not all) "WCAG 2.0" references to "WCAG 2.1".</li>
76+
<li>2018-07-11: In the <a href="{{ trUrl }}#numbering-in-wcag-2-1">0.5.2 Numbering in WCAG 2.1</a>, correcting the words "critera" and "ccriteria" to "criteria".</li>
77+
<li>2018-07-11: In <a href="{{ trUrl }}#reflow">1.4.10 Reflow</a>, removing a supernumary "Note" indicator from the first note.</li>
78+
<li>2018-07-11: In <a href="{{ trUrl }}#conformance-required">5.3.1 Required Components of a Conformance Claim</a> removing the editorial note "In WCAG 2.0 this was a dated URI, which may need to be adjusted when this becomes a Rec."</li>
79+
<li>2018-07-11: In the definition for <a href="{{ trUrl }}#dfn-keyboard-interface">keyboard interface</a>, updating the second (of three) notes to be an example of the first note, leaving only two actual notes.</li>
80+
<li>2018-07-11: In the definition for <a href="{{ trUrl }}#dfn-technologies">technology</a>, updating the third note to instead be an example.</li>
81+
<li>2018-06-08: In <a href="{{ trUrl }}#input-purposes">7. Input Purposes for User Interface Components</a>, correcting the word "county" to "country".</li>
82+
<li>In the <a href="{{ trUrl }}#sotd">Status of This Document</a> removing the first instance of the repeated paragraph beginning "This document has been reviewed by W3C Members...".</li>
8383
</ul>
8484
</section>
8585
</section>

‎errata/22.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h1 id="title">Web Content Accessibility Guidelines (WCAG) 2.2 Errata</h1>
1818
<section id="abstract">
1919
<h2>Abstract</h2>
2020
<p>This document records all known errors in the <a href="https://www.w3.org/TR/WCAG22/">Web Content Accessibility Guidelines (WCAG) 2.2</a> specification.</p>
21-
<p>The errata are classified as Substantive or Editorial, and listed in reverse chronological order based on the date of publication to which they are applicable.</p>
21+
<p>The errata are classified as Substantive or Editorial, as classified by the W3C <a href="https://www.w3.org/policies/process/20231103/#correction-classes">Classes of Changes</a>, and listed in reverse chronological order based on the date of publication to which they are applicable.</p>
2222
<p>Each entry has the following information:</p>
2323
<ul>
2424
<li>The date it was added to the errata page.</li>

‎errata/README.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,14 @@ Each erratum should be in the following format
3232
<li>YYYY-MM-DD: In <a href="{{ trUrl }}#sectionid">Section Title</a>, details of what happened.</li>
3333
```
3434

35-
Adhering to this format is important, as any entries under the latest version will also be
35+
Adhering to this format is important, as any entries under the latest published version will also be
3636
parsed for inclusion within Guideline/SC boxes and Key Terms definitions within Understanding pages.
37+
38+
`details of what happened` should be expressed in present progressive tense
39+
(e.g. "updating", "removing", "adding"), with the desired outcome listed first.
40+
For example:
41+
42+
- updating the red threshold from ... to ...
43+
- removing one note and adding two new notes, including ...
44+
- removing a supernumary "Note" indicator from the first note.
45+
- correcting the word ... to ...

0 commit comments

Comments
 (0)