SC1-1-1-filename-is-valid-accessible-name #263

Brynanders · 2018-09-18T11:41:55Z

<< Describe the changes >>

Closes issue: #216

Guidance for the PR (pull request) creator

When creating PR:

Make sure you requesting to pull a issue/feature/bugfix branch (right side) to the master branch (left side).

After creating PR:

Add yourself (and co-authors) as "Assignees" for PR
Add label to indicate if it's a Rule, Definition or Chore (more to the administrative side)
Add relevant project (e.g. "Q3 2018 Status") to PR
OPTIONAL: If you want anyone in particular to review your pull request, assign them as "Reviewers".
Close the issue that the PR resolves (and make sure the issue is referenced in the top of this comment)

How to Review And Approve

Go to the “Files changed” tab
Here you will have the option to leave comments on different lines.
Once the review is completed, find the “Review changes” button in the top right, select “Approve” (if you are really confident in the rule) or "Request changes" and click “Submit review”.

_rules/SC1-1-1-accessible-name-is-image-file-name.md

nitedog

Need to resolve the filename referencing issue.

Simplified applicability Changed 1st inapplicable test case. Added 2nd inapplicable test case

updated applicability

Updated title and description to target `alt` instead of accessible name

nitedog · 2018-09-27T08:43:41Z

I don't have data to agree or disagree with that but it seems to me that if authoring tools will rarely use other approaches, like aria-label, then the noise ration will hardly increase. But again, others may have better insights on how often this occurs. In any case, if we do limit this, we should state why in a note or in the assumptions section.

WilcoFiers · 2018-09-27T10:04:23Z

_rules/SC1-1-1-accessible-name-is-image-file-name.md

+---
+name: image accessible name contains image file name
+description: |
+  This rule checks that the use of an image's file name in it's accessible name, is appropriate.


I suggest we put something about authoring tools in the description. Make it clear why this is a thing.

_rules/SC1-1-1-accessible-name-is-image-file-name.md

WilcoFiers · 2018-09-27T10:14:22Z

_rules/SC1-1-1-accessible-name-is-image-file-name.md

