Display Techniques for ONIX Accessibility Metadata 1.0

1. ONIX Metadata

Note

Other techniques for implementing EPUB accessibility metadata are available: Display Techniques for Displaying Accessibility Metadata

Note

This document provides techniques for meeting the guidelines of the User Experience Guide for Displaying Accessibility Metadata. It provides practical examples for extracting information from the ONIX metadata for showing it to the end users.

Note

ONIX messages describe products for the global book supply chain and will be sent from publisher or creator of the epub or digital books with full audio to those who will make the products available for sale, lending or subscription. These platforms may not yet have the actual files, as they may not yet be ready, or may only choose to list them for sale if they have certain accessibility features. ONIX also only describes a product, it cannot describe the features of the reading systems on which a product may be accessed. It is important to use ONIX metadata as a complement to the accessibility data embedded within the publication itself, if describing accessible books, books with full audio and related products for the global book supply chain. An ONIX file can be used to display accessibility information in advance of publication or when you do not have access to the metadata in the digital file itself. Some accessibility information may only be available when you have access to the file itself. If you are unfamiliar with ONIX, then there is more documentation available from EDItEUR.org.

Note

ONIX does not have a 1:1 mapping with EPUB accessibility metadata. As some accessibility assertions are posed differently between the two mechanisms, direct mapping between the two may not always be possible. The EPUB to ONIX crosswalk outlines the current high degree of overlap in metadata and will be updated as these two specifications evolve. It is important to note that ONIX 3.0 includes a number of new accessibility metadata codes, some of which may not be expressible in earlier versions of ONIX.

1.1 ONIX record examples

1.1.1 ONIX record describing an EPUB

Here is an example of an ONIX record (version 3.0), which will be used as a reference point for the following examples on EPUB accessibility metadata: the results of the XPath shown are based on this example.

Example 1

<?xml version="1.0" encoding="UTF-8"?>
<ONIXMessage xmlns="http://ns.editeur.org/onix/3.0/reference" release="3.0">
    <Header>...</Header>
    <Product>
        <RecordReference>123456789</RecordReference>
        <NotificationType>01</NotificationType>
        <ProductIdentifier>
            <ProductIDType>03</ProductIDType>
            <IDValue>9780000000000</IDValue>
        </ProductIdentifier>
        <ProductIdentifier>
            <ProductIDType>15</ProductIDType>
            <IDValue>9780000000000</IDValue>
        </ProductIdentifier>
        <DescriptiveDetail>
            <ProductComposition>00</ProductComposition>
            <ProductForm>ED</ProductForm>
            <ProductFormDetail>E101</ProductFormDetail>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>00</ProductFormFeatureValue>
                <ProductFormFeatureDescription>
                    This publication includes mark-up to enable accessibility and compatibility with assistive technology. Images, audio, and video in the publication are well-described in conformance with WCAG 2.0 A.
                </ProductFormFeatureDescription>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>03</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>10</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>11</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>13</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>14</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>20</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>22</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>12</ProductFormFeatureType>
                <ProductFormFeatureValue>14</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>12</ProductFormFeatureType>
                <ProductFormFeatureValue>16</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>12</ProductFormFeatureType>
                <ProductFormFeatureValue>18</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>12</ProductFormFeatureType>
                <ProductFormFeatureValue>20</ProductFormFeatureValue>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>94</ProductFormFeatureValue>
                <ProductFormFeatureDescription>http://www.certifier.com/</ProductFormFeatureDescription>
            </ProductFormFeature>
            <ProductFormFeature>
                <ProductFormFeatureType>09</ProductFormFeatureType>
                <ProductFormFeatureValue>94</ProductFormFeatureValue>
                <ProductFormFeatureDescription>http://www.example.com/a11y/report/9780000000001</ProductFormFeatureDescription>
            </ProductFormFeature>
            <PrimaryContentType>10</PrimaryContentType>
            <EpubTechnicalProtection>03</EpubTechnicalProtection>
            <EpubUsageConstraint>
                <EpubUsageType>04</EpubUsageType>
                <EpubUsageStatus>02</EpubUsageStatus>
            </EpubUsageConstraint>
            <TitleDetail>...</TitleDetail>
            <Contributor>...</Contributor>
            <Extent>...</Extent>
            <Subject>...</Subject>
        </DescriptiveDetail>
        <CollateralDetail>...</CollateralDetail>
        <PublishingDetail>...</PublishingDetail>
        <RelatedMaterial>...</RelatedMaterial>
        <ProductSupply>...</ProductSupply>
    </Product>
</ONIXMessage>

1.1.2 ONIX record describing an audiobook

Here is an example of an ONIX record (version 3.0) for describing an audiobook, which will be used as a reference point for the some of the following examples on EPUB accessibility metadata: the results of the XPath shown are based on this example.

Example 2

<?xml version="1.0" encoding="UTF-8"?>
<ONIXMessage xmlns="http://ns.editeur.org/onix/3.0/reference" release="3.0">
    <Header>...</Header>
    <Product>
        <RecordReference>123456789</RecordReference>
        <NotificationType>01</NotificationType>
        <ProductIdentifier>
            <ProductIDType>03</ProductIDType>
            <IDValue>0000000000000</IDValue>
        </ProductIdentifier>
        <DescriptiveDetail>
            <ProductComposition>00</ProductComposition>
            <ProductForm>AO</ProductForm>
            <PrimaryContentType>01</PrimaryContentType>
            ...
            <TitleDetail>...</TitleDetail>
            <Contributor>...</Contributor>
            <Extent>...</Extent>
            <Subject>...</Subject>
        </DescriptiveDetail>
        <CollateralDetail>...</CollateralDetail>
        <PublishingDetail>...</PublishingDetail>
        <RelatedMaterial>...</RelatedMaterial>
        <ProductSupply>...</ProductSupply>
    </Product>
</ONIXMessage>

2. Techniques

Value: Yes / No / Unknown

This technique relates to Screen Reader Friendly principle.

This information can be retrieved from ONIX List 81; Code: 10 combined with code list 196; Code: 10 means all text is actual text.

Note

List 81; Code: 10 on its own (without List 196; Code: 10) admits the possibility that the ‘text’ is inaccessible because it is an image of text.

2.1.1 Example 1.1

2.1.1.1 XPath

This field is true if the both XPath elements exist:

Example 3

//Product/DescriptiveDetail/PrimaryContentType[text()="10"] and
//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="10"]

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.1.1.2 UI

Screen Reader Friendly: Yes

2.2 Full Audio

Values: Yes / (if No - Omit this section)

This technique relates to Full Audio principle.

If the publication is based on text with synchronized audio, this information can be retrieved from ONIX code list: 196; Code: 20: Synchronised pre-recorded audio.

If the publication is audio-only (e.g. audiobook), this information can be retrieved from ONIX code list 81; Code: 01: Audiobook.

2.2.1 Example 2.1

2.2.1.1 XPath

If the following XPath returns at least one result:

Example 4

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="20"]

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.2.1.2 UI

Full Audio: Yes

2.2.2 Example 2.2

2.2.2.1 XPath

This field is true if the XPath returns one element for:

Example 5

//Product/DescriptiveDetail/PrimaryContentType[text()="01"]

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 2.

2.2.2.2 UI

Full Audio: Yes

2.3 Accessibility Summary

Value: Textual Data from metadata

This technique relates to Accessibility Summary principle.

This information can be retrieved from ONIX code list: 196; Code: 00: Accessibility Summary.

2.3.1 Example 3.1

2.3.1.1 XPath

The value can be retrieved using XPath:

Example 6

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="00"]/ProductFormFeatureDescription/text()

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.3.1.2 UI

Accessibility Summary:

This publication includes markup to enable accessibility and compatibility with assistive technology. Images, audio, and video in the publication are well-described in conformance with WCAG 2.0 A.

2.4 Accessibility Conformance

Value: Textual Link based on Metadata

This technique relates to Accessibility Conformance principle.

For EPUB Accessibility, WCAG-A: List: 196; Code: 02: EPUB Accessibility Specification 1.0 A
For EPUB Accessibility, WCAG-AA: List: 196; Code: 03: EPUB Accessibility Specification 1.0 AA
For EPUB Accessibility, WCAG-AAA: Not available in ONIX.

2.4.1 Example 4.1

2.4.1.1 XPath

If the following XPath returns at least one result:

Example 7

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="02"]

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.4.1.2 UI

Accessibility Conformance: EPUB Accessibility, WCAG-A

2.4.2 Example 4.2

2.4.2.1 XPath

If the following XPath returns at least one result:

Example 8

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="03"] returns at least one result

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.4.2.2 UI

Accessibility Conformance: EPUB Accessibility, WCAG-AA

2.5 Certified By

Value: Textual Data from metadata

This technique relates to Certified By principle.

List: 196; Code: 93: Compliance certification by

2.5.1 Example 5.1

2.5.1.1 XPath

The value can be retrieve using XPath:

Example 9

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="93"]/ProductFormFeatureDescription/text()

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.5.1.2 UI

Certified By: http://www.certifier.com/

Note

2.6 Certifier Credential

Value: Potentially linked textual data from metadata

This technique relates to Certifier Credential principle.

Not available in ONIX

2.7 Certifier Report

Value: Potentially linked textual data from metadata

This technique relates to Certifier Report principle.

List: 196; Code: 94: Compliance web page for detailed accessibility information

If it is certified by a trusted intermediary, List: 196; Code: 95: Trusted intermediary’s web page for detailed accessibility information

If a publisher is self-certifying, List: 196; Code: 96: Publisher’s web page for detailed accessibility information

2.7.1 Example 6.1

2.7.1.1 XPath

The value can be retrieve using XPath:

Example 10

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="94"]/ProductFormFeatureDescription/text()

Example 11

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="95"]/ProductFormFeatureDescription/text()

Example 12

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="09" and ProductFormFeatureValue="96"]/ProductFormFeatureDescription/text()

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.7.1.2 UI

Certifier Report

2.8 Hazards

Values: flashing, motion simulation, sound, no flashing, no motion simulation, no sound, none, or Unknown.

This technique relates to Hazards principle.

ONIX uses a composite to indicate different hazards.

To list the presence or absence of hazards it is used the ProductFormFeature element, with ProductFormFeatureType equal to 12 ("US CPSIA or other international hazard warning", from code list 79) and ProductFormFeatureValue from code list 143.

2.8.1 Example 7.1

2.8.1.1 XPath

The value can be retrieve using XPath:

Example 15

//Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType="12"]/ProductFormFeatureValue

For this example, this XPath was evaluated on the ONIX record presented in EXAMPLE 1.

2.8.1.2 UI

Hazard: no Flashing, no Sound, no Motion Simulation

(because ProductFormFeature with ProductFormFeatureType equal to 12 and ProductFormFeatureValues equal to: 14, 16, 18)

2.9 All Accessibility Metadata

Value: Link to complete list of all metadata fields

This technique relates to All Accessibility Metadata principle.

For a complete list of ONIX accessibility metadata refer to the crosswalk.

Display Techniques for ONIX Accessibility Metadata 1.0

Final Community Group Report 27 September 2021

Abstract

Status of This Document

1. ONIX Metadata

1.1 ONIX record examples

1.1.1 ONIX record describing an EPUB

1.1.2 ONIX record describing an audiobook

2. Techniques

2.1 Screen Reader Friendly

2.1.1 Example 1.1

2.1.1.1 XPath

2.1.1.2 UI

2.2 Full Audio

2.2.1 Example 2.1

2.2.1.1 XPath

2.2.1.2 UI

2.2.2 Example 2.2

2.2.2.1 XPath

2.2.2.2 UI

2.3 Accessibility Summary

2.3.1 Example 3.1

2.3.1.1 XPath

2.3.1.2 UI

2.4 Accessibility Conformance

2.4.1 Example 4.1

2.4.1.1 XPath

2.4.1.2 UI

2.4.2 Example 4.2

2.4.2.1 XPath

2.4.2.2 UI

2.5 Certified By

2.5.1 Example 5.1

2.5.1.1 XPath

2.5.1.2 UI

2.6 Certifier Credential

2.7 Certifier Report

2.7.1 Example 6.1

2.7.1.1 XPath

2.7.1.2 UI

2.8 Hazards

2.8.1 Example 7.1

2.8.1.1 XPath

2.8.1.2 UI

2.9 All Accessibility Metadata

A. Acknowledgements

A.1 Contributors

A.2 Reviewers

A.3 Intellectual Property Rights