From ca4c6e0905ade667884eaae7a681f53cb3099c73 Mon Sep 17 00:00:00 2001 From: Matt Garrish Date: Thu, 20 Jun 2024 11:25:19 -0400 Subject: [PATCH] updated techniques --- epub33/a11y-tech/index.html | 317 ++++++++++++++++++++++++------------ 1 file changed, 217 insertions(+), 100 deletions(-) diff --git a/epub33/a11y-tech/index.html b/epub33/a11y-tech/index.html index cc3037bc6..2ce80cbbc 100644 --- a/epub33/a11y-tech/index.html +++ b/epub33/a11y-tech/index.html @@ -14,7 +14,7 @@ shortName: "epub-a11y-tech-11", noRecTrack: true, edDraftURI: "https://w3c.github.io/epub-specs/epub33/a11y-tech/", - previousPublishDate: "2021-07-12", + previousPublishDate: "2024-04-12", errata: "https://w3c.github.io/epub-specs/epub33/errata.html", previousMaturity: "NOTE", copyrightStart: "2017", @@ -78,6 +78,13 @@ "date": "04 September 2010", "publisher": "IDPF" }, + "page-source-id": { + "title": "Page Source Identification", + "href": "https://www.w3.org/publishing/a11y/page-source-id/", + "editors": [ + "Matt Garrish" + ] + }, "svg": { "title": "SVG", "href": "https://www.w3.org/TR/SVG/", @@ -176,7 +183,8 @@

About the techniques

Discovery metadata techniques

-
+
+

Identify primary access modes

An access mode is defined as a "human sense perceptual system or cognitive faculty through which a @@ -232,20 +240,22 @@

Identify primary access modes

Note that the access modes of the content do not reflect any adaptations that have been provided. For example, if a comic book also includes alternative text for each image, it does not have a textual - access mode. See the following section on sufficient access modes for how to - indicate that the available adaptations allow the content to be consumed in another mode.

+ access mode. See the following section on sufficient access + modes for how to indicate that the available adaptations allow the content to be consumed in + another mode.

Refer to The accessMode Property [[a11y-discov-vocab]] for more information about this property and its values.

-
+
+

Identify sufficient access modes

The access modes sufficient to consume an EPUB publication express a broader picture of the potential usability than do the basic access modes. Where the basic access modes identify the default + href="#accessMode">basic access modes. Where the basic access modes identify the default nature of the media used in the publication, sufficient access modes identify all the individual modes, and sets of modes, that allow a user to read a publication. Sufficient access modes account for the affordances and adaptations that the EPUB creators have provided, allowing users to @@ -373,7 +383,8 @@

Identify sufficient access modes

-
+
+

Setting access modes for synchronized text-audio

Setting the correct access modes and sufficient access modes for EPUB 3 publications that contain @@ -386,9 +397,9 @@

Setting access modes for synchronized text-audio

not to turn on the narration (unlike traditional audiobooks where only the audio is available).

In this case, because the audio playback is an extra feature, EPUB creators would - not list "auditory" as an access mode. - Rather, they would indicate the presence of text and audio synchronization as an accessibility feature:

+ not list "auditory" as an access mode. + Rather, they would indicate the presence of text and audio synchronization as an accessibility feature:

<meta
     property="schema:accessibilityFeature">
@@ -396,8 +407,8 @@ 
Setting access modes for synchronized text-audio

 </meta>

Although the audio is not essential to reading the publication, having full audio playback capability - means that there is an auditory sufficient access mode — the user can - listen to the complete publication. Consequently, the EPUB creator would declare a + means that there is an auditory sufficient access mode — + the user can listen to the complete publication. Consequently, the EPUB creator would declare a schema:accessModeSufficient property with the value auditory:

<meta
@@ -446,7 +457,8 @@ 
Setting access modes for synchronized text-audio
-
+
+

Identify accessibility features

Identifying all the accessibility features and adaptations included in an Identify accessibility features about this property and its values.

-
+
+

Identify accessibility hazards

There are three widely recognized hazards that can affect readers of digital content:

@@ -550,19 +563,47 @@

Identify accessibility hazards

Do not skip reporting hazards just because an EPUB publication does not contain any content that could present risks. Users cannot infer a meaning when no metadata is present. The value - "none" can be used in such cases instead of repeating each non-hazard.

+ "none" can be used in such cases instead of repeating each non-hazard. When the + "none" value is used, no other hazards values may be specified.

If an EPUB publication contains a hazard, provide additional information about its source and nature - in the accessibility summary.

+ in the accessibility summary.

+ +

If an EPUB creator cannot determine if a publication presents a specific hazard for users, list that + hazard as unknown. Individual unknown hazards must be specified alongside "no hazard" values.

+ +

For example, determining whether sound hazards are present can be challenging as the causes are + currently not well defined. In this case, EPUB creators may prefer to set the + "unknownSoundHazard" value, as in the following example.

+ + -

If hazards cannot be definitively determined, report the value "unknown".

+

If it is not possible to determine any hazards, the value "unknown" can be used in place + of setting the individual hazards to unknown. This value should be used sparingly, however, as it is + of no value to users. EPUB creators should make every effort to determine if hazards are present. + When the "unknown" value is set, no other hazard values may be specified.

Refer to The accessibilityHazard Property [[a11y-discov-vocab]] for more information about this property and its values.

-
+
+

Include an accessibility summary

An accessibility summary provides a brief, human-readable description of the accessibility @@ -629,7 +670,8 @@

Include an accessibility summary

information.

-
+
+

Identify ARIA conformance

The use of the schema:accesibilityAPI property is no longer necessary for Identify ARIA conformance controls.

-
+
+

Identify input control methods

The use of the schema:accesibilityControl property is no longer necessary for Identify input control methods sufficient for authoring purposes.

-
+
+

Examples

The following examples show the metadata that would be added to an Helpful resources

Content access

-
+
+

Ensure meaningful order of content across spreads

[[wcag2]] Success Criterion 1.3.2 specifies that @@ -876,7 +921,8 @@

Ensure meaningful order of content across spreads

user to jump from the break point on the first page to the continuation on the next).