+The rule applies to any HTML `img` element that is exposed to assistive technologies, where the accessible name of the element contains the file name specified in the `src` attribute of the element.
+
+### Expectation
+Each test target has an accessible name that serves as an appropriate text alternative as described in [F30: Failure of Success Criterion 1.1.1 and 1.2.1 due to using text alternatives that are not alternatives (e.g., filenames or placeholder text)](https://www.w3.org/TR/WCAG20-TECHS/F30.html).


I'm unsure if linking to outside tests is allowed in ACT RF. I suggest we make whatever part we want from F30 part of this expectation, rather than us referencing a document that can change at any time.

_rules/SC1-1-1-accessible-name-is-image-file-name.md

Brynanders · 2018-09-27T14:22:49Z

@WilcoFiers thanks for your comments and reviews - before I change the rule drastically again I want to get some consensus on targeting alt attributes vs accessible names in general.

@nitedog, @WilcoFiers and @kasperisager if we are going to match exact file names e.g. "example.jpg" instead of "example" or ".jpg" then what would be the harm in including other accessible names for img elements? I hear what you are saying Wilco that authoring tools do not typically populate aria-label for example but so what... if they don't then great, no extra noise, if they do at some stage then great, we catch the issue, it seems like win win to me.

Based on this I propose we target HTML elements with the semantic role of img where the accessible name exactly matches the image file name (with an example), or the image scr attribute value.

Any objections?

ShadowBB

Fixed some spelling mistakes. Approved apart from that.

goetsu · 2019-02-25T13:33:42Z

Image a situation where user can download multiple format of the same image

<button><img src="/image.jpg" alt="image.jpg file"></button>
<button><img src="/image.gif" alt="image.gif file"></button>
<button><img src="/image.png" alt="image.png file"></button>

In that case I think using filename is compliant with 1.1 and must not be marked as a failure so this test can be completely automated

Brynanders · 2019-02-26T10:19:27Z

Corb O'Connor comments in the CFC email chain:

This looks great; thanks for your hard work on this. Am I understanding correctly that the rule requires the extension to be part of the filename? Imagine I have a picture of Barack Obama, saved as “Barack Obama.jpg” but set the ALT to the filename minus the extension, then this rule would not fail…right? Assuming so, then I have no comments!

Brynanders · 2019-02-26T10:29:10Z

Image a situation where user can download multiple format of the same image
<button><img src="/image.jpg" alt="image.jpg file"></button>
<button><img src="/image.gif" alt="image.gif file"></button>
<button><img src="/image.png" alt="image.png file"></button>
In that case I think using filename is compliant with 1.1 and must not be marked as a failure so this test can be completely automated

@goetsu thanks for your comment.

Your example would not be marked as a failure with this check because the alt "serves an equivalent purpose to the non-text content".

You could write a rule that looks for that exact scenario and fully automate it but I don't think that building rules for a single purpose would be the most efficient approach.

Brynanders · 2019-02-26T10:37:39Z

Corb O'Connor comments in the CFC email chain:

This looks great; thanks for your hard work on this. Am I understanding correctly that the rule requires the extension to be part of the filename? Imagine I have a picture of Barack Obama, saved as “Barack Obama.jpg” but set the ALT to the filename minus the extension, then this rule would not fail…right? Assuming so, then I have no comments!

In this instance, the accessible name of "Barack Obama" does not include the file extension which is part of the filename specified in the src attribute so it would be considered inapplicable and not be flagged.

EmmaJP · 2019-02-26T11:16:19Z

pages/glossary/decorative.md

-Serving only an aesthetic purpose, providing no information, and having no functionality.
+Serving only an aesthetic purpose, providing no information, and having no functionality. 
+
+**Note:** Authors can mark an `img` element as decorative to indicate that it should be ignored by assistive technology by using either `role="presentation"`, `role="none"`, or `alt=""`. An element should only be marked as decorative if removing the element does not cause a loss of information to the user.


Are there any elements other than 'img' that could be marked as decorative, such as 'svg'?

The context of this rule is img so the note addresses that specifically and not other elements.

I could change this to say "Authors can mark elements as decorative..." if you think that would make more sense?

EmmaJP

OK with this apart from my question on the 'decorative' definition. Seems very thorough.

carlosapaduarte

Some editorial issues yet, but rule is looking good

_rules/SC1-1-1-accessible-name-is-image-filename.md

Minor editorial edit.

Minor template edits

WilcoFiers

Thank you for putting this in the CFC. I'm afraid I found some problems with the way this is done. I don't think your test cases are actually applicable. It seems to me the applicability is missing some of its key parts.

WilcoFiers · 2019-03-02T19:41:46Z

_rules/SC1-1-1-accessible-name-is-image-filename.md

+
+## Test Cases
+
+### Passed


It doesn't seem like any of the passed / failed examples would be applicable. The applicability doesn't say to ignore file extensions or its file path.

@WilcoFiers the applicability refers to a definition of "filename" https://github.com/auto-wcag/auto-wcag/blob/master/pages/glossary/filename.md which excludes the file path and appended query strings.

@WilcoFiers @kasperisager and I have reworked some of the test cases to fit the applicability. Please can you give this another look.

Updated test cases

annethyme · 2019-03-20T12:25:42Z

@Brynanders, I think that since Carlos' permissions changed the other day, the status of this PR is now "changes requested" instead of "approved". I think you will have to dismiss Carlos' (old) review to get things back in order.

Updated

annethyme · 2019-03-22T10:13:27Z

@Brynanders, @JKODU, @WilcoFiers, can this one be merged?
It has survived its two-week CF.

* master: Rule update: "HTML page has a title" (#440) Rule update: "aria attribute allowed" and "aria required states and properties" (#436) Changed succescriteria from 4.1.2 to 1.3.1 (#449) Rename SC1-2-Video-description-track.md to SC1-2-video-description-track.md Glossary: add "Accessibility Support" to "Semantic role" term (#442) SC1-1-1-filename-is-valid-accessible-name (#263) Added assumption for SC3-1-2-lang-valid (#413) Update SC4-1-1-unique-id.md fix: update applicability fix: revert definitions fix: update glossary fix: applicability

Create SC1-1-1-accessible-name-is-image-file-name.md

25116ec

Brynanders added reviewer wanted Rule Use this label for a new rule that does not exist already labels Sep 18, 2018

Brynanders self-assigned this Sep 18, 2018

Brynanders requested a review from kasperisager September 18, 2018 11:41

Brynanders mentioned this pull request Sep 18, 2018

New Rule: Valid use of image file name in accessible name #216

Closed

Brynanders changed the title ~~Create SC1-1-1-accessible-name-is-image-file-name.md~~ Create SC1-1-1-accessible-name-is-image-file-name Sep 18, 2018

kasperisager previously approved these changes Sep 18, 2018

View reviewed changes

Brynanders requested review from ShadowBB and carlosapaduarte September 18, 2018 12:25

WilcoFiers added the september-agenda label Sep 19, 2018

audreymaniez mentioned this pull request Sep 19, 2018

SC1-1-1-placeholder-text-is-valid-accessible-name #251

Closed

carlosapaduarte previously requested changes Sep 20, 2018

View reviewed changes

_rules/SC1-1-1-accessible-name-is-image-file-name.md Outdated Show resolved Hide resolved

nitedog previously requested changes Sep 24, 2018

View reviewed changes

Update SC1-1-1-accessible-name-is-image-file-name.md

3538512

Simplified applicability Changed 1st inapplicable test case. Added 2nd inapplicable test case

This comment has been minimized.

Sign in to view

Update SC1-1-1-accessible-name-is-image-file-name.md

88c201f

Brynanders changed the title ~~Create SC1-1-1-accessible-name-is-image-file-name~~ Create SC1-1-1-alt-name-is-image-file-name Sep 26, 2018

Update SC1-1-1-accessible-name-is-image-file-name.md

fc9a500

Updated title and description to target `alt` instead of accessible name

This comment has been minimized.

Sign in to view

Update SC1-1-1-accessible-name-is-image-file-name.md

17ae1b5

Brynanders changed the title ~~Create SC1-1-1-alt-name-is-image-file-name~~ Create SC1-1-1-accessible-name-is-image-file-name Sep 26, 2018

This comment has been minimized.

Sign in to view

WilcoFiers previously requested changes Sep 27, 2018

View reviewed changes

ShadowBB approved these changes Feb 6, 2019

View reviewed changes

WilcoFiers removed reviewer wanted labels Feb 7, 2019

Brynanders added the Agenda item label Feb 12, 2019

annethyme mentioned this pull request Feb 14, 2019

Include "Ideas", "Implementations" and "CFC" stages in Auto-WCAG process #368

Closed

EmmaJP reviewed Feb 26, 2019

View reviewed changes

carlosapaduarte previously requested changes Feb 26, 2019

View reviewed changes

_rules/SC1-1-1-accessible-name-is-image-filename.md Outdated Show resolved Hide resolved

_rules/SC1-1-1-accessible-name-is-image-filename.md Outdated Show resolved Hide resolved

Brynanders added 2 commits February 27, 2019 12:01

Update SC1-1-1-accessible-name-is-image-filename.md

d706ff7

Minor editorial edit.

Update SC1-1-1-accessible-name-is-image-filename.md

c4fdd97

Minor template edits

WilcoFiers added Review call 2 weeks Call for review for new rules and big changes and removed Agenda item labels Feb 28, 2019

WilcoFiers previously requested changes Mar 2, 2019

View reviewed changes

Brynanders requested a review from WilcoFiers March 4, 2019 13:00

Brynanders added 2 commits March 5, 2019 11:00

Update SC1-1-1-accessible-name-is-image-filename.md

9c2d682

Update SC1-1-1-accessible-name-is-image-filename.md

4c0faf8

Merge branch 'master' into Brynanders-patch-2

64c5739

annethyme added the April 30 deadline label Mar 18, 2019

annethyme added the Agenda item label Mar 20, 2019

Brynanders merged commit b1e8b26 into master Mar 26, 2019

Brynanders deleted the Brynanders-patch-2 branch March 26, 2019 09:43

SC1-1-1-filename-is-valid-accessible-name #263

SC1-1-1-filename-is-valid-accessible-name #263

Uh oh!

Conversation

Brynanders commented Sep 18, 2018

Guidance for the PR (pull request) creator

How to Review And Approve

Uh oh!

Uh oh!

nitedog left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

nitedog commented Sep 27, 2018

Uh oh!

WilcoFiers Sep 27, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

WilcoFiers Sep 27, 2018

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Brynanders commented Sep 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ShadowBB left a comment

Choose a reason for hiding this comment

Uh oh!

goetsu commented Feb 25, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Brynanders commented Feb 26, 2019

Uh oh!

Brynanders commented Feb 26, 2019

Uh oh!

Brynanders commented Feb 26, 2019

Uh oh!

EmmaJP Feb 26, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Brynanders Feb 27, 2019

Choose a reason for hiding this comment

Uh oh!

Brynanders Feb 27, 2019

Choose a reason for hiding this comment

Uh oh!

EmmaJP left a comment

Choose a reason for hiding this comment

Uh oh!

carlosapaduarte left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

WilcoFiers left a comment

Choose a reason for hiding this comment

Uh oh!

WilcoFiers Mar 2, 2019

Choose a reason for hiding this comment

Uh oh!

Brynanders Mar 4, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Brynanders Mar 5, 2019

Choose a reason for hiding this comment

Uh oh!

annethyme commented Mar 20, 2019

Uh oh!

annethyme commented Mar 22, 2019

Uh oh!

Reviewers

Assignees

Brynanders commented Sep 27, 2018 •

edited

Loading

goetsu commented Feb 25, 2019 •

edited

Loading

EmmaJP Feb 26, 2019 •

edited

Loading

Brynanders Mar 4, 2019 •

edited

Loading