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

Updating the Transcript Rules #2064

Open
wants to merge 58 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
7c4e66c
TranscriptRules
HelenBurge May 25, 2023
5788d05
Update audio-transcript-2eb176.md
HelenBurge May 25, 2023
9e0300b
Update audio-transcript-2eb176.md
HelenBurge May 25, 2023
8132fb8
Update video-transcript-1a02b0.md
HelenBurge May 25, 2023
1392cfb
Update video-only-transcript-ee13b5.md
HelenBurge May 25, 2023
5123093
Update audio-transcript-2eb176.md
HelenBurge May 25, 2023
750beeb
Update video-only-transcript-ee13b5.md
HelenBurge May 25, 2023
cfc6f7a
Update video-transcript-1a02b0.md
HelenBurge May 25, 2023
7f6bc85
Merge branch 'develop' into TranscriptRules
HelenBurge May 25, 2023
7d9331c
Update _rules/audio-transcript-2eb176.md
HelenBurge May 25, 2023
9c7cfc0
Update audio-transcript-2eb176.md
HelenBurge Feb 29, 2024
39a4cd8
Update video-only-transcript-ee13b5.md
HelenBurge Feb 29, 2024
20c5578
Update video-transcript-1a02b0.md
HelenBurge Feb 29, 2024
9c7b010
Update audio-transcript-2eb176.md
HelenBurge Feb 29, 2024
5011552
Update video-only-transcript-ee13b5.md
HelenBurge Feb 29, 2024
c910d8b
Merge branch 'develop' into TranscriptRules
Jym77 Mar 5, 2024
aa43f64
Update _rules/audio-transcript-2eb176.md
HelenBurge Apr 23, 2024
06f4fd9
Update _rules/audio-transcript-2eb176.md
HelenBurge Apr 23, 2024
11570c6
Update _rules/audio-transcript-2eb176.md
HelenBurge Apr 23, 2024
8c8453d
Update _rules/audio-transcript-2eb176.md
HelenBurge Apr 23, 2024
556f9e6
Update _rules/audio-transcript-2eb176.md
HelenBurge Apr 23, 2024
d5edac0
Update _rules/video-only-transcript-ee13b5.md
HelenBurge Apr 23, 2024
9322d9e
Update _rules/video-transcript-1a02b0.md
HelenBurge Apr 23, 2024
6fcaa73
Update video-only-transcript-ee13b5.md
HelenBurge Apr 23, 2024
920180f
Update video-only-transcript-ee13b5.md
HelenBurge Apr 23, 2024
460d2de
Update video-only-transcript-ee13b5.md
HelenBurge Apr 23, 2024
79003bf
Update video-transcript-1a02b0.md
HelenBurge Apr 23, 2024
6644945
Fix frontmatters
Jym77 May 7, 2024
4d86b8f
Update _rules/audio-transcript-2eb176.md
HelenBurge May 21, 2024
a6a7bc7
Update audio-transcript-2eb176.md
HelenBurge May 21, 2024
07d251d
Update _rules/video-transcript-1a02b0.md
HelenBurge May 23, 2024
32ef899
Update _rules/audio-transcript-2eb176.md
HelenBurge May 23, 2024
4460429
Update audio-transcript-2eb176.md
HelenBurge May 23, 2024
d4c436c
Update video-only-transcript-ee13b5.md
HelenBurge May 23, 2024
d8830b6
Update video-transcript-1a02b0.md
HelenBurge May 23, 2024
f282089
Update _rules/audio-transcript-2eb176.md
HelenBurge May 30, 2024
089d651
Update _rules/video-only-transcript-ee13b5.md
HelenBurge May 30, 2024
81ec312
Update _rules/video-transcript-1a02b0.md
HelenBurge May 30, 2024
6867ec7
Update _rules/video-only-transcript-ee13b5.md
HelenBurge May 30, 2024
3838d16
Update _rules/audio-transcript-2eb176.md
HelenBurge May 30, 2024
fae7ad0
Update _rules/video-transcript-1a02b0.md
HelenBurge May 30, 2024
4a26e0b
Merge branch 'develop' into TranscriptRules
daniel-montalvo May 30, 2024
f1eb5ce
Update video-transcript-1a02b0.md
HelenBurge May 30, 2024
b0f435d
Update audio-transcript-2eb176.md
HelenBurge May 30, 2024
e6f966f
Update video-transcript-1a02b0.md
HelenBurge May 30, 2024
c366a7c
Update _rules/audio-transcript-2eb176.md
HelenBurge May 30, 2024
6651e1b
Update audio-transcript-2eb176.md
HelenBurge May 30, 2024
d89738c
Update video-only-transcript-ee13b5.md
HelenBurge May 30, 2024
0678b3f
Update video-transcript-1a02b0.md
HelenBurge May 30, 2024
7da5060
Update video-only-transcript-ee13b5.md
HelenBurge May 30, 2024
df3096f
Update audio-transcript-2eb176.md
HelenBurge May 30, 2024
efa4098
Update video-transcript-1a02b0.md
HelenBurge May 30, 2024
b7360ae
Update _rules/video-transcript-1a02b0.md
HelenBurge Aug 1, 2024
89ccdcd
Update _rules/video-only-transcript-ee13b5.md
HelenBurge Aug 1, 2024
62a5540
Update _rules/audio-transcript-2eb176.md
HelenBurge Aug 1, 2024
3cb5bf5
Update audio-transcript-2eb176.md
HelenBurge Aug 1, 2024
5f8a06a
Update video-only-transcript-ee13b5.md
HelenBurge Aug 1, 2024
6c39ab5
Update video-transcript-1a02b0.md
HelenBurge Aug 1, 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
56 changes: 32 additions & 24 deletions _rules/audio-transcript-2eb176.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ rule_type: atomic
description: |
This rule checks that `audio` elements have a transcript that includes all auditory information.
accessibility_requirements:
HelenBurge marked this conversation as resolved.
Show resolved Hide resolved
wcag20:1.2.1: # Audio-only and Video-only (Prerecorded) (A)
secondary: This success criterion is **less strict** than this rule. This is because the rule does not consider that the audio may be a media alternative for text. Some of the failed examples satisfy this success criterion.
wcag20:1.3.1: # Info and Relationships (A)
secondary: This success criterion is **more strict** than this rule. This is because the rule is not intended to test this requirement. Some of the passed examples do not satisfy this success criterion.
input_aspects:
- DOM Tree
- CSS Styling
Expand All @@ -13,6 +17,7 @@ input_aspects:
acknowledgments:
authors:
- Brian Bors
- Helen Burge
- Wilco Fiers
funding:
- WAI-Tools
Expand All @@ -22,27 +27,29 @@ acknowledgments:

## Applicability

This rule applies to every [non-streaming](#non-streaming-media-element) `audio` element that is:
This rule applies to every [non-streaming](#non-streaming-media-element) `audio` element for which at least one of the following is true:

- playing; or,
- has a [play button][] that is [visible][] and [included in the accessibility tree][].
- the element has an [autoplay][] [attribute value][] of `true`; or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since autoplay here is referring to the HTML attribute I don't think it needs to link to the definition.

- the element has a [play button][] that is [visible][] and [included in the accessibility tree][].

## Expectation

The auditory information of each test target is available through a text transcript. That text transcript is [visible][] and [included in the accessibility tree][], either on the page or through a link.
The auditory information of each test target is available through a text transcript. That text transcript is [visible][], either on the page or through a [clearly labeled location][].

**Note:** A "text transcript" in the context of this rule is defined in WCAG 2 as an [alternative for time based media](https://www.w3.org/TR/WCAG22/#dfn-alternative-for-time-based-media).

## Assumptions

There are no assumptions.
If a transcript is present, it is assumed it is in the accessibility tree. In order to satisfy WCAG, transcripts need to be available for all users, not just sighted users. This rule does not test this, and it needs to be tested separately.

## Accessibility Support

There are no accessibility support issues known.

## Background

Some major browsers do not automatically play the 'video' unless it is muted, which makes the rule inapplicable in these browsers. The rule still applies to browsers that [autoplay][] an audible 'video'.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one should link to the autoplay definition, but since it is being used in the Background section, the definition doesn't need to be objective.


### Bibliography

- [Understanding SC 1.2.1:Audio-only and Video-only (Prerecorded)](https://www.w3.org/WAI/WCAG22/Understanding/audio-only-and-video-only-prerecorded)
Expand Down Expand Up @@ -81,7 +88,7 @@ This `audio` element has native player controls and an external transcript.

#### Passed Example 3

This `audio` element has an `autoplay` attribute and an external transcript.
This `audio` element has an [autoplay][] attribute and an external transcript.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since autoplay here is referring to the HTML attribute I don't think it needs to link to the definition.


```html
<html lang="en">
Expand All @@ -90,6 +97,22 @@ This `audio` element has an `autoplay` attribute and an external transcript.
</html>
```

#### Passed Example 4

This `audio` element has native player controls and an internal transcript that is not exposed to the accessibility tree.

```html
<html lang="en">
<audio src="/test-assets/moon-audio/moon-speech.mp3" controls></audio>
<p aria-hidden="true">
The above audio contains the following speech: We choose to go to the moon in this decade and do the other things,
not because they are easy, but because they are hard, because that goal will serve to organize and measure the best
of our energies and skills, because that challenge is one that we are willing to accept, one we are unwilling to
postpone, and one which we intend to win, and the others, too.
</p>
</html>
```

### Failed

#### Failed Example 1
Expand Down Expand Up @@ -131,7 +154,7 @@ This `audio` element has native player controls and an incorrect external transc

#### Failed Example 4

This `audio` element has an `autoplay` attribute and an incorrect external transcript.
This `audio` element has an [autoplay][] attribute and an incorrect external transcript.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since autoplay here is referring to the HTML attribute I don't think it needs to link to the definition.


```html
<html lang="en">
Expand All @@ -156,22 +179,6 @@ This `audio` element has native player controls and a [non-visible][visible] int
</html>
```

#### Failed Example 6
HelenBurge marked this conversation as resolved.
Show resolved Hide resolved

This `audio` element has native player controls and an internal transcript that is not exposed to the accessibility tree.

```html
<html lang="en">
<audio src="/test-assets/moon-audio/moon-speech.mp3" controls></audio>
<p aria-hidden="true">
The above audio contains the following speech: We choose to go to the moon in this decade and do the other things,
not because they are easy, but because they are hard, because that goal will serve to organize and measure the best
of our energies and skills, because that challenge is one that we are willing to accept, one we are unwilling to
postpone, and one which we intend to win, and the others, too.
</p>
</html>
```

### Inapplicable

#### Inapplicable Example 1
Expand All @@ -194,6 +201,7 @@ This `audio` element has hidden native player controls.
</html>
```

[included in the accessibility tree]: #included-in-the-accessibility-tree 'Definition of included in the accessibility tree'
[play button]: #play-button 'Definition of play button'
[visible]: #visible 'Definition of visible'
[included in the accessibility tree]: #included-in-the-accessibility-tree 'Definition of included in the accessibility tree'
[autoplay]: #autoplay 'Definition of autoplay'
44 changes: 24 additions & 20 deletions _rules/video-only-transcript-ee13b5.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ accessibility_requirements:
failed: not satisfied
passed: further testing needed
inapplicable: further testing needed
wcag20:1.2.1: # Audio-only and Video-only (Prerecorded) (A)
secondary: This success criterion is **less strict** than this rule. This is because the rule does not consider that the video may be a media alternative for text. Some of the failed examples satisfy this success criterion.
wcag20:1.3.1: # Info and Relationships (A)
secondary: This success criterion is **more strict** than this rule. This is because the rule is not intended to test this requirement. Some of the passed examples do not satisfy this success criterion.
input_aspects:
- DOM Tree
- CSS Styling
Expand All @@ -19,6 +23,7 @@ input_aspects:
acknowledgments:
authors:
- Brian Bors
- Helen Burge
- Wilco Fiers
funding:
- WAI-Tools
Expand All @@ -36,19 +41,19 @@ This rule applies to any [non-streaming](#non-streaming-media-element) `video` e

## Expectation

The visual information of each test target is available through a text transcript that is [visible][], [included in the accessibility tree][], and is either on the page or linked.
The visual information of each test target is available through a text transcript that is [visible][], and is either on the page or in a clearly labeled location.
HelenBurge marked this conversation as resolved.
Show resolved Hide resolved

## Assumptions

A mechanism is available to start the video and that the video element is not simply used to display the [poster](https://www.w3.org/TR/html5/semantics-embedded-content.html#element-attrdef-video-poster).
If a transcript is present, it is assumed it is in the accessibility tree. In order to satisfy WCAG, transcripts need to be available for all users, not just sighted users. This rule does not test this, and it needs to be tested separately.

## Accessibility Support

There are no accessibility support issues known.

## Background

A "text transcript" in the context of this rule is defined in WCAG 2 as an [alternative for time based media](https://www.w3.org/TR/WCAG22/#dfn-alternative-for-time-based-media).
A "text transcript" in the context of this rule is defined in WCAG 2 as an [alternative for time-based media](https://www.w3.org/TR/WCAG22/#dfn-alternative-for-time-based-media).

### Bibliography

Expand Down Expand Up @@ -89,65 +94,65 @@ This `video` element, which has no audio, has a transcript which conveys informa
</html>
```

### Failed

#### Failed Example 1
#### Passed Example 3

This `video` element, which has no audio, has an incorrect text transcript available on the same page.
This `video` element, which has no audio, has a text transcript available on the same page, but the transcript is not [included in the accessibility tree][].

```html
<html lang="en">
<video controls>
<source src="/test-assets/rabbit-video/silent.mp4" type="video/mp4"></source>
<source src="/test-assets/rabbit-video/silent.webm" type="video/webm"></source>
</video>
<p>The above video shows a giant fat dog climbing out of a hole in the ground.
<p aria-hidden="true">The above video shows a giant fat rabbit climbing out of a hole in the ground.
He stretches, yawns, and then starts walking.
Then he stops to scratch his bottom.</p>
</html>
```

#### Failed Example 2
### Failed

This `video` element, which has no audio, has an incorrect text transcript available through a link on the same page.
#### Failed Example 1

This `video` element, which has no audio, has an incorrect text transcript available on the same page.

```html
<html lang="en">
<video controls>
<source src="/test-assets/rabbit-video/silent.mp4" type="video/mp4"></source>
<source src="/test-assets/rabbit-video/silent.webm" type="video/webm"></source>
</video>
<a href="/test-assets/rabbit-video/incorrect-transcript.html">Transcript</a>
<p>The above video shows a giant fat dog climbing out of a hole in the ground.
He stretches, yawns, and then starts walking.
Then he stops to scratch his bottom.</p>
</html>
```

#### Failed Example 3
#### Failed Example 2

This `video` element, which has no audio, has a text transcript available on the same page, but the transcript is not [visible][].
This `video` element, which has no audio, has an incorrect text transcript available through a link on the same page.

```html
<html lang="en">
<video controls>
<source src="/test-assets/rabbit-video/silent.mp4" type="video/mp4"></source>
<source src="/test-assets/rabbit-video/silent.webm" type="video/webm"></source>
</video>
<p style="text-indent: -9999px;">The above video shows a giant fat rabbit climbing out of a hole in the ground.
He stretches, yawns, and then starts walking.
Then he stops to scratch his bottom.</p>
<a href="/test-assets/rabbit-video/incorrect-transcript.html">Transcript</a>
</html>
```

#### Failed Example 4
#### Failed Example 3

This `video` element, which has no audio, has a text transcript available on the same page, but the transcript is not [included in the accessibility tree][].
This `video` element, which has no audio, has a text transcript available on the same page, but the transcript is not [visible][].

```html
<html lang="en">
<video controls>
<source src="/test-assets/rabbit-video/silent.mp4" type="video/mp4"></source>
<source src="/test-assets/rabbit-video/silent.webm" type="video/webm"></source>
</video>
<p aria-hidden="true">The above video shows a giant fat rabbit climbing out of a hole in the ground.
<p style="text-indent: -9999px;">The above video shows a giant fat rabbit climbing out of a hole in the ground.
He stretches, yawns, and then starts walking.
Then he stops to scratch his bottom.</p>
</html>
Expand Down Expand Up @@ -183,5 +188,4 @@ This `video` element is not [visible][].
</html>
```

[included in the accessibility tree]: #included-in-the-accessibility-tree 'Definition of included in the accessibility tree'
[visible]: #visible 'Definition of visible'
8 changes: 5 additions & 3 deletions _rules/video-transcript-1a02b0.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ input_aspects:
acknowledgments:
authors:
- Brian Bors
- Helen Burge
- Wilco Fiers
funding:
- WAI-Tools
Expand All @@ -41,20 +42,22 @@ This rule applies to every [non-streaming](#non-streaming-media-element) `video`

## Expectation

The visual information of each test target is available through a text transcript that is [visible][], [included in the accessibility tree][], and is either on the page or linked.
The visual information of each test target is available through a text transcript that is [visible][], and is either on the page or in a clearly labeled location.
HelenBurge marked this conversation as resolved.
Show resolved Hide resolved

**Note:** A "text transcript" in the context of this rule is defined in WCAG 2 as an [alternative for time based media](https://www.w3.org/TR/WCAG22/#dfn-alternative-for-time-based-media).

## Assumptions

This rule assumes that a mechanism is available to start the video and that the video element is not simply used to display the [poster](https://www.w3.org/TR/html5/semantics-embedded-content.html#element-attrdef-video-poster).
If a transcript is present, it is assumed it is in the accessibility tree. In order to satisfy WCAG, transcripts need to be available for all users, not just sighted users. This rule does not test this, and it needs to be tested separately.

## Accessibility Support

There are no accessibility support issues known.

## Background

A "text transcript" in the context of this rule is defined in WCAG 2 as an [alternative for time-based media](https://www.w3.org/TR/WCAG22/#dfn-alternative-for-time-based-media).

### Bibliography

- [Understanding Success Criterion 1.2.3: Audio Description or Media Alternative (Prerecorded)](https://www.w3.org/WAI/WCAG22/Understanding/audio-description-or-media-alternative-prerecorded)
Expand Down Expand Up @@ -145,5 +148,4 @@ A video element that is not [visible][].
</html>
```

[included in the accessibility tree]: #included-in-the-accessibility-tree 'Definition of included in the accessibility tree'
[visible]: #visible 'Definition of visible'
Loading