Skip to content

Commit

Permalink
[#102] Fixes some readability issues
Browse files Browse the repository at this point in the history
Co-authored-by: Ben Luby <[email protected]>
  • Loading branch information
jfhector and lubes72 committed Feb 23, 2020
1 parent c06cd6a commit fdcc5bf
Show file tree
Hide file tree
Showing 9 changed files with 300 additions and 275 deletions.
131 changes: 66 additions & 65 deletions guidelines/1.1.1.md

Large diffs are not rendered by default.

33 changes: 17 additions & 16 deletions guidelines/1.2.1-audio-only.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ This document is in beta. Help us by [reporting issues via Github](https://githu

[Back to the overview page](./../index.html)

# Transcript for prerecorded audio-only content
# Transcript for pre-recorded audio-only content

On this page:
* [Summary](#summary)
* [Requirements](#requirements)
* [More info](#more-info)

- [Summary](#summary)
- [Requirements](#requirements)
- [More info](#more-info)

---

Expand All @@ -20,14 +21,14 @@ Audio-only content that communicates information (like a podcast) should have a
---

## Requirements
* A text transcript is available (on the same page or on a page linked from the page containing the media) for any audio-only content (e.g. podcasts).

- A text transcript is available (on the same page or on a page linked from the page containing the media) for any audio-only content (e.g. podcasts).

### Common mistakes

* Audio-only content that communicates information does not have a text transcript;
* The text transcript for audio-only content does not include all spoken dialogue and sound effects;
* The text transcript for audio-only content is not clearly labelled as such.
- Audio-only content that communicates information does not have a text transcript;
- The text transcript for audio-only content does not include all spoken dialogue and sound effects;
- The text transcript for audio-only content is not clearly labelled as such.

### Why?

Expand All @@ -37,8 +38,8 @@ This ensures that the information is available to people who cannot hear.

> [**1.2.1 Audio-only and Video-only (Prerecorded):**](https://www.w3.org/TR/UNDERSTANDING-WCAG20/content-structure-separation-programmatic.html) For [prerecorded](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#prerecordeddef) [audio-only](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#audio-onlydef) and prerecorded [video-only](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#video-onlydef) media, the following are true, except when the audio or video is a [media alternative for text](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#multimedia-alt-textdef) and is clearly labeled as such: (Level A)
>
> * **Prerecorded Audio-only**: An [alternative for time-based media](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#alt-time-based-mediadef) is provided that presents equivalent information for prerecorded audio-only content.
> * **Prerecorded Video-only**: Either an alternative for time-based media or an audio track is provided that presents equivalent information for prerecorded video-only content.
> - **Prerecorded Audio-only**: An [alternative for time-based media](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#alt-time-based-mediadef) is provided that presents equivalent information for prerecorded audio-only content.
> - **Prerecorded Video-only**: Either an alternative for time-based media or an audio track is provided that presents equivalent information for prerecorded video-only content.
See the [W3C's detailed explanation of this guideline](https://www.w3.org/TR/UNDERSTANDING-WCAG20/content-structure-separation-programmatic.html) with techniques and examples.

Expand All @@ -48,14 +49,14 @@ See the [W3C's detailed explanation of this guideline](https://www.w3.org/TR/UND

### Sources

* [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
* [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)
* [Barclays' Accessibility Design Standards](https://home.barclays/who-we-are/our-suppliers/our-requirements-of-external-suppliers/)
- [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
- [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)
- [Barclays' Accessibility Design Standards](https://home.barclays/who-we-are/our-suppliers/our-requirements-of-external-suppliers/)

### Useful resources

* [What are transcripts?](https://www.nomensa.com/blog/2010/what-are-transcripts/) on the Nomensa blog
- [What are transcripts?](https://www.nomensa.com/blog/2010/what-are-transcripts/) on the Nomensa blog

### Contribute

This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
29 changes: 15 additions & 14 deletions guidelines/1.2.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ This document is in beta. Help us by [reporting issues via Github](https://githu

[Back to the overview page](./../index.html)

# Captions for prerecorded videos
# Captions for pre-recorded videos

On this page:
* [Summary](#summary)
* [Requirements](#requirements)
* [More info](#more-info)

- [Summary](#summary)
- [Requirements](#requirements)
- [More info](#more-info)

---

Expand All @@ -21,14 +22,14 @@ Pre-recorded video content (like instructional videos, ads or interviews) must h

## Requirements

* All pre-recorded video content has captions that are synchronised with the audio content of the video;
* Captions include all the spoken dialogue and important sound effects from the audio part of the video.
- All pre-recorded video content has captions that are synchronised with the audio content of the video;
- Captions include all the spoken dialogue and important sound effects from the audio part of the video.

### Common mistakes

* The video does not have synchronised captions;
* The video has captions but they do not include all the spoken dialogue and important sound effects from the audio content of the video;
* The video has captions but they are not synchronised with the audio content of the video.
- The video does not have synchronised captions;
- The video has captions but they do not include all the spoken dialogue and important sound effects from the audio content of the video;
- The video has captions but they are not synchronised with the audio content of the video.

### Why?

Expand All @@ -46,14 +47,14 @@ See the [W3C's detailed explanation of this guideline](https://www.w3.org/TR/UND

### Sources

* [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
* [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)
- [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
- [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)

### Useful resources

* [What are captions?](https://www.nomensa.com/blog/2010/what-are-captions) on the Nomensa blog
* [Sounding out the web: accessibility for Deaf and hard of hearing people (Part 2)](https://www.paciellogroup.com/blog/2017/03/sounding-out-the-web-accessibility-for-deaf-and-hard-of-hearing-people-part-2/) by The Paciello Group
- [What are captions?](https://www.nomensa.com/blog/2010/what-are-captions) on the Nomensa blog
- [Sounding out the web: accessibility for Deaf and hard of hearing people (Part 2)](https://www.paciellogroup.com/blog/2017/03/sounding-out-the-web-accessibility-for-deaf-and-hard-of-hearing-people-part-2/) by The Paciello Group

### Contribute

This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
31 changes: 16 additions & 15 deletions guidelines/1.2.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ This document is in beta. Help us by [reporting issues via Github](https://githu

[Back to the overview page](./../index.html)

# Text or audio description for prerecorded videos
# Text or audio description for pre-recorded videos

On this page:
* [Summary](#summary)
* [Requirements](#requirements)
* [More info](#more-info)

- [Summary](#summary)
- [Requirements](#requirements)
- [More info](#more-info)

---

Expand All @@ -19,14 +20,14 @@ On this page:

## Requirements

* Video content (like instructional videos, ads or interviews) must have [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef), or has a text alternative that describes the visual content of the video.
- Video content (like instructional videos, ads or interviews) must have [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef), or has a text alternative that describes the visual content of the video.

### Common mistakes

* The video does not have [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef) or a text alternative;
* The audio description does not describe important information communicated visually in the video;
* The text alternative does not describe important information communicated visually in the video;
* The audio description is not synchronised to complement the audio content of the video.
- The video does not have [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef) or a text alternative;
- The audio description does not describe important information communicated visually in the video;
- The text alternative does not describe important information communicated visually in the video;
- The audio description is not synchronised to complement the audio content of the video.

### Why?

Expand All @@ -42,22 +43,22 @@ Note: pre-recorded videos without sound are covered somewhere else in the W3C We

> [**1.2.1 Audio-only and Video-only (Prerecorded):**](https://www.w3.org/TR/UNDERSTANDING-WCAG20/content-structure-separation-programmatic.html) For [prerecorded](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#prerecordeddef) [audio-only](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#audio-onlydef) and prerecorded [video-only](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#video-onlydef) media, the following are true, except when the audio or video is a [media alternative for text](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#multimedia-alt-textdef) and is clearly labeled as such: (Level A)
>
> * **Prerecorded Audio-only**: An [alternative for time-based media](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#alt-time-based-mediadef) is provided that presents equivalent information for prerecorded audio-only content.
> * **Prerecorded Video-only**: Either an alternative for time-based media or an audio track is provided that presents equivalent information for prerecorded video-only content.
> - **Prerecorded Audio-only**: An [alternative for time-based media](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#alt-time-based-mediadef) is provided that presents equivalent information for prerecorded audio-only content.
> - **Prerecorded Video-only**: Either an alternative for time-based media or an audio track is provided that presents equivalent information for prerecorded video-only content.
---

## More info

### Sources

* [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
* [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)
- [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
- [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)

### Useful resources

* [What is audio description?](https://www.nomensa.com/blog/2010/what-is-audio-description)
- [What is audio description?](https://www.nomensa.com/blog/2010/what-is-audio-description)

### Contribute

This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
29 changes: 15 additions & 14 deletions guidelines/1.2.5.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@ This document is in beta. Help us by [reporting issues via Github](https://githu

[Back to the overview page](./../index.html)

# Audio description for prerecorded videos
# Audio description for pre-recorded videos

On this page:
* [Summary](#summary)
* [Requirements](#requirements)
* [More info](#more-info)

- [Summary](#summary)
- [Requirements](#requirements)
- [More info](#more-info)

---

Expand All @@ -21,13 +22,13 @@ Video content (like instructional videos, ads or interviews) must have [audio de

## Requirements

* Video that includes important visual information has [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef).
- Video that includes important visual information has [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef).

### Common mistakes

* A video includes important visual information but does not have [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef);
* The audio description does not describe important information communicated visually in the video;
* The audio description is not synchronised to complement the audio content of the video.
- A video includes important visual information but does not have [audio description](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-audio-desc.html#audiodescdef);
- The audio description does not describe important information communicated visually in the video;
- The audio description is not synchronised to complement the audio content of the video.

### Why?

Expand All @@ -43,22 +44,22 @@ Note: pre-recorded videos without sound are covered somewhere else in the W3C We

> [**1.2.1 Audio-only and Video-only (Prerecorded):**](https://www.w3.org/TR/UNDERSTANDING-WCAG20/content-structure-separation-programmatic.html) For [prerecorded](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#prerecordeddef) [audio-only](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#audio-onlydef) and prerecorded [video-only](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#video-onlydef) media, the following are true, except when the audio or video is a [media alternative for text](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#multimedia-alt-textdef) and is clearly labeled as such: (Level A)
>
> * **Prerecorded Audio-only**: An [alternative for time-based media](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#alt-time-based-mediadef) is provided that presents equivalent information for prerecorded audio-only content.
> * **Prerecorded Video-only**: Either an alternative for time-based media or an audio track is provided that presents equivalent information for prerecorded video-only content.
> - **Prerecorded Audio-only**: An [alternative for time-based media](https://www.w3.org/TR/UNDERSTANDING-WCAG20/media-equiv-av-only-alt.html#alt-time-based-mediadef) is provided that presents equivalent information for prerecorded audio-only content.
> - **Prerecorded Video-only**: Either an alternative for time-based media or an audio track is provided that presents equivalent information for prerecorded video-only content.
---

## More info

### Sources

* [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
* [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)
- [W3C Web Content Accessibility Guidelines 2.1](https://www.w3.org/TR/WCAG21/)
- [Government Digital Service WCAG 2.1 Primer](https://alphagov.github.io/wcag-primer/)

### Useful resources

* [What is audio description?](https://www.nomensa.com/blog/2010/what-is-audio-description)
- [What is audio description?](https://www.nomensa.com/blog/2010/what-is-audio-description)

### Contribute

This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
This document is in beta. Help us by [reporting issues via Github](https://github.com/theappbusiness/accessibility-guidelines) or [email](mailto:[email protected])
Loading

0 comments on commit fdcc5bf

Please sign in to comment.