-
+
+

Provide multiple ways to access the content

[[wcag2]] Success Criterion 2.4.5 requires there be more @@ -966,7 +1012,8 @@

Note about the table of contents
-
+
+

Ensure the order of table of contents entries matches linear order

The table of contents provides users more than just links into the content. It is also a means to @@ -994,7 +1041,7 @@

Ensure the order of table of contents entries matches linear order

by features, etc.

When the ordering of the table of contents does not match the content, EPUB creators should - include an explanation why in the accessibility summary.

+ include an explanation why in the accessibility summary.

EPUB creators should avoid including links to supplementary content at the end of the table of contents. Links to figure, tables, illustrations and similar content is better included as a @@ -1035,7 +1082,8 @@

Bypass blocks not necessary

Roles

-
+
+

ARIA roles and epub:type

@@ -1079,7 +1127,8 @@

ARIA roles and epub:type

equivalent ARIA roles in [[dpub-aria-1.0]] and [[wai-aria]].

-
+
+

Do not repeat roles across chunked content

Although EPUB publications appear @@ -1178,7 +1227,8 @@

Do not repeat roles across chunked content

the document that precedes the first chapter.

-
+
+

Include EPUB landmarks

[[wai-aria]] landmarks are similar in nature to Include EPUB landmarks designed to provide users with quick access to the major structures of a document, such as chapters, glossaries and indexes. ARIA landmarks are compiled automatically by assistive technologies from the roles that have been applied to the markup, so roles that have been applied to the markup, so EPUB creators only need to follow the requirement to include roles for the landmarks to be made available to users.

@@ -1195,7 +1245,8 @@

Include EPUB landmarks

href="https://www.w3.org/TR/epub/#dfn-epub-content-document">EPUB content documents. An assistive technology can only present the landmarks available in the currently-loaded document; it cannot provide a complete picture of all the landmarks in a multi-document publication (see - the previous section for more discussion about content chunking).

+ the previous section for more discussion about content + chunking).

EPUB landmarks, on the other hand, are compiled by the EPUB creator prior to distribution, and are not directly linked to the use of the Helpful resources

Titles and headings

-
+
+

Include publication and document titles

[[wcag2]] Success Criterion 2.4.2 requires that each web @@ -1364,7 +1416,8 @@

Include publication and document titles

href="https://www.w3.org/WAI/WCAG21/Techniques/html/H25">Technique H25.

-
+
+

Ensure numbered headings reflect publication hierarchy

To a user, an EPUB publication @@ -1441,7 +1494,8 @@

Ensure numbered headings reflect publication hierarchy

-
+
+

Heading topic or purpose

[[wcag2]] Success Criterion 2.4.6 currently states that @@ -1470,7 +1524,8 @@

Heading topic or purpose

Descriptions

-
+
+

Include alternative text descriptions

The first version of these techniques only required alternative text for images regardless of @@ -1499,7 +1554,8 @@

Helpful resources

Language

-
+
+

Language of package document

[[wcag2]] Success Criterions 3.1.1 and Language of package document expression mechanisms it provides).

-
+
+

Language of the EPUB publication

In addition to being able to express the language of text content, the Language of the EPUB publication

Text

-
+
+

Use Unicode for text content

[[wcag2]] Success Criterion 1.1.1 requires that text @@ -1643,8 +1701,9 @@

Accessible alternatives

publications that contain multiple renditions are conformant to the [[epub-a11y-11]] specification if at least one rendition meets all the content requirements, but EPUB creators at a minimum need to note that a reading system that supports multiple renditions is required in their accessibility summary. Any other methods the EPUB creator can use to make - this dependence known is advisable (e.g., in the distribution metadata).

+ href="#accessibilitySummary">accessibility summary. Any other methods the EPUB creator can + use to make this dependence known is advisable (e.g., in the distribution metadata).

This section will be updated with techniques for using multiple renditions when there is enough support in reading systems to broadly recommend their use.

@@ -1656,7 +1715,8 @@

EPUB Techniques

Page navigation

-
+
+

Provide page break markers

Both the EPUB Structural Semantics Vocabulary [[epub-ssv]] and Digital Publishing WAI-ARIA 1.0 @@ -1664,10 +1724,13 @@

Provide page break markers

href="https://www.w3.org/TR/epub/#pagebreak">pagebreak and doc-pagebreak, respectively.

-

It is recommended that both semantics be applied to EPUB 3 content to ensure maximum - compatibility with reading - systems and assistive - technologies.

+

For accessibility purposes, it is most important to specify the role attribute value + as this is what assistive technologies + will process. The epub:type attribute is not recognized by these devices, but it + may be used by epub reading + systems to enhance the user experience. For compatibility with both types of devices, it + is recommended to apply both attributes, although only the role attribute is + strictly required for accessibility conformance.

A title or aria-label attribute is required on the element, as it - provides the value that is announced to the user. Do not include the page number as text - content, as this practice forces the user to hear it announced wherever it occurs (e.g., without - any context in the middle of a sentence).

+ provides the value that is announced to the user.

+ +

The page number may be inserted as text content within the element, but assistive technologies + may not provide a way to disable announcing of the numbers. As a result, users may hear the + numbers announced wherever they occur, which could cause confusion (e.g., the number may seem to + be part of the sentence it occurs within).

+ +

EPUB 2 does not include markup to identify static page break marks in the content. Page break - destinations can be included to enable hyperlinking, but the page + destinations can be included to enable hyperlinking, but the page list is the only way a user can jump to the locations.

-
-
+
+

Identify pages in audio playback

Readers rarely stop reading to review each new page number, so when page numbers are read aloud @@ -1771,7 +1856,8 @@

Identify pages in audio playback

apply.

-
+
+

Provide a page list

A page list — a list of hyperlinks to the static page break locations — is the most effective way @@ -1790,6 +1876,13 @@

Provide a page list

through the pageList element [[opf-201]].

+
+

When a publication includes a page list, ensure that an accessibilityFeature metadata property is set with the value pageNavigation [[a11y-discov-vocab]].

+
+
-
+
+

Identify the pagination source

Users typically want to know the source of the page break markers included in an Identify the pagination source

To allow users to determine the suitability of the pagination, identify the ISBN of the source work in the package document - metadata.

+ metadata using the a11y:pageBreakSource property [[page-source-id]].

-

EPUB 3 allows the source of pagination to be explicitly identified using the source-of property with the - value "pagination" [[epub-3]].

+

If an ISBN is not available, include as much information as possible about the source publication + (e.g., the publisher, date, edition, and binding).

-

Synchronized text-audio playback

-
+
+

Ensuring complete text coverage

Ensuring the complete text of an EPUB @@ -1977,7 +2073,8 @@

Ensuring complete text coverage

ARIA attributes may also be used.

-
+
+

Specifying the reading order

The default reading order should typically represent the order in which Specifying the reading order column.

-
+
+

Identifying skippable structures

Some content elements are not critical to read when following the primary narrative of a work, @@ -2110,7 +2208,8 @@

Identifying skippable structures

-
+
+

Identifying escapable structures

Some content elements are containers for expressing complex information. A table, for example, @@ -2216,7 +2315,8 @@

Identifying escapable structures

-
+
+

Synchronizing the navigation document

EPUB creators can add a Synchronizing the navigation document

Distribution techniques

-
+
+

Do not restrict access through digital rights management

EPUB publications typically require @@ -2261,7 +2362,8 @@

Do not restrict access through digital rights management

assistive technologies on EPUB publications users have the right to access.

-
+
+

Include accessibility metadata in distribution records

When an EPUB publication is ingested @@ -2335,7 +2437,7 @@

Include accessibility metadata in distribution records

</ONIXMessage> -
+

Helpful resources

See the following resources for more information about including accessibility metadata in @@ -2365,14 +2467,28 @@

Change log

that affect the conformance of EPUB publications or are similarly noteworthy.

-

For a list of all issues addressed during the revision, refer to the For a list of all issues addressed in this version, refer to the working group's issue tracker.

    +
  • 20-June-2024: Updated guidance on identifying the page source to use the + a11y:pageBreakSource property. See issue 2626.
    • +
  • 20-June-2024: Added note to use pageNavigation accessibility feature when a page list + is included. See issue 2626.
    • +
  • 20-June-2024: Added note to use pageBreakMarkers accessibility feature not + printPageMarkers. See issue + 2626.
    • +
  • 20-June-2024: Clarified that the role attribute is most important for making page break + markers accessible. See issue 2621.
    • +
  • 20-June-2024: Removed restriction against added page numbers as text content but note that it may + cause confusion. See issue 2627.
    • +
  • 20-June-2024: Added guidance about using the individual unknown accessibility hazards. See issue 2626.
  • 27-Mar-2023: Clarified that the none and unknown terms do not meet the reporting requirements for accessibilityFeature . See issue 2537
    • + href="https://github.com/w3c/epub-specs/issues/2537">issue 2537.
  • 08-Sept-2022: Clarified that only meeting the techniques in this document is not sufficient for making claims of accessibility. See issue 2407
    • @@ -2395,8 +2511,8 @@

    Change log

    href="https://github.com/w3c/epub-specs/issues/1842">issue 1842.
  • 25-Oct-2021: Removed the generic technique labels for each section. See issue 1866.
    • -
  • 29-Sep-2021: Added new technique to explain that headings only have to be - unique, not define the topic or purpose of a section. See 29-Sep-2021: Added new technique to explain that headings only have + to be unique, not define the topic or purpose of a section. See issue 1810.
  • 10-June-2021: Clarified the technique on meaningful sequence that it applies to content that spans pages in a spread and is not about ordering documents in the spine. See Change log href="https://github.com/w3c/epub-specs/issues/1600">issue 1600.
  • 19-Feb-2021: References to WCAG 2.0 have been updated to undated references to WCAG 2 (except where WCAG 2.0 is explicitly mentioned for conformance).
    • -
  • 08-Jan-2021: Added technique recommending the order of the table of +
  • 08-Jan-2021: Added technique recommending the order of the table of contents match the linear reading order of content. See issue 1430.
  • 16-Dec-2020: Removed the exception that allowed only alternative text for images. See issue 1441.
    • -
  • 16-Nov-2020: The techniques for accessibility controls and APIs have been replaced with descriptions of why these properties are not - necessary to set. See issue 1286.
    • +
  • 16-Nov-2020: The techniques for accessibility controls and APIs have been replaced with descriptions of why these properties + are not necessary to set. See issue + 1286.