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.

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

Rewrite for 3.3.1 Error Identification understanding document #1651

Merged
merged 27 commits into from
May 14, 2024
Merged
Changes from 6 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
1d8a008
Rewrite for 3.3.1 Error Identification understanding document
patrickhlauke Feb 23, 2021
d6086ef
Remove unnecessary WCAG 2.0 reference, add note about scope of the SC
patrickhlauke Feb 23, 2021
82dd96b
Remove redundant reference to 3.3.3, add reference to 4.1.2
patrickhlauke Feb 23, 2021
b67a1bd
Tweak intent wording around the "should" to more closely match normat…
patrickhlauke Feb 23, 2021
8af0fce
Add 1.3.1 reference for programmatic linking of errors and their form…
patrickhlauke May 2, 2021
85bf19a
Reintroduce the "as specific as possible" wording.
patrickhlauke Jun 2, 2021
6880cf0
Copy tweaks (incorrect sentence, missing "to", too many commas)
patrickhlauke Jun 2, 2021
5920a57
Meeting updates
alastc Jun 8, 2021
a92819a
Merge branch 'patrickhlauke-issue977' of https://github.com/w3c/wcag …
alastc Jun 8, 2021
8db6f26
Replace "alt text" with cleaner/more explicit phrasing
patrickhlauke Jun 8, 2021
2edf2cc
should to must
alastc Jun 9, 2021
300f609
Merge branch 'patrickhlauke-issue977' of https://github.com/w3c/wcag …
alastc Jun 9, 2021
24e544b
Linking to the definition of 'text'
alastc Jun 10, 2021
9f391c6
Updates from survey comments
alastc Jun 10, 2021
6461d43
Updates from survey and github thread.
alastc Jun 10, 2021
fc369e2
Removing link to glossary.
alastc Jun 22, 2021
7bebe1b
Update error-identification.html
mbgower Apr 18, 2022
385e335
Update understanding/20/error-identification.html
patrickhlauke Apr 20, 2022
f128bca
Merge branch 'main' into patrickhlauke-issue977
patrickhlauke Aug 9, 2022
a410ff3
Update understanding/20/error-identification.html
patrickhlauke Mar 9, 2024
06de2ca
Merge branch 'main' into patrickhlauke-issue977
patrickhlauke Mar 9, 2024
2caac67
Clarify where the "descriptiveness" or error messages is covered (3.3.3)
patrickhlauke Apr 28, 2024
10eb039
Merge branch 'main' into patrickhlauke-issue977
patrickhlauke Apr 28, 2024
bf11368
Cleanup
patrickhlauke Apr 28, 2024
e063d48
Update understanding/20/error-identification.html
patrickhlauke Apr 29, 2024
f2805f6
Update understanding/20/error-identification.html
patrickhlauke May 9, 2024
0bdb0dc
Update understanding/20/error-identification.html
patrickhlauke May 9, 2024
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
65 changes: 38 additions & 27 deletions understanding/20/error-identification.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@ <h2>Intent of Error Identification</h2>


<p>The intent of this Success Criterion is to ensure that users are aware that an error
has occurred and can determine what is wrong. The error message should be as specific
as possible.
In the case of an unsuccessful form submission, re-displaying the form and indicating
the fields in error is insufficient for some users to perceive that an error has occurred.
Screen reader users, for example, will not know there was an error until they encounter
one of the indicators. They may abandon the form altogether before encountering the
error indicator, thinking that the page simply is not functional. Per the definition in WCAG 2.0, an "input error" is information provided by the user
that is not accepted. This includes:
has occurred and can determine what is wrong. In the case of an unsuccessful form submission,
it is not sufficient to only re-display the form without providing any hint that the submission
failed. It also won't be sufficient to merely indicate that fields are in error, but not providing
users with sufficient information about the specific nature of the error. The error messages should
be descriptive, helping users understand what the problem was.
</p>
<p>An "input error" is information provided by the user that is not accepted. This includes:
patrickhlauke marked this conversation as resolved.
Show resolved Hide resolved
</p>

