-
Notifications
You must be signed in to change notification settings - Fork 83
Rule 2ee8b8 ("Visible label is part of accessible name"): introducing a new "label in name algorithm". #2075
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
base: develop
Are you sure you want to change the base?
Changes from 6 commits
aeafb90
5a07973
a75c7f8
623d26e
f920a47
ee3e993
75a9878
81caf8a
2928be6
5cd8b2c
092c849
f499d04
473bcb8
5c7fc1e
3d3b657
8ed61b8
24d0ffc
46294dd
a141df8
5220766
b2df021
cde4ad4
83d0e10
5dce8e1
2cfe5f8
7cdf8c3
563ff5e
53fe350
821de81
f9e7272
ae2273a
d4f8076
2dcd941
09f668c
a37cfd3
22ad17b
2dc429f
2ab4489
db37b3b
7b2a053
9723ed1
4da5300
5617755
6be702c
0d4c543
a959b09
f1219c8
f9850c8
b77023c
1baf1ee
4afc39b
cd69eaf
9490a5e
8ea29b6
903ee9d
3818b0e
1565733
ec6a50f
268e5ae
bac2432
38f7d65
cf1e791
531bf52
1dc4453
60e5734
0b25658
07e2c27
99a88a6
b781366
774547e
a839498
3586285
84f2e2d
c01ccfa
fd8029c
b50d890
6816e7b
dd9d7f1
e0b890a
b9460bf
29e576b
5aa55e6
901e0d3
df65c5b
b2374d7
61d2d48
5d5e8bd
40525f4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -23,6 +23,7 @@ acknowledgments: | |
| authors: | ||
| - Anne Thyme Nørregaard | ||
| - Bryn Anderson | ||
| - Dan Tripp | ||
| - Jey Nandakumar | ||
| funding: | ||
| - WAI-Tools | ||
|
|
@@ -38,10 +39,14 @@ This rule applies to any element for which all the following is true: | |
|
|
||
| ## Expectation | ||
|
|
||
| For each target element, all [text nodes][] in the [visible text content][] either match or are contained within the [accessible name][] of this target element, except for characters in the [text nodes][] used to express [non-text content][]. Leading and trailing [whitespace][] and difference in case sensitivity should be ignored. | ||
| For each target element, the [visible inner text][] is contained within the [accessible name][] of the target element according to the [label in name algorithm][]. | ||
|
|
||
| ## Assumptions | ||
|
|
||
| This rule assumes that the [visible inner text][] is equal to the [label][https://www.w3.org/WAI/WCAG21/Understanding/label-in-name#dfn-label] in most cases (enough cases to be useful) even though "label" is not precisely defined at this point in history. | ||
|
|
||
| This rule assumes that neither the label nor the [visible inner text][] are rearranged with CSS in some way so that they appear to the user in a different order than they do in the DOM. | ||
|
|
||
| This rule assumes that all resources needed for rendering the page are properly loaded. Checking if resources are missing is out of the scope of rules. Missing resources may be rendered as text (for example, missing `img` are rendered as their `alt` attribute). | ||
|
|
||
| ## Accessibility Support | ||
|
|
@@ -54,6 +59,7 @@ This rule applies to elements with a [widget role][] that [support name from con | |
|
|
||
| The understanding document of [2.5.3 Label in Name][understand253] use the term "symbolic text characters" to refer to a type of [non-text content][] that uses text characters as symbols, such as using "x" to mean "close". This rule considers them as "characters expressing non-text content". Unicode emojis are another example of characters expressing non-text content, although these are not "symbolic text characters". | ||
|
|
||
|
|
||
| ### Bibliography | ||
|
|
||
| - [Understanding Success Criterion 2.5.3: Label in Name][understand253] | ||
|
|
@@ -65,39 +71,39 @@ The understanding document of [2.5.3 Label in Name][understand253] use the term | |
|
|
||
| #### Passed Example 1 | ||
|
|
||
| This link has [visible][] text that matches the [accessible name][]. | ||
| This link has [visible inner text][] that is equal to the [accessible name][]. | ||
|
|
||
| ```html | ||
| <a href="https://act-rules.github.io/" aria-label="ACT rules">ACT rules</a> | ||
| ``` | ||
|
|
||
| #### Passed Example 2 | ||
|
|
||
| This link has [visible][] text that, ignoring trailing whitespace, matches the [accessible name][]. | ||
| This link has [visible inner text][] that, ignoring whitespace, is equal to the [accessible name][]. | ||
|
|
||
| ```html | ||
| <a href="https://act-rules.github.io/" aria-label=" ACT rules ">ACT rules</a> | ||
| <a href="https://act-rules.github.io/" aria-label=" ACT rules ">ACT rules</a> | ||
| ``` | ||
|
|
||
| #### Passed Example 3 | ||
|
|
||
| This link has [visible][] text that, ignoring case, matches the [accessible name][]. | ||
| This link has [visible inner text][] that, ignoring case, is equal to the [accessible name][]. | ||
|
|
||
| ```html | ||
| <a href="https://act-rules.github.io/" aria-label="act rules">ACT rules</a> | ||
| <a href="https://act-rules.github.io/" aria-label="act Rules">ACT rules</a> | ||
| ``` | ||
|
|
||
| #### Passed Example 4 | ||
|
|
||
| This button has [visible][] text that is contained within the [accessible name][]. | ||
| This button has [visible inner text][] that is contained within the [accessible name][] according to the [label in name algorithm][]. | ||
|
|
||
| ```html | ||
| <button aria-label="Next Page in the list">Next Page</button> | ||
| ``` | ||
|
|
||
| #### Passed Example 5 | ||
|
|
||
| This button has [visible][] text that does not need to be contained within the [accessible name][], because the "x" text node is [non-text content][]. | ||
| The "X" is [non-text content][], so it doesn't need to be contained within the [accessible name][]. | ||
|
|
||
| ```html | ||
| <button aria-label="close">X</button> | ||
|
|
@@ -117,45 +123,242 @@ This `button` element has the text "search" rendered as an magnifying glass icon | |
| <button aria-label="Find">search</button> | ||
| ``` | ||
|
|
||
| #### Passed Example 7 | ||
|
|
||
| This button has [visible inner text][] that, according to the [label in name algorithm][], is contained within the [accessible name][]. This example shows why the [label in name algorithm][] uses the [visible inner text][] and not the [visible text content][]: the <p> tags insert whitespace into the result in the former but not the latter. | ||
|
|
||
| ```html | ||
| <button aria-label="Hello world"><p>Hello</p><p>world</p></button> | ||
| ``` | ||
|
|
||
| #### Passed Example 8 | ||
|
|
||
| Similar to the previous example. | ||
|
|
||
| ```html | ||
| <a href="#" aria-label="Some article by John Doe"><h6>Some article</h6><p>by John Doe</p></a> | ||
| ``` | ||
|
|
||
| #### Passed Example 9 | ||
|
|
||
| The [visible inner text][] is "Download specification". The words "the" and "gizmo" aren't part of it. | ||
|
|
||
| ```html | ||
| <a aria-label="Download specification" href="#">Download <span style="visibility: hidden">the</span> <span style="display: none">gizmo</span> specification</a> | ||
| ``` | ||
|
|
||
| #### Passed Example 10 | ||
|
|
||
| This example shows that the [visible inner text][] isn't always the same as the [innerText][https://html.spec.whatwg.org/multipage/dom.html#the-innertext-idl-attribute]. The visible inner text is "Download specification". The innerText is 'Download \ngizmo\nspecification'. This rule uses the visible inner text - not innerText. | ||
|
|
||
| ```html | ||
| <style> | ||
| .visually-hidden { | ||
| /* Source: https://www.tpgi.com/the-anatomy-of-visually-hidden/ */ | ||
| clip-path: inset(50%); | ||
| height: 1px; | ||
| overflow: hidden; | ||
| position: absolute; | ||
| white-space: nowrap; | ||
| width: 1px; | ||
| } | ||
| </style> | ||
| <a aria-label="Download specification" href="#">Download <span class="visually-hidden">gizmo</span> specification</a> | ||
| ``` | ||
|
|
||
| #### Passed Example 11 | ||
|
|
||
| This example shows that the [label in name algorithm][] handles many kinds of whitespace. | ||
|
|
||
| ```html | ||
| <a aria-label="compose email" href="#">compose <br> email</a> | ||
| ``` | ||
|
|
||
| #### Passed Example 12 | ||
|
|
||
| This example passes the rule because "YYYY-MM-DD" is in brackets. Text in brackets is removed by the [label in name algorithm][], because its not normally spoken by speech-input users. | ||
|
|
||
| ```html | ||
| <button aria-label="Search by date">Search by date (YYYY-MM-DD)</button> | ||
| ``` | ||
|
|
||
| #### Passed Example 13 | ||
|
|
||
| The passes for two reasons: 1) because the ellipsis ("…") is [non-text content][], and 2) because the ellipsis is neither a letter nor a digit and so is filtered out by the [label in name algorithm][]. | ||
|
|
||
| ```html | ||
| <button aria-label="Next">Next…</button> | ||
| ``` | ||
|
|
||
| #### Passed Example 14 | ||
|
|
||
| This passes because the [label in name algorithm][] effectively ignores all punctuation and emoji, in both the visible inner text and the accessible name, as long as they don't break up words. | ||
|
|
||
| ```html | ||
| <button aria-label="💡 Submit 💡">>>> ** Submit ** <<<</button> | ||
| ``` | ||
|
|
||
| #### Passed Example 15 | ||
|
|
||
| The "X" is non-text content. | ||
|
|
||
| ```html | ||
| <button aria-label="Close">X</button> | ||
| ``` | ||
|
dan-tripp-siteimprove marked this conversation as resolved.
|
||
|
|
||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think adding the "First Name:" pass example from the Understanding document would be useful (since it's very common).
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It's a strong example for the SC, but I can't see how to adapt it to this ACT rule. That example ( |
||
|
|
||
|
|
||
| ### Failed | ||
|
|
||
| #### Failed Example 1 | ||
|
|
||
| This link has [visible][] text that is different from the [accessible name][]. | ||
| This link has [visible inner text][] that is very different from the [accessible name][]. | ||
|
|
||
| ```html | ||
| <a href="https://act-rules.github.io/" aria-label="WCAG">ACT rules</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 2 | ||
|
|
||
| This button has [visible][] text that is only partially contained within the [accessible name][]. | ||
| This button has [visible inner text][] that is only partially contained within the [accessible name][]. | ||
|
|
||
| ```html | ||
| <button aria-label="the full">The full label</button> | ||
| ``` | ||
|
|
||
| #### Failed Example 3 | ||
| #### Failed Example 3 | ||
|
|
||
| This button has [visible inner text][] that is fully contained within the [accessible name][] when viewed as a character-by-character substring. But that does not satisfy our [label in name algorithm][], which works on full words. So this fails the rule. | ||
|
|
||
| ```html | ||
| <a href="#" aria-label="Discover Italy">Discover It</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 4 | ||
|
|
||
| This link's [accessible name][] contains two tokens (according to the[label in name algorithm][]) and the [visible inner text][] contains one token. So it fails the rule. | ||
|
|
||
| ```html | ||
| <a aria-label="just ice" href="#">justice</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 5 | ||
|
|
||
| This link has an [accessible name][] which contains a hyphen. The [label in name algorithm][] breaks up words on hyphens. So it turns "non-standard" into two tokens: "non" and "standard". So this fails the rule. | ||
|
|
||
| ```html | ||
| <a href="#" aria-label="non-standard">nonstandard</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 6 | ||
|
|
||
| The rule has no special handling for acronyms or initialisms. | ||
|
|
||
| ```html | ||
| <a aria-label="WAVE" href="#">W A V E</a> | ||
|
dan-tripp-siteimprove marked this conversation as resolved.
Outdated
|
||
| ``` | ||
|
|
||
| #### Failed Example 7 | ||
|
|
||
| The rule has no special handling for abbreviations. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This seems problematic. For many abbreviations it is much more natural (in English) to say the full word when encountering an abbreviations (for example, abbreviations in an address like "Rd.", "St.", "Pl.", etc). Perhaps it is just another shortcoming of this SC, but the calculation seems to me to need to be more fuzzy, and bias towards passing, not failing an abbreviation construct.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Again, I agree, but I consider this problem to be in the category of problems that this PR didn't create and didn't make worse. What do you think? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I guess two points. The SC wording is: "the name contains the text that is presented visually." We already have a rule stating that punctuation can be disregarded, so in this example, the displayed wording can be interpreted as "University Ave" and the name is "University Avenue". The accessible name literally contains the text that is presented visually (plus three more characters). So why is it a fail? It should be a pass, no? The second point is just about abbreviations as synonyms. I can think of situations in English where it would be unusual to say only the abbreviation. For instance, if someone sees "Main St." or "First Rd.", they are going to say the abbreviation as the full word ("main street", "first road"). On the other hand "Ave" may be spoken as the full word or as the abbreviation. Part of me believes it is reasonable to compile a set of abbreviations which are commonly spoken as the full word, and not the abbreviation. But that seems unsustainable/unscalable. On consideration, I reluctantly agree that failing a mismatch where the name does not contain all the characters of the displayed abbreviation (less punctuation) makes sense.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For future reference, if nothing else: here are some supporting arguments for failing abbreviations, from WCAG. These are independent of arguments about user impact. This is just about the letter of the law.
1 says "exact string" and 3 says "string exactly". That doesn't allow an abbreviation to pass.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. While it's a good aspect to be thinking about, I don't agree that this is a problem for this test. From my experience (anecdotal of course) AT users want to have access to the same information as it is presented visually. In what cases would a non-sighted user need to have something fully spelled out and a sighted one wouldn't? While it's less severe of an impact, it's still impactful and should fail this test.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Point taken, but I've since side-stepped this by making anything with abbreviations inapplicable (inspired by per Giacomo's suggestion on Thursday). I did this in commit 9490a5e . |
||
|
|
||
| ```html | ||
| <a aria-label="University Avenue" href="#">University Ave.</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 8 | ||
|
|
||
| This link has [visible][] text with mathematical symbols, that does not match the [accessible name][] because the mathematical symbols were written out in the accessible name. This is [explicitly mentioned in WCAG](https://www.w3.org/WAI/WCAG21/Understanding/label-in-name#mathematical-expressions-and-formulae). | ||
| This link has [visible inner text][] with mathematical symbols and is not contained within the [accessible name][] because the mathematical symbols are represented as English words (not digits) in the accessible name. This is [explicitly mentioned in WCAG](https://www.w3.org/WAI/WCAG21/Understanding/label-in-name#mathematical-expressions-and-formulae). | ||
|
|
||
| ```html | ||
| <a href="/" aria-label="Proof of two multiplied by two is four">Proof of 2×2=4</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 9 | ||
|
|
||
| Similar to the previous example. This rule has no special handling for converting mathematical symbols into words, or vice versa. | ||
|
|
||
| ```html | ||
| <button aria-label="11 times 3 equals 33">11×3=33</button> | ||
| ``` | ||
|
|
||
| #### Failed Example 10 | ||
|
|
||
| This button's accessible name contains the same tokens that are in the visible label. But they aren't in the same order, so it fails the sublist check part of the [label in name algorithm][], and so it fails the rule. | ||
|
|
||
| ```html | ||
| <button aria-label="how are you"><span>you</span><span>how</span><span>are</span></button> | ||
| ``` | ||
|
|
||
| #### Failed Example 11 | ||
|
|
||
| This link's accessible name contains the same digits that are in the visible label, and in the same order. But they have different spaces and punctuation between them, so they are considered separate tokens. So this fails the rule. | ||
|
|
||
| ```html | ||
| <a aria-label="Call 1 2 3. 4 5 6. 7 8 9 0." href="tel:1234567890">123.456.7890</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 12 | ||
|
|
||
| This rule has no special handling which tries to guess when number have the same semantic meaning. It operates on tokens only. | ||
|
|
||
| ```html | ||
| <a href="#2021" aria-label="20 21">2021</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 13 | ||
|
|
||
| Similar to the previous example. | ||
|
dan-tripp-siteimprove marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```html | ||
| <a aria-label="fibonacci: 0 1 1 2 3 5 8 13 21 34">fibonacci: 0112358132134</a> | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Issue: The |
||
| ``` | ||
|
|
||
| #### Failed Example 14 | ||
|
|
||
| This rule has no special handling for converting digits into words, or vice versa. | ||
|
|
||
| ```html | ||
| <a href="#2021" aria-label="twenty twenty-one">two thousand twenty-one</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 15 | ||
|
|
||
| (Same as above.) This rule has no special handling for converting digits into words, or vice versa. | ||
|
|
||
| ```html | ||
| <a aria-label="two zero two three" href="#">2 0 2 3</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 16 | ||
|
|
||
| This rule has no special handling for digits that appear next to letters with no spaces in between. | ||
|
|
||
| ```html | ||
| <a aria-label="1a" href="#">1</a> | ||
| ``` | ||
|
|
||
| #### Failed Example 17 | ||
|
|
||
| The definition of [visible inner text][] doesn't treat text any differently if it's excluded from the accessibility tree with aria-hidden. So this rule effectively ignores aria-hidden. So this element fails the rule. | ||
|
|
||
| ```html | ||
| <a aria-label="Download specification" href="#">Download <span aria-hidden="true">gizmo</span> specification</a> | ||
| ``` | ||
|
|
||
| ### Inapplicable | ||
|
|
||
| #### Inapplicable Example 1 | ||
|
|
||
| This `nav` is not a widget, so the [visible][] text does not need to match the [accessible name][]. | ||
| This `nav` is not a widget, so the [visible inner text][] does not need to match the [accessible name][]. | ||
|
|
||
| ```html | ||
| <nav aria-label="main nav">W3C navigation</nav> | ||
| ``` | ||
|
|
||
| #### Inapplicable Example 2 | ||
|
|
||
| This email text field does not need to have its [visible][] text match the [accessible name][]. The content of a textfield shows its value instead of its label; it does not [support name from content][supports name from content]. The label is usually adjacent to the textfield instead. | ||
| This email text field does not need to have its [visible inner text][] match the [accessible name][]. The content of a textfield shows its value instead of its label; it does not [support name from content][supports name from content]. The label is usually adjacent to the textfield instead. | ||
|
|
||
| ```html | ||
| <div>E-mail</div> | ||
|
|
@@ -164,15 +367,15 @@ This email text field does not need to have its [visible][] text match the [acce | |
|
|
||
| #### Inapplicable Example 3 | ||
|
|
||
| This `div` element does not have a widget role, so the [visible][] text does not need to match the [accessible name][]. | ||
| This `div` element does not have a widget role, so the [visible inner text][]t does not need to match the [accessible name][]. | ||
|
|
||
| ```html | ||
| <div role="tooltip" aria-label="OK">Next</div> | ||
| ``` | ||
|
|
||
| #### Inapplicable Example 4 | ||
|
|
||
| This link has no [visible text content][]. | ||
| This link has no [visible inner text][]. | ||
|
|
||
| ```html | ||
| <a href="https://w3.org" aria-label="W3C homepage"> | ||
|
|
@@ -186,6 +389,7 @@ This link has no [visible text content][]. | |
| [semantic role]: #semantic-role 'Definition of Semantic role' | ||
| [supports name from content]: https://www.w3.org/TR/wai-aria-1.1/#namefromcontent 'Definition of Supports name from contents' | ||
| [visible]: #visible 'Definition of visible' | ||
| [visible inner text]: #visible-inner-text 'Definition of Visible inner text' | ||
| [visible text content]: #visible-text-content 'Definition of Visible text content' | ||
| [whitespace]: #whitespace 'Definition of Whitespace' | ||
| [widget role]: https://www.w3.org/TR/wai-aria-1.1/#widget_roles 'Definition of Widget role' | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,34 @@ | ||||||
| --- | ||||||
| title: Label in Name Algorithm | ||||||
| key: label-in-name-algorithm | ||||||
| unambiguous: true | ||||||
| objective: false | ||||||
| input_aspects: | ||||||
| - CSS styling | ||||||
| - DOM tree | ||||||
| --- | ||||||
|
|
||||||
|
dan-tripp-siteimprove marked this conversation as resolved.
|
||||||
| Let 'label' be the [visible inner text][] of the target element. Let 'name' be the [accessible name][] of the target element. Both 'label' and 'name' are strings. | ||||||
|
dan-tripp-siteimprove marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| Sub-algorithm to tokenize a string: | ||||||
|
kengdoj marked this conversation as resolved.
|
||||||
|
|
||||||
| - Convert the string to lower case. | ||||||
| - For each character that either a) represents non-text content, or b) isn't a letter or a digit: replace that character with a space character. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this can cause false positives with words that are not consistently hyphenated. For example: 'antimatter' vs 'anti-matter' (the Wikipedia antimatter article uses both)
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right, and I assume the voice control software would handle it fine, but if it was a customer who was arguing this, I would say "too bad" (diplomatically, of course). This is part of a larger issue that I call "you need to play ball with the automated check". I run into customer arguments like this often enough that I have a "canned response" it. It reads, in part: "It's not feasible for an automated checker to know any better in this situation. When you use an automated checker instead of a manual audit, in order to gain efficiency, you lose accuracy. This is an unavoidable example of that." For the page author to "play ball" for "label in name" would be easy: use the same spelling, including hyphenation, in the aria-label that they used in the visible label. This is, I think, not a lot to ask of a page author. I could add an assumption to the rule. Something along the lines of "This rule assumes that for any word (including any hyphenated word) that appears in both the accessible name and the visible label, the same spelling and hyphenation is used in both places. For example, using 'antimatter' in the accessible name and 'anti-matter' in the visible label would fail this rule, but arguably pass the Success Criterion.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bearing in mind this is for voice control, would a voice control user pronounce the hyphenated and non-hyphenated versions differently? Personally, I would pronounce both versions identically: 'antimatter' vs 'anti-matter' and sometimes it's context specific: '1-2' might be pronounced as 'one two' in a sports context, but as 'one minus two' in a maths context/ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
It's worth noting that Dragon voice recognition software only recognises and responds to words that are in its dictionary. For instance, if the accessible name is 'nonnegative', nothing you say will cause Dragon to interact with it if 'nonnegative' is not in its dictionary. If the accessible name is 'non negative', you could say either or both words because both will be in the dictionary. I suspect the same would be the case with 'non-negative', but I may be wrong.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I interpret this Dragon behaviour as causing an accessibility failure in some cases that this rule passed. I don't think it's practical for this rule to contain Dragon's dictionary and keep it up to date. But I think it indicates an opportunity for a vendor to do it, and thereby excel. |
||||||
| - For a) Judgement of "non-text" probably can't be fully automated. eg. "X" for "close" probably can be, but presumably there are more cases than this. | ||||||
| - For b) Use the unicode classes Letter, Mark, and "Number, Decimal Digit [Nd]". (This will exclude hyphens, punctuation, emoji, and more.) | ||||||
| - Remove all characters that are within parentheses (AKA round brackets). | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Parenthesis mean something very different in German, so maybe shouldn't be removed in German text: And in Arabic parenthesis are often uses as quote marks: In accounting, numbers in round brackets are negative - typically losses or debts - so these are really important.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That was educational. I admit that this PR will not handle those cases well. But at least it will handle them as "false negatives", which are inevitable in ACT rules. I think that this concern - and all of your concerns here - are valuable, but I don't think that this PR can reasonably be expected to handle them all. This PR "closes" 5 issues, explicitly "does not handle" 3 more, and (I think) doesn't do any harm. I'd like to improve the rule a little, then take it from there. This PR has been open for 10 months. "Perfect is the enemy of good" and all that.
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Given that we know this is an issue, I think it should be included some how as a note that it may result in false negatives in these situations. Particularly since we are already recognising i18n differences in the whitespace splitting part of this algorithm. |
||||||
| - Ignore square brackets and braces. | ||||||
| - Split the string into a list of strings, using a whitespace regular expression as the separator. | ||||||
| - This 'split' operation must: | ||||||
| - Effectively remove leading and trailing whitespace as a pre-processing step. | ||||||
| - If the string was all whitespace before this operation: result in an empty list. | ||||||
|
|
||||||
| Then do the check: is the tokenized 'label' a sublist of the tokenized 'name'? | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - This 'sublist' check has these properties: | ||||||
| - It checks whether elements are consecutive or not. i.e. it checks for a substring, in the computer science sense of the term. Not a subsequence. | ||||||
| - An empty list is a sublist of any list. | ||||||
|
|
||||||
| If the answer is "yes" (i.e. the tokenized 'label' a sublist of the tokenized 'name'), then the target element passes the rule. Otherwise, it fails the rule. | ||||||
|
dan-tripp-siteimprove marked this conversation as resolved.
Outdated
|
||||||
|
|
||||||
| [accessible name]: #accessible-name 'Definition of accessible name' | ||||||
| [visible inner text]: #visible-inner-text 'Definition of Visible inner text' | ||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Referencing "previous example" is a bit risky since nothing guarantees they will stay in the same order next time we rewrite the rule.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree there is a risk. In this case I think that the risk is worth it. With "previous", I claim that the readability is improved now. If I remove "previous", I can't think of a way to rewrite it that doesn't make it significantly less readable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe include additional description, like: