This repository has been archived by the owner on May 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AccessibilitySummaryAuthoringGuidelines.html
365 lines (363 loc) · 15.7 KB
/
AccessibilitySummaryAuthoringGuidelines.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
<head>
<meta charset="utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
<title>Accessibility Summary Authoring Guidelines</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
span.underline{text-decoration: underline;}
div.column{display: inline-block; vertical-align: top; width: 50%;}
q { quotes: "“" "”" "‘" "’"; }
</style>
<link rel="stylesheet" href="AccessibilitySummaryAuthoringGuidelines.css" />
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<header id="title-block-header">
<h1 class="title">Accessibility Summary Authoring Guidelines</h1>
</header>
<h2 id="status-of-this-document">Status of This Document</h2>
<p>Editors Draft - Version 0.9 (06/12/2019)</p>
<p>This document is published by the DIAGRAM Center Standards Working Group and DAISY’s Transition to EPUB Working group as an Editor’s Draft.</p>
<p>Comments regarding this document are welcome. Please <a href="https://github.com/benetech/AccessibilitySummaryEPUBMetadata/issues">file an issue using our GitHub repository issue tracker</a>.</p>
<hr />
<h2 id="table-of-contents">Table of Contents</h2>
<ul>
<li><a href="#introduction">Introduction</a></li>
<li><a href="#before-you-start-writing">Before you start writing</a></li>
<li><a href="#some-high-level-considerations">Some High-Level Considerations</a></li>
<li><a href="#what-to-include-in-the-accessibilitysummary">What to Include in the <code>AccessibilitySummary</code></a></li>
<li><a href="#examples">Examples</a></li>
<li><a href="#acknowledgements">Acknowledgements</a></li>
</ul>
<h2 id="introduction">Introduction</h2>
<p>The <a href="http://www.idpf.org/epub/a11y/#sec-disc-package">EPUB Accessibility Conformance and Discovery Specification defines a schema.org metadata term called <q>accessibilitySummary.</q></a> This piece of metadata is extraordinarily unique and important in that it provides a human readable description of the accessibility of the publication. It is expected that people who do not have formal training in HTML, EPUB, or who are not experts in accessibility will be reading the accessibilitySummary. Online Library and retail catalogues should present the accessibilitySummary to assist in making the decision to purchase or recommend the title. Individuals, professors, schools and universities should be basing their decisions to purchase on the accessibility of products.</p>
<p>The metadata accessibilitySummary can be found in either of two places, inside the EPUB in the OPF file, or this information can be retrieved from ONIX <a href="https://ns.editeur.org/onix/en/196">code list: 196</a>; Code: 00: Accessibility Summary.</p>
<hr />
<p><strong>Note</strong>: Please refer to the <a href="https://benetech.github.io/UX-Guide-EPUB-A11y-Metadata/UXGuideForMetadata.html">Guidelines for discovery and presentation of EPUB Accessibility metadata</a> for libraries and retailers.</p>
<hr />
<h2 id="before-you-start-writing">Before you start writing</h2>
<p>The <a href="https://daisy.github.io/ace/">Accessibility Checker for EPUB (Ace by DAISY)</a> is a tool which can be used to help you determine some of the accessibility features within the publication. This information can be found when looking at the report.html file Ace creates. This will help you determine what should be included in the accessibilitySummary that will be put into the OPF file and/or ONIX metadata feed.</p>
<p>Next read the accessibility metadata in the EPUB package.opf file before you begin to write. Make note of the features listed in the metadata as you prepare to write. One should always truthfully represent the accessibility of the publication and point out shortcomings of the publication; students may be able to get assistance from their school or university if some aspects of the publication are not accessible. For example, if complex graphics that convey information do not have an extended description, let people know that extended descriptions are not available.</p>
<h2 id="some-high-level-considerations">Some High-Level Considerations</h2>
<ul>
<li>Use simple language that communicates effectively to a non-technical and a non-accessibility aware community.</li>
<li>Avoid terms that are only known in a specific knowledge domain, or explain the term in a simple way.</li>
<li>Write out the words of the acronym before using the abbreviation, e.g. Web Content Accessibility Guidelines (WCAG).</li>
<li>Include all accessibility features, even those detailed in another schema.org metadata item; remember that the AccessibilitySummary may be the only piece of metadata that some users read.</li>
<li>Templates may be a useful approach for creating accessibility summaries in your organization, especially if all the content of a similar type goes through the same workflow and quality assurance process. However, make sure that the <code>accessibilitySummary</code> metadata that ships with the publication is accurate and applies to this particular publication.</li>
</ul>
<h2 id="what-to-include-in-the-accessibilitysummary">What to Include in the <code>AccessibilitySummary</code></h2>
<p>Here is a list of areas that the summary should address :</p>
<h3 id="accessibility-conformance-statement">Accessibility Conformance Statement</h3>
<table>
<colgroup>
<col style="width: 23%" />
<col style="width: 29%" />
<col style="width: 46%" />
</colgroup>
<thead>
<tr class="header">
<th>Metadata Value(s) Present</th>
<th>Suggested summary</th>
<th>Information</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><em>conformsTo</em> = <em><q>http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a</q></em></td>
<td>This publication meets accepted accessibility guidelines (WCAG-A)</td>
<td>WCAG-A Compliance</td>
</tr>
<tr class="even">
<td><em>conformsTo</em> = <em><q>http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa</q></em></td>
<td>This publication meets accepted accessibility guidelines (WCAG-AA)</td>
<td>WCAG-AA Compliance</td>
</tr>
</tbody>
</table>
<h3 id="screen-reader-friendly">Screen Reader Friendly</h3>
<table>
<colgroup>
<col style="width: 23%" />
<col style="width: 29%" />
<col style="width: 46%" />
</colgroup>
<thead>
<tr class="header">
<th>Metadata Value(s) Present</th>
<th>Suggested summary</th>
<th>Information</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><em>accessModeSufficient</em> = <em><q>textual</q></em> and <em>conformsTo</em> of <em>WCAG-A</em> or greater</td>
<td>This title is screen reader friendly and it will be accessible to a person using text-to-speech or refreshable braille.</td>
<td>Can this EPUB be entirely read by a Screen Reader, i.e. all visual only information has a meaningful text equivalent.</td>
</tr>
</tbody>
</table>
<h3 id="audio-book">Audio Book</h3>
<table>
<thead>
<tr class="header">
<th>Metadata Value(s) Present</th>
<th>Suggested summary</th>
<th>Information</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><em>accessModeSufficient</em> = <em><q>auditory</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessModeSufficient</em> = <em><q>auditory</q></em> and <em>accessModeSufficient</em> = *<q>textual</q></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="accessibility-features">Accessibility Features</h3>
<table>
<colgroup>
<col style="width: 23%" />
<col style="width: 29%" />
<col style="width: 46%" />
</colgroup>
<thead>
<tr class="header">
<th>Metadata Value(s) Present</th>
<th>Suggested summary</th>
<th>Information</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>alternativeText</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>annotations</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>audioDescription</q></em></td>
<td>Video has descriptive audio.</td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>bookmarks</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>braille</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>captions</q></em></td>
<td>Video has text captions.</td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>ChemML</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>describedMath</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>displayTransformability</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>highContrastAudio</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>highContrastDisplay</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>index</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>largePrint</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>latex</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>longDescription</q></em></td>
<td>Extended descriptions are provided for complex graphical content that conveys important information for understanding of the content.</td>
<td>Extended descriptions: Extended (or long) descriptions are used when complex graphics or other highly visual components convey information. The extended description communicates the equivalent information through text, tables, etc.</td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> of <em><q>longDescription</q></em> is missing</td>
<td>This publication contains graphical content that conveys significant information. This graphical material is not explained and the reader who cannot interpret the graphics should seek assistance.</td>
<td>Extended Descriptions are not provided when needed, for example if there is a complex image that needs a longer description to understand what the image is protraying.</td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>MathML</q></em></td>
<td>Math represented by MathML</td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>none</q></em></td>
<td>@@ - Include this? I don’t see how this could be possible.</td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>printPageNumbers</q></em> and <em>dc:source</em> is present</td>
<td>Page numbers are present and navigation to pages is supported.</td>
<td>Page navigation provided and matches the print book</td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>printPageNumbers</q></em> and <em>dc:source</em> is not present or refers to this EPUB</td>
<td>There is no print version of this publication, but digital page numbers are provided for ease of use.</td>
<td>Page navigation provided but no equivalent print book. Since there is no print equivalent book these page breaks are set by the publisher to aid in navigating to a specific digital or <q>virtual</q> page within the EPUB.</td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> of <em><q>printPageNumbers</q></em> is missing</td>
<td>This publication does not contain page numbers that can be navigated.</td>
<td>No page navigation provided</td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>readingOrder</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>rubyAnnotations</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>signLanguage</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>structuralNavigation</q></em> and <em><q>tableOfContents</q></em></td>
<td>This publication contains a table of contents for navigation through the various chapters and sections.</td>
<td>Table of Content Navigation</td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>synchronizedAudioText</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>tactileGraphic</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>tactileObject</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>timingControl</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>transcript</q></em></td>
<td>Video has a transcript.</td>
<td></td>
</tr>
<tr class="odd">
<td><em>accessibilityFeature</em> = <em><q>ttsMarkup</q></em></td>
<td></td>
<td></td>
</tr>
<tr class="even">
<td><em>accessibilityFeature</em> = <em><q>unlocked</q></em></td>
<td>@@ - Include this? This may not be under Publisher control</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="accessibility-hazards">Accessibility Hazards</h3>
<p>Accessibility hazards: Some content, especially videos, may contain elements that have been found to be problematic. Most common items are motion effects that make some people motion sick, flashing that can cause severe distractions or even seizures, or loud sharp noises like a gunshot which can cause hearing issues. It is only necessary to include this information if it is present.</p>
<table>
<colgroup>
<col style="width: 23%" />
<col style="width: 29%" />
<col style="width: 46%" />
</colgroup>
<thead>
<tr class="header">
<th>Metadata Value(s) Present</th>
<th>Suggested summary</th>
<th>Information</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><em>accessibilityHazard</em> = <em><q>flashing</q></em></td>
<td>Caution: the video contains flashing lights.</td>
<td>Flashing Hazard</td>
</tr>
<tr class="even">
<td><em>accessibilityHazard</em> = <em><q>sound</q></em></td>
<td>Caution: the audio contains loud noises.</td>
<td>Sound Hazard</td>
</tr>
<tr class="odd">
<td><em>accessibilityHazard</em> = <em><q>motionSimulation</q></em></td>
<td>Caution: the video has motion, which may affect some people.</td>
<td>Motion Simulation Hazard</td>
</tr>
</tbody>
</table>
<h2 id="examples">Examples</h2>
<pre><code><meta property="schema:accessibilitySummary">
The publication contains structural and page navigation. All non-decorative images have alt text or captions, or are described in the surrounding text. The publication meets WCAG 2.0 Level AA.
</meta></code></pre>
<pre><code><meta property="schema:accessibilitySummary">
This publication is screen reader friendly and is accessible to persons with disabilities. The publication was designed to be as accessible as possible to all persons with disabilities. It is compatible with the wide range of Assistive Technology on the market today. The built in features of most EPUB Reading Applications have accessibility features that may be used, e.g. read aloud is available in many Reading Apps. The publication meets the EPUB Accessibility requirements and it also meets the Web AccessibilityContent Guidelines (WCAG) at the double "AA" level.
Extensive navigation is provided to make it easy to use. The logos provided have alt text to identify what the logo represents. there are no other images. There are no accessibility hazards.
There are no video or audio recordings.
</meta></code></pre>
<hr />
<h2 id="acknowledgements">Acknowledgements</h2>
<h3 id="editors">Editors</h3>
<ul>
<li>George Kerscher</li>
<li>Charles LaPierre</li>
<li>Gregorio Pellegrino</li>
</ul>
<h3 id="contributors">Contributors</h3>
<ul>
<li>Avneesh Singh</li>
<li>Jason White</li>
<li>Madeleine Rothberg</li>
<li>Sarah Runcie</li>
</ul>
</body>
</html>