Skip to content

Commit e72e1d6

Browse files
kfranqueirokfranqueiro
committed
Switch to reverse-chron + improve template + document format
1 parent dc5e18e commit e72e1d6

File tree

5 files changed

+71
-26
lines changed

5 files changed

+71
-26
lines changed

‎.eleventyignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
*.md
2+
**/README.md
23
11ty/
34
acknowledgements.html
45
acknowledgements/

‎11ty/guidelines.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ export const getErrataForVersion = async (version: WcagVersion) => {
301301
const errata: Record<string, string[]> = {};
302302

303303
$("main > section[id]")
304-
.last()
304+
.first()
305305
.find(`li:has(${aSelector})`)
306306
.each((_, el) => {
307307
const $el = $(el);

‎errata/21.html‎

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
{%- # PLEASE READ errata/README.md BEFORE EDITING -%}
2+
13
<!DOCTYPE html>
24
<html lang="en">
35
<head>
@@ -16,7 +18,7 @@ <h1 id="title">Web Content Accessibility Guidelines (WCAG) 2.1 Errata</h1>
1618
<section id="abstract">
1719
<h2>Abstract</h2>
1820
<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>
19-
<p>The errata are classified as Substantive or Editorial, and listed in chronological order based on the date of publication to which they are applicable.</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>
2022
<p>Each entry has the following information:</p>
2123
<ul>
2224
<li>The date it was added to the errata page.</li>
@@ -26,6 +28,7 @@ <h2>Abstract</h2>
2628
</ul>
2729
<p>Substantive corrections are proposed by the <a href="https://www.w3.org/WAI/GL/">Accessibility Guidelines Working Group</a>, which has consensus that they are appropriate; they are not to be considered normative until a new Recommendation is published following the <a href="https://www.w3.org/2018/Process-20180201/#revised-rec">process to revise a Recommendation</a>.</p>
2830
<p>Please view the <a href="https://www.w3.org/WAI/standards-guidelines/wcag/commenting/">public comment instructions</a> if you would like to comment to the Working Group. Comments submitted are publicly available in the <a href="http://lists.w3.org/Archives/Public/public-agwg-comments/">archive for the Accessibility Guidelines Working Group public comments mailing list</a>.</p>
31+
<p>The <a href="https://github.com/w3c/wcag/commits/WCAG-2.1/guidelines">full commit history</a> can be viewed on GitHub.</p>
2932
</section>
3033
<section id="contents">
3134
<h2>Table of Contents</h2>
@@ -35,8 +38,24 @@ <h2>Table of Contents</h2>
3538
</section>
3639
<hr/>
3740
<main>
41+
{%- assign trDate = "current" -%}
42+
{%- assign trUrl = "https://www.w3.org/TR/WCAG21/" -%}
43+
<section id="since-{{ trDate }}">
44+
<h2>Errata since <a href="{{ trUrl }}">Current Publication</a></h2>
45+
<section id="substantive-{{ trDate }}">
46+
<h3>Substantive Errata</h3>
47+
<p>No substantive errata have been recorded at present.</p>
48+
</section>
49+
<section id="editorial-{{ trDate }}">
50+
<h3>Editorial Errata</h3>
51+
<p>No editorial errata have been recorded at present.</p>
52+
</section>
53+
</section>
54+
3855
{%- assign trDate = "2018-06-05" -%}
39-
{%- capture trUrl -%}https://www.w3.org/TR/2018/REC-WCAG21-{{ trDate | replace: "-", "" }}/{%- endcapture -%}
56+
{%- capture trUrl -%}
57+
https://www.w3.org/TR/{{ trDate | split: "-" | first }}/REC-WCAG21-{{ trDate | replace: "-", "" }}/
58+
{%- endcapture -%}
4059
<section id="since-{{ trDate }}">
4160
<h2>Errata since <a href="{{ trUrl }}">{{ trDate | date: "%d %B %Y" }} Publication</a></h2>
4261
<section id="substantive-{{ trDate }}">
@@ -46,38 +65,24 @@ <h3>Substantive Errata</h3>
4665
<section id="editorial-{{ trDate }}">
4766
<h3>Editorial Errata</h3>
4867
<ul>
49-
<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>
50-
<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>
51-
<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>
52-
<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>
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>
5372
<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>
5473
<li>2018-08-06: In <a href="{{ trUrl }}#robust">4. Robust</a>, the word "by" is repeated but should be present only once.</li>
5574
<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>
5678
<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>
5779
<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>
5880
<li>2018-07-11: In the definition for <a href="{{ trUrl }}#dfn-technologies">technology</a>, the third note should instead be an example.</li>
5981
<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>
60-
<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>
61-
<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>
62-
<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>
63-
<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>
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>
6483
</ul>
6584
</section>
6685
</section>
67-
68-
{%- assign trDate = "current" -%}
69-
{%- assign trUrl = "https://www.w3.org/TR/WCAG21/" -%}
70-
<section id="since-{{ trDate }}">
71-
<h2>Errata since <a href="{{ trUrl }}">Current Publication</a></h2>
72-
<section id="substantive-{{ trDate }}">
73-
<h3>Substantive Errata</h3>
74-
<p>No substantive errata have been recorded at present.</p>
75-
</section>
76-
<section id="editorial-{{ trDate }}">
77-
<h3>Editorial Errata</h3>
78-
<p>No editorial errata have been recorded at present.</p>
79-
</section>
80-
</section>
8186
</main>
8287
</body>
8388
</html>

‎errata/22.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
{%- # PLEASE READ errata/README.md BEFORE EDITING -%}
2+
13
<!DOCTYPE html>
24
<html lang="en">
35
<head>
@@ -16,7 +18,7 @@ <h1 id="title">Web Content Accessibility Guidelines (WCAG) 2.2 Errata</h1>
1618
<section id="abstract">
1719
<h2>Abstract</h2>
1820
<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>
19-
<p>The errata are classified as Substantive or Editorial, and listed in chronological order based on the date of publication to which they are applicable.</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>
2022
<p>Each entry has the following information:</p>
2123
<ul>
2224
<li>The date it was added to the errata page.</li>
@@ -26,6 +28,7 @@ <h2>Abstract</h2>
2628
</ul>
2729
<p>Substantive corrections are proposed by the <a href="https://www.w3.org/WAI/GL/">Accessibility Guidelines Working Group</a>, which has consensus that they are appropriate; they are not to be considered normative until a new Recommendation is published following the <a href="https://www.w3.org/2018/Process-20180201/#revised-rec">process to revise a Recommendation</a>.</p>
2830
<p>Please view the <a href="https://www.w3.org/WAI/standards-guidelines/wcag/commenting/">public comment instructions</a> if you would like to comment to the Working Group. Comments submitted are publicly available in the <a href="http://lists.w3.org/Archives/Public/public-agwg-comments/">archive for the Accessibility Guidelines Working Group public comments mailing list</a>.</p>
31+
<p>The <a href="https://github.com/w3c/wcag/commits/main/guidelines">full commit history</a> can be viewed on GitHub.</p>
2932
</section>
3033
<section id="contents">
3134
<h2>Table of Contents</h2>

‎errata/README.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Errata Editing Instructions
2+
3+
Errata are listed in reverse-chronological order, first sectioned by publish date,
4+
then within each section based on when each erratum was added.
5+
6+
The first top-level section under `<main>` corresponds to the latest version / unpinned URL;
7+
subsequent sections correspond to previous versions / date-stamped URLs.
8+
9+
Each top-level section should be preceded by `trDate` and `trUrl` variable assignments.
10+
These variables reduce the chance of copy-paste errors within individual errata.
11+
For sections corresponding to previous versions, assignments should follow this pattern
12+
(only `YYYY-MM-DD` should need to be replaced):
13+
14+
```
15+
{%- assign trDate = "YYYY-MM-DD" -%}
16+
{%- capture trUrl -%}
17+
https://www.w3.org/TR/{{ trDate | split: "-" | first }}/REC-WCAG21-{{ trDate | replace: "-", "" }}/
18+
{%- endcapture -%}
19+
```
20+
21+
The level 2 heading in the top-level section for each previous version should use this code
22+
(no replacements necessary, making use of the preceding variable reassignments):
23+
24+
```html
25+
<h2>Errata since <a href="{{ trUrl }}">{{ trDate | date: "%d %B %Y" }} Publication</a></h2>
26+
```
27+
28+
Each erratum should be in the following format
29+
(replacing `YYYY-MM-DD`, `Section Title`, and `details of what happened`):
30+
31+
```html
32+
<li>YYYY-MM-DD: In <a href="{{ trUrl }}#sectionid">Section Title</a>, details of what happened.</li>
33+
```
34+
35+
Adhering to this format is important, as any entries under the latest version will also be
36+
parsed for inclusion within Guideline/SC boxes and Key Terms definitions within Understanding pages.

0 commit comments

Comments
 (0)