Skip to content

Commit a4e009f

Browse files
authored
Merge pull request #2812 from w3c/editorial/a11y-refs
Fix all remaining references to 1.1.1
2 parents ebfac4b + 1f76ec7 commit a4e009f

File tree

12 files changed

+122
-131
lines changed

12 files changed

+122
-131
lines changed

epub34/a11y-tech/index.html

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,11 @@
6464
"Matt Garrish"
6565
]
6666
},
67+
"epub-3": {
68+
"title": "EPUB 3",
69+
"href": "https://www.w3.org/TR/epub/",
70+
"publisher": "W3C"
71+
},
6772
"iso24751-3": {
6873
"title": " ISO/IEC 24751-3:2008 Information technology -- Individualized adaptability and accessibility in e-learning, education and training -- Part 3: "Access for all" digital resource description",
6974
"href": "http://www.iso.org/iso/catalogue_detail?csnumber=43604",
@@ -137,8 +142,9 @@ <h3>Overview</h3>
137142
<section id="sec-terminology">
138143
<h3>Terminology</h3>
139144

140-
<p>This document uses terminology defined in <a data-cite="epub/#sec-terminology">EPUB 3.3</a> [[epub]]
141-
and <a data-cite="epub-a11y-11#sec-terminology">EPUB Accessibility 1.2</a> [[epub-a11y-12]]:</p>
145+
<p>This document uses terminology defined in <a data-cite="epub/#sec-terminology">EPUB 3.3</a>
146+
[[epub-3]] and <a data-cite="epub-a11y-11#sec-terminology">EPUB Accessibility 1.2</a>
147+
[[epub-a11y-12]]:</p>
142148

143149
<div class="note">
144150
<p>Only the first instance of a term in a section links to its definition.</p>
@@ -264,7 +270,7 @@ <h4>Ensure meaningful order of content across spreads</h4>
264270
the underlying markup).</p>
265271

266272
<p>As EPUB allows two <a data-cite="epub/#dfn-epub-content-document">EPUB content documents</a> to
267-
be rendered together in a <a data-cite="epub/#spread">synthetic spread</a> [[epub]], the order
273+
be rendered together in a <a data-cite="epub/#spread">synthetic spread</a> [[epub-3]], the order
268274
of content within a single document cannot always be evaluated in isolation. Content might span
269275
visually from one document to the next. For example, a sidebar might span the bottom of two
270276
pages.</p>
@@ -295,7 +301,7 @@ <h4>Provide multiple ways to access the content</h4>
295301
>EPUB content documents</a>, <a data-cite="epub/#dfn-epub-reading-system">reading
296302
systems</a> automatically provide the ability for the user to move seamlessly from one
297303
document to the next, so long as they are listed in the <a data-cite="epub/#sec-spine-elem"
298-
>spine</a> [[epub]]. To the user, an EPUB publication is a single document they have
304+
>spine</a> [[epub-3]]. To the user, an EPUB publication is a single document they have
299305
complete access to, not a set of disconnected pages that they need links to move through.</p>
300306

301307
<p>The required table of contents provides a second method to access the major headings of the
@@ -455,7 +461,7 @@ <h4>ARIA roles and <code>epub:type</code></h4>
455461
</div>
456462

457463
<p>Although the <code>role</code> attribute might seem similar in nature to the <a
458-
data-cite="epub/#sec-epub-type-attribute"><code>type</code> attribute</a> [[epub]], their
464+
data-cite="epub/#sec-epub-type-attribute"><code>type</code> attribute</a> [[epub-3]], their
459465
target uses in EPUB content documents do not overlap.</p>
460466

461467
<p>The key difference between these attributes is that the <code>role</code> attribute bridges
@@ -917,7 +923,7 @@ <h4>Language of package document</h4>
917923
<p>Consequently, it is necessary to provide the language of all text content in the package document
918924
to conform with these WCAG success criteria. The easiest way to meet this requirement is to add
919925
an <code>xml:lang</code> attribute on the root <a data-cite="epub/#sec-package-elem"
920-
><code>package</code> element</a> [[epub]].</p>
926+
><code>package</code> element</a> [[epub-3]].</p>
921927

922928
<aside class="example" title="All text declared to be in Japanese by default">
923929
<pre><code>&lt;package … xml:lang="jp">
@@ -954,7 +960,7 @@ <h4>Language of the EPUB publication</h4>
954960
<p>In addition to being able to express the language of text content, the <a
955961
data-cite="epub/#dfn-package-document">package document</a> also allows the identification
956962
of the languages of the <a data-cite="epub/#dfn-epub-publication">EPUB publication</a> in <a
957-
data-cite="epub/#sec-opf-dclanguage"><code>dc:language</code> elements</a> [[epub]].</p>
963+
data-cite="epub/#sec-opf-dclanguage"><code>dc:language</code> elements</a> [[epub-3]].</p>
958964

959965
<aside class="example" title="Setting the language of an EPUB publication to Italian">
960966
<pre><code>&lt;package …>
@@ -1147,7 +1153,7 @@ <h4>Identify pages in audio playback</h4>
11471153