<ul>
Expand Down Expand Up @@ -62,8 +61,7 @@ <h2>Intent of Error Identification</h2>
changes that value to fall within the allowed range, the user's error would still
need to be described to them as required by the success criterion. Such an error description
telling the person of the changed value would meet both this success criterion (Error
Identification) and
<a href="error-suggestion" class="understanding">Success Criterion 3.3.3 (Error Suggestion)</a>.
Identification) and <a href="error-suggestion">3.3.3 Error Suggestion</a>.
</p>

</div>
Expand All @@ -72,20 +70,36 @@ <h2>Intent of Error Identification</h2>
that user agents or assistive technologies can use to identify an error and provide
error information to the user. For example, certain technologies can specify that
the user's input must not fall outside a specific range, or that a form field is required.
Currently, few technologies support this kind of programmatic information, but the
Success Criterion does not require, nor prevent it.

Currently, few technologies support this kind of programmatic information, but this
Success Criterion does not require, nor prevent it. However, other Success Criteria may apply - for
instance, the programmatic identification of form controls/inputs that are in error is covered
more specifically in <a href="name=role-value">4.1.2 Name, Role, Value</a>, and whether or not
error messages are programmatically linked to their respective form controls/inputs is covered
by <a href="info-and-relationships">1.3.1 Info and Relationships</a>.
</p>

<p>It is perfectly acceptable to indicate the error in other ways such as image, color
etc, in addition to the text description.

etc, in addition to the text description.
</p>

<p>See also
<a href="error-suggestion">3.3.1: Error Suggestion</a>.
<p>There may also be situations in which it is clear from the context what the specific error
is - for instance, in a simple login form with a username and password field, if a user
leaves one of the fields completely blank, simply indicating that the empty field is in
error using an image or icon (with appropriate alternative text) would be sufficient.
However, if the user did enter data in both of those fields, and login was unsuccessful, further
information and an actual specific error message will be required (e.g. "no account found with this
username", or "the username or password are incorrect"). Likewise, in a form that explicitly indicates
that all fields are mandatory/required, it will be sufficient to indicate empty fields as being in error,
without the need to reiterate that the user must fill in the field.
</p>

<div class="note">
<p>This criterion does not mandate any particular way in which errors should be displayed. Depending
on the situation, it may be more suitable for all errors to be listed at the start, or before, a form.
In other cases, it may be more appropriate to show errors inline, with error messages next the specific
fields that are in error. Errors could also be listed in an alert, or dialog. This criterion does not
cover which of these methods should be used - the only requirement is for errors (which are not already
clear from the specific nature/context of the input fields) to be presented to users in text or alt text.
patrickhlauke marked this conversation as resolved.
Show resolved Hide resolved
</p>
</div>

</section>
<section id="benefits">
Expand All @@ -94,16 +108,14 @@ <h2>Benefits of Error Identification</h2>

<ul>

<li> Providing information about input errors in text allows users who are blind or colorblind
to perceive the fact that an error occurred.
<li>
Providing information about input errors in text allows users who are blind or colorblind to perceive the fact that an error occurred.
</li>

<li>
This Success Criterion may help people with cognitive, language, and learning disabilities
who have difficulty understanding the meaning represented by icons and other visual
cues.


who have difficulty understanding the specific reason why a form submission failed (in cases
where this is not already made obvious by the nature of the form).
</li>

</ul>
Expand Down Expand Up @@ -137,8 +149,7 @@ <h2>Examples of Error Identification</h2>
<div class="note">

<p>This Success Criterion does not mean that color or text styles cannot be used to indicate
errors. It simply requires that errors also be identified using text. In this example,
two asterisks are used in addition to color.
errors. It simply requires that errors also be identified using text.
</p>

</div>
Expand Down