Skip to content

Commit 807a6c2

Browse files
Don't just refer to SCs by their number, don't use colon (#4939)
For consistency: * don't use a colon between the SC number and its title - my main reason is that it looks somehow "stilted", and when used in a sentence it can end up "fighting" with the punctuation of the actual sentence (particularly when not part of a link), and just makes it harder to parse * don't just refer to SCs by number alone - (at least for first mentions in a document) this helps documents be more readable without assuming that the reader walks around remembering what each SC number is/what criterion it actually represents. It would be good to get something decided/officially mentioned in the style guide (particularly for the use of `:` or not) EDIT: normative changes split into #4947 --------- Co-authored-by: Kenneth G. Franqueiro <kfranqueiro@users.noreply.github.com>
1 parent 005b1e6 commit 807a6c2

File tree

86 files changed

+141
-131
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+141
-131
lines changed

11ty/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ The following list outlines properties available on each technique object:
7171
- May be empty string (`""`), in which case the subsequent "of" is dropped
7272
- `usingPrefix` - Adds text to appear before `usingConjunction`
7373
- `skipUsingPhrase` - Omits the entire "... using ... of the following techniques" phrase
74-
- This is mainly an escape hatch for rare instances where a child list is used but no "using" phrase appears at all (e.g. in 1.4.4: Resize Text)
74+
- This is mainly an escape hatch for rare instances where a child list is used but no "using" phrase appears at all (e.g. in 1.4.4 Resize Text)
7575

7676
Typically, either `id` or `title` is required.
7777
If `id` is specified, then `prefix` and/or `suffix` may also be specified (with HTML flow content allowed in each),
7878
resulting in "{prefix} {linked technique title} {suffix}".
7979

8080
In extremely rare cases, `using` may be specified alone without either `id` or `title`,
81-
e.g. for top-level "Using two or more of the following" in 2.4.5: Multiple Ways.
81+
e.g. for top-level "Using two or more of the following" in 2.4.5 Multiple Ways.
8282

8383
#### Conjunctions
8484

@@ -87,7 +87,7 @@ To represent multiple parallel techniques, an `and` key may be specified instead
8787
- `and` - an array of technique objects or shorthand strings (as described above)
8888
- `using` and its related fields (seen above) may optionally be specified alongside `and`
8989
- `andConjunction` may optionally be specified alongside `and`,
90-
to override the default `"<strong>AND</strong>"` phrasing (e.g. in 4.1.3: Status Messages)
90+
to override the default `"<strong>AND</strong>"` phrasing (e.g. in 4.1.3 Status Messages)
9191
- Techniques listed _within_ `and` should be flat, never containing `and` or `using`
9292

9393
### Situations or Other Subsections (Sufficient only)
@@ -96,19 +96,19 @@ The top level of the `sufficient` array may consist entirely of either technique
9696
or subsection entries. It should not contain a mix of both.
9797

9898
Subsections are typically used to define multiple "situations", where each title begins with "Situation A:", "Situation B:", etc.;
99-
in rare cases it is used for other purposes, e.g. in 1.4.8: Visual Presentation.
99+
in rare cases it is used for other purposes, e.g. in 1.4.8 Visual Presentation.
100100

101101
Subsection entries contain the following:
102102

103103
- `title` (required, HTML allowed)
104104
- `techniques` (required) - array of technique entries (see above)
105-
- `note` (optional, HTML allowed) - content to appear in a Note at the end of the subsection (e.g. in 4.1.3: Status Messages)
105+
- `note` (optional, HTML allowed) - content to appear in a Note at the end of the subsection (e.g. in 4.1.3 Status Messages)
106106
- `groups` (optional) - array of objects with `id`, `title`, `techniques`; see more below
107107
- `techniques` within `groups` are not expected to involve `and` or `using`
108108

109109
#### Groups within Situations
110110

111-
Most of the situations in 1.1.1: Non-text Content include groupings which start with a boldface paragraph (not a heading),
111+
Most of the situations in 1.1.1 Non-text Content include groupings which start with a boldface paragraph (not a heading),
112112
and are referenced one or more times within preceding "using" clauses.
113113
Groups can be defined at the top level of each situation/section entry as mentioned above.
114114
Defining `groups` automatically implies a "using" relationship, without explicitly defining `using` for each technique.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ Obsolete techniques should not be removed from the repository. Instead, they can
178178
---
179179
obsoleteSince: 22
180180
obsoleteMessage: |
181-
This failure relates to 4.1.1: Parsing, which was removed as of WCAG 2.2.
181+
This failure relates to 4.1.1 Parsing, which was removed as of WCAG 2.2.
182182
---
183183
```
184184

_includes/understanding/h1.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ <h1>
44
Understanding
55
<a href="https://w3.org/TR/WCAG{{ version }}#{{ page.fileSlug }}">
66
{{- guideline.type }} {{ guideline.num -}}
7-
</a>:
7+
</a>
88
</span>{{ guideline.name }}
99
{%- if guideline.level %} (Level {{ guideline.level }}){% endif %}
1010
</h1>

eleventy.config.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ export default async function (eleventyConfig: any) {
378378
const urlBase = this.page.filePathStem.startsWith("/understanding/")
379379
? ""
380380
: baseUrls.understanding;
381-
const label = `${guideline.num}: ${guideline.name}`;
381+
const label = `${guideline.num} ${guideline.name}`;
382382
return `<a href="${urlBase}${id}">${label}</a>`;
383383
})
384384
.join("\nand\n");

techniques/client-side-script/SCR29.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h2>Description</h2>
2121
<p>When the <code>tabindex</code> attribute has the value <code>0</code>, the element can be focused via the keyboard and is included in the tab order of the document. When the <code>tabindex</code> attribute has the value <code>-1</code>, the element cannot be tabbed to, but focus can be set programmatically, using <code>element.focus()</code>.</p>
2222
<p>Because static HTML elements do not have actions associated with them, it is not possible to provide a backup implementation or explanation in environments in which scripting is not available. This technique should only be used in environments in which client-side scripting can be relied upon.</p>
2323
<div class="note">
24-
<p>Such user interface controls must still satisfy Success Criterion 4.1.2. Applying this technique without also providing role, name, and state information about the user interface control will results in <a href="../failures/F59">Failure F59</a>, Failure of Success Criterion 4.1.2 due to using script to make <code>div</code> or <code>span</code> a user interface control in HTML.</p>
24+
<p>Such user interface controls must still satisfy Success Criterion 4.1.2 Name, Role, Value. Applying this technique without also providing role, name, and state information about the user interface control will results in <a href="../failures/F59">Failure F59</a>, Failure of Success Criterion 4.1.2 due to using script to make <code>div</code> or <code>span</code> a user interface control in HTML.</p>
2525
</div>
2626
</section>
2727
<section id="examples">

techniques/css/C30.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ <h2>When to Use</h2>
1818
<section id="description">
1919
<h2>Description</h2>
2020
<p>The objective of this technique is to demonstrate how CSS can be used to replace structured <abbr title="HyperText Markup Language">HTML</abbr> text with images of text in a way that makes it possible for users to view content according to their preferences. To use this technique, an author starts by creating an HTML page that uses semantic elements to mark up the structure of the page. The author then designs two or more stylesheets for that page. One stylesheet presents the HTML text as text and the second uses CSS features to replace some of the HTML text with images of text. Finally, through the use of server-side or client-side scripting, the author provides a control that allows the user to switch between the available views.</p>
21-
<p>This technique can be used to meet Success Criterion 1.4.5 or 1.4.9 if a presentation that does not include images of text is available and as long as the user interface control that is provided to allow users to switch to an alternate presentation meets the relevant criteria. Where possible, authors should deliver the presentation that does not include images of text as the default presentation. In addition, the control used to switch should be located near the beginning of the page.</p>
21+
<p>This technique can be used to meet Success Criterion 1.4.5 Images of Text or 1.4.9 Images of Text (No Exception) if a presentation that does not include images of text is available and as long as the user interface control that is provided to allow users to switch to an alternate presentation meets the relevant criteria. Where possible, authors should deliver the presentation that does not include images of text as the default presentation. In addition, the control used to switch should be located near the beginning of the page.</p>
2222
<p>A variety of "image replacement" techniques have been developed to address a variety of user agent, configuration and compatibility with assistive technology issues (See resources for more information). While there are a variety of approaches authors may use to replace text, it is important to consider compatibility with assistive technology, whether the technique will work correctly if scripting, CSS, images (or combinations of these) are turned off. Since it can be difficult to find a single solution that works in all cases, this technique recommends the use of a control that allows users to switch to a presentation that does not include an image replacement technique.</p>
2323
<div class="note">
2424
<p>This technique can be used in combination with a style switching technique to present a page that is a <a>conforming alternate version</a> for non-conforming content. Refer to <a href="C29">C29</a> and <a href="../../Understanding/conformance#conforming-alt-versions">Understanding Conforming Alternate Versions</a> for more information.</p>

techniques/failures/F103.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h2>Description</h2>
2929
<li>the new content does not take focus (does not change context);</li>
3030
<li>the new content provides information to the user on the outcome of an action, the state of an application, the progress of a process, or the existence of errors.</li>
3131
</ol>
32-
Where updated content does not conform to the definition of <a>status messages</a>, a failure of 4.1.3 has not taken place.</p>
32+
Where updated content does not conform to the definition of <a>status messages</a>, a failure of 4.1.3 Status Messages has not taken place.</p>
3333
<p>The second step in this failure technique involves examining code. Where dynamic content meets the definition of a status message, its container can be examined for an appropriate WAI-ARIA role or property which allows it to be programmatically determinable as a status message. Currently there are only a small number of techniques available to indicate status messages to assistive technologies. They are:
3434
<ul>
3535
<li>the HTML <code>output</code> element</li>

techniques/failures/F105.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h3>Expected Results</h3>
4949
<section id="related">
5050
<h2>Related Techniques</h2>
5151
<ul>
52-
<li><a href="F101">Failure of Success Criterion 2.5.2 due to activating a control on the down-event</a>.</li>
52+
<li><a href="F101">Failure of Success Criterion 2.5.2 Pointer Cancellation due to activating a control on the down-event</a>.</li>
5353
<li><a href="../general/G216">Providing single point activation for a control slider</a></li>
5454
</ul>
5555
</section>

techniques/failures/F107.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ <h2>Applicability</h2>
1919
<h2>Description</h2>
2020
<p>The purpose of this technique is to identify a failure condition where form inputs do not have the correct <code>autocomplete</code> attribute values for inputs that request information about the user of the form.</p>
2121

22-
<p>Success Criterion 1.3.5 uses a fixed list of tokens in <a href="/TR/WCAG/#input-purposes">Input Purposes for user interface components</a> (based on the HTML 5.2 <code>autocomplete</code> attribute's fixed list of token values) because the programmatic association of specified token values (metadata) allows for other machine processing, such as expressing the input label in different modalities.</p>
22+
<p>Success Criterion 1.3.5 Identify Input Purpose uses a fixed list of tokens in <a href="/TR/WCAG/#input-purposes">Input Purposes for user interface components</a> (based on the HTML 5.2 <code>autocomplete</code> attribute's fixed list of token values) because the programmatic association of specified token values (metadata) allows for other machine processing, such as expressing the input label in different modalities.</p>
2323

2424
<p>Another important part of this success criterion is that the token values are associated with inputs that are <strong>scoped directly to the primary end user</strong>.</p>
2525
</section>

techniques/failures/F109.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h1>Failure of Success Criterion 3.3.8 and 3.3.9 due to preventing password or c
2121
<section id="description">
2222
<h2>Description</h2>
2323

24-
<p>Requiring users to authenticate by entering a password or code in a different format from which it was originally created is a failure to meet Success Criteria 3.3.8 and 3.3.9 (unless alternative authentication methods are available). The string to be entered could include a password, verification code, or any string of characters the user has to remember or record to authenticate.</p>
24+
<p>Requiring users to authenticate by entering a password or code in a different format from which it was originally created is a failure to meet Success Criteria 3.3.8 Accessible Authentication (Minimum) and 3.3.9 Accessible Authentication (Enhanced) (unless alternative authentication methods are available). The string to be entered could include a password, verification code, or any string of characters the user has to remember or record to authenticate.</p>
2525

2626
<p>If a user is required to enter individual characters across multiple fields in a way that prevents pasting the password in a single action, it prevents use of a password manager or pasting from local copy of the password. This means users cannot avoid transcription, resulting in a <a>cognitive function test</a>. This applies irrespective of whether users are required to enter all characters in the string, or just a subset.</p>
2727

@@ -42,7 +42,7 @@ <h2>Examples</h2>
4242
<p>For each form field which accepts password or code entry:</p>
4343
<ol>
4444
<li>Check if the structure of the input field(s) prevents the user from pasting or auto-filling the entire password or code in the format in which it was originally created.</li>
45-
<li>Confirm that no other acceptable authentication methods are present that satisfy Success Criteria 3.3.8 or 3.3.9 (such as an authentication method that does not rely on a cognitive function test).</li>
45+
<li>Confirm that no other acceptable authentication methods are present that satisfy Success Criteria 3.3.8 Accessible Authentication (Minimum) or 3.3.9 Accessible Authentication (Enhanced) (such as an authentication method that does not rely on a cognitive function test).</li>
4646
</ol>
4747
</section>
4848
<section class="results"><h3>Expected Results</h3>

0 commit comments

Comments
 (0)