11481154
<p>To identify page numbers in media overlay documents, attach an <code>epub:type</code> attribute
11491155
with the value "<a data-cite="epub-ssv-11/#pagebreak"><code>pagebreak</code></a>" [[epub-ssv]]
1150-
to each <a data-cite="epub#sec-smil-par-elem"><code>par</code> element</a> [[epub]] that
1156+
to each <a data-cite="epub#sec-smil-par-elem"><code>par</code> element</a> [[epub-3]] that
11511157
identifies a page number.</p>
11521158

11531159
<aside class="example" title="A page number identified in a media overlays document">
@@ -1211,7 +1217,7 @@ <h4>Provide a page list</h4>
12111217

12121218
<p>The <a data-cite="epub/#dfn-epub-navigation-document">EPUB navigation document</a> allows the
12131219
inclusion of a <a data-cite="epub/#sec-nav-pagelist"><code>page-list</code>
1214-
<code>nav</code></a> [[epub]], while the EPUB 2 NCX file provides the same functionality
1220+
<code>nav</code></a> [[epub-3]], while the EPUB 2 NCX file provides the same functionality
12151221
through the <a href="http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1.2"
12161222
><code>pageList</code> element</a> [[opf-201]].</p>
12171223

@@ -1296,7 +1302,8 @@ <h4>Identify the pagination source</h4>
12961302

12971303
<p>To allow users to determine the suitability of the pagination, identify the ISBN of the source
12981304
work in the <a data-cite="epub/#dfn-package-document">package document</a> metadata using the <a
1299-
data-cite="epub#sec-pageBreakSource"><code>pageBreakSource</code> property</a> [[epub]].</p>
1305+
data-cite="epub#sec-pageBreakSource"><code>pageBreakSource</code> property</a>
1306+
[[epub-3]].</p>
13001307

13011308
<aside class="example" title="Expressing the source of pagination">
13021309
<p>In this example, the <code>pageBreakSource</code> property contains the ISBN of the print
@@ -1315,15 +1322,15 @@ <h4>Identify the pagination source</h4>
13151322
<p>These techniques previously advised using the <a data-cite="epub/#sec-source-of"
13161323
><code>source-of</code> property</a> to identify the <a
13171324
data-cite="epub/#sec-opf-dcmes-optional-def"><code>dc:source</code> element</a>
1318-
containing the source of the pagination [[epub]]. This method came with a number of
1325+
containing the source of the pagination [[epub-3]]. This method came with a number of
13191326
limitations, however. It was not future proof, for example, as it relied on the EPUB 3 <a
1320-
data-cite="epub/#attrdef-refines"><code>refines</code> attribute</a> [[epub]] and it
1327+
data-cite="epub/#attrdef-refines"><code>refines</code> attribute</a> [[epub-3]] and it
13211328
could not handle pagination without a source due to the reliance on a <code>dc:source</code>
13221329
element.</p>
13231330

13241331
<p>The <a data-cite="epub#sec-pageBreakSource"><code>pageBreakSource</code> property</a>
1325-
[[epub]] replaces <code>source-of</code> in newer version of EPUB 3. It is strongly advised
1326-
that anyone using the <code>source-of</code> property switch to using the
1332+
[[epub-3]] replaces <code>source-of</code> in newer version of EPUB 3. It is strongly
1333+
advised that anyone using the <code>source-of</code> property switch to using the
13271334
<code>pageBreakSource</code> property. Although the <code>source-of</code> method will
13281335
remain valid for backwards compatibility purposes, its use is no longer advised.</p>
13291336
</div>
@@ -1368,9 +1375,9 @@ <h4>Ensuring complete text coverage</h4>
13681375
even audio-only playback, have access to the same information as users who do not require
13691376
synchronized playback.</p>
13701377

1371-
<p>EPUB 3's <a data-cite="epub/#sec-media-overlays">media overlays feature</a> [[epub]] allows audio
1372-
to be synchronized with any element in an <a data-cite="epub/#dfn-epub-content-document">EPUB
1373-
content document</a>, so there is no technical barrier to providing synchronized
1378+
<p>EPUB 3's <a data-cite="epub/#sec-media-overlays">media overlays feature</a> [[epub-3]] allows
1379+
audio to be synchronized with any element in an <a data-cite="epub/#dfn-epub-content-document"
1380+
>EPUB content document</a>, so there is no technical barrier to providing synchronized
13741381
playback.</p>
13751382

13761383
<p>The primary consideration for this objective is what constitutes the text content of an EPUB
@@ -1384,9 +1391,9 @@ <h4>Ensuring complete text coverage</h4>
13841391

13851392
<p>The media overlays <a data-cite="epub/#sec-smil-text-elem"><code>text</code> element</a> is used
13861393
to reference these elements, either to play back the pre-recorded audio in a sibling <a
1387-
data-cite="epub/#sec-smil-audio-elem"><code>audio</code> element</a> [[epub]] or to initiate
1388-
playback of an audio or video element if the <code>audio</code> element is missing (e.g., for
1389-
embedded audio and video in the document).</p>
1394+
data-cite="epub/#sec-smil-audio-elem"><code>audio</code> element</a> [[epub-3]] or to
1395+
initiate playback of an audio or video element if the <code>audio</code> element is missing
1396+
(e.g., for embedded audio and video in the document).</p>
13901397

13911398
<div class="note">
13921399
<p>Do not synchronize media overlays to hidden text content. Synchronizing audio with invisible
@@ -1426,8 +1433,8 @@ <h4>Specifying the reading order</h4>
14261433
content) diverges from the default reading order, order the playback sequence of <a
14271434
data-cite="epub/#sec-smil-seq-elem"><code>seq</code></a> and <a
14281435
data-cite="epub/#sec-smil-par-elem"><code>par</code></a> elements in a <a
1429-
data-cite="epub/#sec-overlay-docs">media overlays document</a> [[epub]] to match the logical
1430-
order.</p>
1436+
data-cite="epub/#sec-overlay-docs">media overlays document</a> [[epub-3]] to match the
1437+
logical order.</p>
14311438

14321439
<p>Use caution when making alterations, however, as other accessibility issues can arise when the
14331440
logical order does not match the default order. For example, the content might not be accessible
@@ -1451,13 +1458,14 @@ <h4>Identifying skippable structures</h4>
14511458
content after finishing the <a data-cite="epub/#dfn-epub-publication">EPUB publication</a>. The
14521459
announcement of page break numbers can be similarly annoying to readers.</p>
14531460

1454-
<p>EPUB 3's <a data-cite="epub/#sec-media-overlays">media overlays feature</a> [[epub]] does not
1461+
<p>EPUB 3's <a data-cite="epub/#sec-media-overlays">media overlays feature</a> [[epub-3]] does not
14551462
allow <a data-cite="epub/#dfn-epub-reading-system">reading systems</a> to determine if playback
14561463
sequences are skippable unless additional semantics are added to the markup using the <a
1457-
data-cite="epub/#sec-epub-type-attribute"><code>epub:type</code></a> attribute [[epub]] on
1464+
data-cite="epub/#sec-epub-type-attribute"><code>epub:type</code></a> attribute [[epub-3]] on
14581465
<a data-cite="epub/#sec-smil-seq-elem"><code>seq</code></a> and <a
1459-
data-cite="epub/#sec-smil-par-elem"><code>par</code></a> elements [[epub]]. These semantics
1460-
are what allow reading systems to provide users the option to skip their playback sequences.</p>
1466+
data-cite="epub/#sec-smil-par-elem"><code>par</code></a> elements [[epub-3]]. These
1467+
semantics are what allow reading systems to provide users the option to skip their playback
1468+
sequences.</p>
14611469

14621470
<p>It is strongly advised to identify the following structures for skippability:</p>
14631471

@@ -1553,13 +1561,13 @@ <h4>Identifying escapable structures</h4>
15531561
on. These are called escapable elements, because the user needs to be able to escape from them
15541562
whenever they choose to simplify the reading experience.</p>
15551563

1556-
<p>EPUB 3's <a data-cite="epub/#sec-media-overlays">media overlays feature</a> [[epub]] only
1564+
<p>EPUB 3's <a data-cite="epub/#sec-media-overlays">media overlays feature</a> [[epub-3]] only
15571565
supports escapability if structural semantics are added to the markup using the <a
1558-
data-cite="epub/#sec-epub-type-attribute"><code>epub:type</code> attribute</a> [[epub]] on
1566+
data-cite="epub/#sec-epub-type-attribute"><code>epub:type</code> attribute</a> [[epub-3]] on
15591567
<a data-cite="epub/#sec-smil-seq-elem"><code>seq</code></a> and <a
1560-
data-cite="epub/#sec-smil-seq-elem"><code>par</code></a> elements [[epub]]. These semantics
1561-
are what allow <a data-cite="epub/#dfn-epub-reading-system">reading systems</a> to provide users
1562-
the option to escape their playback sequences.</p>
1568+
data-cite="epub/#sec-smil-seq-elem"><code>par</code></a> elements [[epub-3]]. These
1569+
semantics are what allow <a data-cite="epub/#dfn-epub-reading-system">reading systems</a> to
1570+
provide users the option to escape their playback sequences.</p>
15631571

15641572
<p>It is strongly advised to identify the following structures for escapability:</p>
15651573

@@ -1579,7 +1587,7 @@ <h4>Identifying escapable structures</h4>
15791587

15801588
<div class="note">
15811589
<p>Identifying nested escapable structures is not advised at this time. Refer to <a
1582-
data-cite="epub/#sec-escapability">Escapability</a> [[epub]] for more information.</p>
1590+
data-cite="epub/#sec-escapability">Escapability</a> [[epub-3]] for more information.</p>
15831591
</div>
15841592

15851593
<aside class="example" title="Identifying an escapable list">

0 commit comments

Comments
 (0)