The accessibility of a publication is useful to know regardless of a person's abilities, as features such as the ability to make visual adjustments make for a better reading experience for everybody. This document proposes a shared framework for presenting publication accessibility metadata declarations in a user-friendly manner — to offer the information to end users in a way that is easy to understand regardless of their technical knowledge and is consistent across different publications and different digital catalogs.
+ GitHub Issues are preferred for
+ discussion of this specification.
+
+
+
+
1. Introduction
+
+
+
Reading a publication is a very personal experience. For most people this is routine, and little
+ consideration is given to how the title was obtained before it is read. Users may go to a bookstore, search for the
+ title to purchase online, or have the title selected for them by an instructor for a class.
+
+
Now consider that the person is blind and relies on assistive technology. The user needs that technology to assist them in
+ the purchase process as well as to read the publication. The person may wonder: will the screen reader work with
+ this title; are there image descriptions that will be spoken to describe these images; are there page
+ numbers which are accessible; is the reading order correct so a caution after reading a
+ paragraph which could be dangerous will be announced? All of these, and more accessibility concerns are potential issues
+ consumers have when trying to purchase and ultimately read a digital publication.
+
+
The good news is more and more publishers are creating publications that are Born Accessible (i.e.,
+ accessible from the outset, not fixed later) and getting the accessibility validation or audit done by
+ independent organizations.
+
+
+
+
2. General overview
+
+
+
This document helps those who wish to render accessibility metadata directly to users understand how to
+ represent the accessibility claims inherent in machine-readable accessibility metadata in a user-friendly User Interface / User Experience
+ (UI/UX). This document targets implementers such as bookstores, retailers, distributors etc. Content creators will benefit from reading these Principles and are encouraged to follow EPUB Accessibility 1.1 Conformance and Discoverability Requirements section and its techniques.
+
+
Note
+
This document presents high-level principles without going into technical issues related to the
+ different metadata standards in the publishing industry.
+
Therefore, techniques are available that illustrate to developers how to
+ retrieve data to show the information outlined in this document.
+
+
+
Metadata found either inside a digital publication or in a corresponding external record may have
+ important accessibility claims that helps end users find and determine if the publication can meet
+ their specific accessibility needs.
+
+
All accessibility metadata is meant to be machine-readable – apart from the accessibility summary - in
+ this way accessibility metadata can be extracted and displayed uniformly across different publications
+ and localized to different user interface languages.
+
+
One important aspect is that the role of the Accessibility Summary metadata has changed in the latest
+ version of the EPUB Accessibility specification, so a more in-depth analysis in the Accessibility summary section is recommended.
+
+
This document offers guidance on how to aggregate and display claims inherent in metadata to end users; these are not strict
+ guidelines, but suggestions for providing a consistent experience for users through different portals.
+ Different implementers may choose to implement these guidelines in a slightly different way, some examples
+ can be seen in the Implementations section of the document.
+
2.1 Accessibility claims and declarations
+
+
+
When presenting accessibility metadata provided by the publisher, it is suggested that the section is introduced using terms such as "claims" or "declarations." This heading should clearly convey to the end user that the information comes directly from the publisher and represents the accessibility information that the publisher intends to communicate.
+
+
+
+
2.2 Publisher metadata ecosystem
+
+
It is helpful to visualize the metadata workflow. The image below shows the path publisher's metadata takes to get to the end user through a distributor or library. The two paths visualized for EPUB accessibility metadata and ONIX correspond to the techniques referenced in the linked techniques documents.
+ The digital publication ecosystem has two main channels of "Metadata Delivery": "Embedded inside the EPUB", and "Thru the supply chain."
+
+ From the "Metadata Delivery" this flows into the "Accessibility Metadata spec" where from "Embedded inside the EPUB" flows into the "EPUB Accessibility Metadata 1.1 specification", and from "the supply chain" flows into the "ONIX Accessibility metadata." At this same level the "Crosswalk" links between the EPUB and ONIX metadata.
+
+ From here both flow down into the "Metadata Processing" layer where the EPUB metadata gets processed through the "Display Techniques for EPUB Accessibility Metadata", and the "ONIX accessibility metadata" is processed through the "Display Techniques for ONIX Accessibility Metadata."
+
+ Finally from the "Metadata Processing" layer both the Display Techniques for EPUB and ONIX flow into the "Resulting Statements" layer "User Experience Guide for Displaying Accessibility Metadata"
+
+
+
+
2.3 Metadata techniques
+
+
+
To assist developers in implementing these guidelines, in-depth notes are available to explain how to
+ extract information from publishing industry metadata standards.
+
+
At the time of publishing this document the available techniques for metadata standards are:
Publishers update their ONIX records as needed. We expect "unknown" accessibility metadata may be initially provided but may change as more information becomes available. For this reason, implementors should be prepared to update the accessibility metadata as new ONIX feeds are made available.
+
+
+
+
+
3. General information
+
+
To solve the problem of displaying the accessibility metadata in a human readable form, vendors will determine their correct statement to display (from the User Experience Guide) by parsing the metadata and using the appropriate Display Techniques document.
+
+
The product details provide precious information about the usability of the book in relation to specific user needs. The following information should always be displayed:
+
+
+
File format (EPUB 2 or 3, PDF, MP3, Audiobook, etc.)
+
Protection measure or lack thereof
+
+
Name of the publishing house
+
Main language of the content
+
+
+
3.1 Why this information is important for accessibility
+
+
+
The file format gives a strong indication of accessibility: an MP3 format audiobook will be less
+ structured than an Audiobook; a PDF does not allow for typography modification, EPUB 2 is deprecated, an EPUB 3 supports page navigation and better structural semantics, etc.
+
The protection measure may block assistive technologies such as screen readers. In addition, many
+ specific reading devices such as DAISY readers or Braille notepads are not equipped to read
+ encrypted files.
+
+
The name of the publishing house can highlight the efforts it has made in terms of accessibility.
+
The main language of the content enables readers to be confident that they will be able to read
+ with their Assistive Technology that uses synthesized voice or the corresponding Braille table for
+ the language.
+
+
+
+
+
4. Key accessibility information
+
+
+
Note
+
When the content creator does not provide any accessibility metadata for a publication, the three
+ pieces of key information that should always be present can still be shown (with an indication that
+ the information is missing): Visual adjustments, Supports nonvisual reading,
+ and Conformance.
+
+
+
Note
+
This document does not define the order in which to show the key accessibility information; each
+ implementer can decide the preferred order for showing the accessibility information that
+ follows.
+
+
4.1 Visual adjustments
+
+
+
Note
+
This key information should always be displayed, even if there is no metadata (See the examples where
+ the metadata is not known).
+
+
+
Indicates if users can modify the appearance of the text and the page layout according to the
+ possibilities offered by the reading system.
+
+
This field answers whether visual adjustments are possible, not possible, or unknown.
+
+
Readers with visual impairments or cognitive disabilities need the ability to change the color of
+ text and its background (contrast), the font family and font size used, as well as spacing between
+ letters, words, sentences, or paragraphs.
+
+
Knowing that a publication can reflow to fit the
+ reading system's display area is not sufficient to know that modifications to the font, spacing, and
+ colors are possible or that the changes will not cause other readability issues (e.g., text being
+ clipped by its container).
+
+
4.1.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.1.2 Display techniques for Visual adjustments support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information should always be displayed, even if there is no metadata (See the examples where
+ the metadata is not known).
+
+
+
Indicates whether all content required for comprehension can be consumed in text and therefore is
+ fully available to assistive technologies and reading systems using text-to-speech or electronic
+ braille functionality.
+
Note
+
The terms "electronic braille" and "refreshable braille" are used interchangeably, which denotes a
+ device with pop-up pins to present the braille on a tactile screen.
+
+
This field answers whether nonvisual reading is possible, not possible, or unknown.
+
+
Digital publications with essential content included in non-textual form (such as graphs, tables or
+ equations presented as images, videos, etc.) must include textual alternatives to ensure that users
+ reading with other senses than sight (mainly auditory and tactile) have access to the same
+ information as visual readers. These textual alternatives can include extended descriptions,
+ transcripts, captions, etc. depending on the nature of the nonvisual content.
+
+
4.2.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.2.2 Display techniques for nonvisual reading support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information should always be displayed, even if there is no metadata (See the examples where
+ the metadata is not known).
+
+
+
Identifies whether the digital publication claims to meet internationally recognized conformance
+ standards for accessibility.
+
+
Conformance metadata often uses terminology that most people will not understand, and therefore simple statements should be provided when EPUB accessibility and
+ WCAG levels are identified.
+
+
If the publication does not include a conformance claim,
+ the statement should indicate that the publication does not include a conformance statement.
+
+
In most cases, people will want to know more about the conformance and certification of the
+ publication. The certifying organization should be identified along with their credentials and
+ placed immediately after the conformance statement.
+
+
4.3.1 Conformance statements
+
+
The following list explains the meaning of each recommended conformance statement.
+
+
This publication exceeds accepted accessibility standards.
+
+
The publication contains a conformance statement that it meets the EPUB Accessibility and WCAG 2 Level AAA standard.
+
+
This publication meets accepted accessibility standards.
+
+
The publication contains a conformance statement that it meets the EPUB Accessibility and WCAG 2 Level AA standard.
+
+
+
This publication meets minimum accessibility standards.
+
+
The publication contains a conformance statement that it meets the EPUB Accessibility and WCAG 2 Level A standard.
+
+
+
+
The publication does not include a conformance statement.
+
+
The conformance metadata is missing and conformity to a standard of this publication is unknown.
+
+
+
Certifier's name
+
Identifies the organization providing the certification review or process for certification.
+
+
Certifier's Credentials
+
If the certifier has a badge or a credential, then the text is provided. If there is a link
+ to their credential, then this can be provided as a link. If the certifier has a logo or
+ badge, this can be displayed. The display of the logo or badge can be arranged between the
+ certifier and the distributor showing the accessibility metadata.
+
+
+
+
+
4.3.2 Detailed conformance information
+
+
+
The following information can be placed in a section that shows the details of the conformance
+ information.
+
+
+
Conformance Statement
+
Identifies the accessibility specification and the conformance level to which the
+ publication assertions are made. When the publication claims to conform to more than one
+ specification, additional conformance statements may be provided.
+
+
Certification date
+
If the date of the certifier's evaluation is provided, then this would be of interest. This
+ is normally associated with the certifier.
+
+
Certifier's Report
+
If a link to a report is provided, this may be of interest.
+
+
+
+
4.3.3 Examples
+
+
+
Three examples are provided for the conformance statement, one shows a statement that claims to
+ meet recommended accessibility standards and a second that claims to meet the minimum level. The
+ third example shows a publication with unknown accessibility.
+
+
The examples present the conformance statement, the certifier, the certifiers credentials and is
+ followed by the detailed conformance information section
+
+
+
+
+
+
+
+
+
+
+
4.3.4 Display techniques for conformance support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Indicates the presence of pre-recorded audio and specifies if this audio is standalone (an
+ audiobook), accompanies text (embedded audio and video clips), or represents an alternative to the
+ text (synchronized text-audio playback).
+
+
Audiobooks created for mainstream use provide important access for many users with disabilities even
+ though they are not accessible to all. As they grow in popularity, audiobooks may provide more
+ accessibility options in the future.
+
+
Some publications provide audio (including audio in video) in addition to text. In this case, it is
+ important that the user is informed that they may not be able to access all content in the book.
+
+
Some publications provide pre-recorded audio with text synchronization. Users with hearing
+ impairments still can access the full content of these books.
+
+
4.4.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.4.2 Display techniques for pre-recorded audio support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Identifies the navigation features included in the publication.
+
+
Offering different ways to navigate digital publications (table of contents, index, etc.) is
+ important to allow the user to easily access each part of the content. These features are both
+ essential for accessibility and very important for all users reading publications. Therefore,
+ clearly communicating to the user what navigation features are available in the publication is
+ important to enable proper selection.
+
+
Note that the Web Content Accessibility Guidelines (WCAG) 2.1 standard requires that more than one
+ way is available to locate a Web page within a set of Web pages (Success Criterion 2.4.5 Multiple
+ Ways).
+
+
4.5.1 Examples
+
+
+
The examples are provided as descriptive and compact explanations for flexibility of
+ adoption.
+
+
+
+
+
+
+
4.5.2 Display techniques for navigation support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Indicates the presence of formulas (including math, chemistry, etc.), graphs, charts, and diagrams
+ within the title and whether these are in an accessible format or available in an alternative form
+ (e.g., whether formulas are navigable with assistive technologies, or whether extended descriptions
+ are available for complex images).
+
+
This group should be displayed only if the metadata indicates the presence of formulas or charts and
+ graphs within the title, otherwise it can be hidden.
+
+
+
4.6.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.6.2 Display techniques for charts, diagrams, and formulas support
+
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Identifies any potential hazards (e.g., flashing elements, background sounds, and motion simulation)
+ that could afflict physiologically sensitive users.
+
+
Unlike other accessibility properties, the presence of hazards can be expressed either positively or
+ negatively. This is because users search for content that is safe for them as well as want to know
+ when content is potentially dangerous to them.
+
+
The hazards property vocabulary includes a value of unknown, which means the content creator of the metadata explicitly acknowledges that the resource has not been checked for hazards. This is different than providing no metadata for this property which does not carry any meaning.
+
+
+
4.7.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.7.2 Display techniques for hazards reporting
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
The accessibility summary was intended (in EPUB Accessibility 1.0) to describe in human-readable
+ prose the accessibility features present in the publication as well as any shortcomings. From EPUB
+ Accessibility version 1.1 the accessibility summary became a human-readable summary of the
+ accessibility that complements, but does not duplicate, the other discoverability metadata.
+
+
It is a free-form field that allows authors to add additional information to the accessible
+ properties of the resource.
+
+
Due to its nature, no specific processing of the content is required; it is sufficient to extract the
+ text from the metadata and display it to end users.
+
+
4.8.1 Examples
+
+
+
+
+
+
4.8.2 Display techniques for accessibility summary support
+
+
Specific techniques for meeting this principle are defined in the following documents:
Issue 350: Feedback requested on exceptions and exemptions from publishers
We are actively seeking comments on this "legal consideration" section. If you are a publisher, we want your feedback! Please visit the GitHub Issue tracking linked above to leave a comment.
+
+
Note
+
This key information should be hidden if metadata is not present .
+
+
+
Note
Disclaimer: nothing here may be construed as legal advice supplied by W3C or any the groups or individuals who have contributed to this document.
+Always get legal advice from in-house or your retained counsel to assess legal compliance and risk.
+
+
In some jurisdictions publishers may be able to claim an exemption from the provision of accessible publications, including the provision of accessibility metadata. This should always be subject to clarification by legal counsel for each jurisdiction.
+ One example of this, at time of writing, is from the European Accessibility Act (EAA) when the publisher is a micro-enterprise (i.e., enterprises employing fewer than 10 people and with annual turnover or balance sheet total not exceeding 2 million euro).
+
Other legal considerations currently included in the EAA may include exceptions on individual versions of a title, where jurisdiction will not require the title to be accessible if it involves a fundamental alteration of the content, or if making it accessible would place a disproportionate burden on the publisher. (This may vary in other jurisdictions).
+
+
Publishers may need to include information about an exemption or exception in metadata for legal or clarity reasons, either to bodies that enforce legislation or for other business to business communication. However this is not information that needs to be displayed on public sites as it does not mean anything to most consumers and could lead to misunderstandings. Nevertheless, the objective is to provide as much accessibility information as is possible.
+
+
4.9.1 Examples
+
+
TBD
+
+
+
+
+
4.9.2 Display techniques for legal considerations
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
This section lists additional metadata categories that can help users better understand the
+ accessibility characteristics of digital publications. These are for metadata that do not fit into
+ the other categories or are rarely used in trade publishing.
+
+
Additional accessibility information includes a wide range of information related to the
+ publication's content. Therefore, the features are grouped so that the presentation is more
+ understandable to end users.
+
+
+
Structure
+
+
For information on any structuring aids that facilitate use of a resource (e.g., ARIA).
+
+
Page breaks
+
The inclusion of page break markers from a print source allows users to identify where they are in a digital publication relative to its print equivalent.
+
Adaptation
+
+
For information on provisions in the content that enable reading in alternative access modes
+ (e.g., closed captions, ruby annotations, sign language, transcript).
+
+
+
+
Clarity
+
+
For information on ways that the content has been enhanced for improved auditory or visual
+ clarity (e.g., high contrast display).
+
+
+
Tactile
+
+
For information on content that is available in tactile form (e.g., tactile content, tactile
+ graphic, tactile objects).
+
+
+
+
Content
+
+
For information on specific types of content present in the digital publication (e.g., text
+ on visual, music on visual).
+
+
+
Other
+
+
For information that does not fall into one of the preceding categories (e.g., timing control
+ and color dependent).
+
+
+
+
4.10.1 Examples
+
+
Note
There are many features that may be present. Some of the features are listed in the examples. A complete list can be found in the techniques.
+
+
+
+
+
+
+
4.10.2 Display techniques for additional accessibility information
+
+
Specific techniques for meeting this principle are defined in the following documents:
The guidelines for presenting accessibility metadata detailed in this document are intended to improve
+ the user experience when readers browse the catalogue entry for a publication. However, accessibility
+ metadata also has a vital role to play in helping readers discover publications that are accessible to
+ them.
+
Publication providers, such as vendors and libraries create searching and filtering tools that interpret
+ accessibility metadata to aid in discovery. The set and variety of filters depend on the public they
+ address and the type of book they propose.
+
User feedback indicates that in the absence of specific accessibility filters, they find product details like file
+ format and protection measures (e.g., digital rights management) crucial information in determining usability.
+
Taking into consideration those realities, the following sections propose a minimum and an
+ extension set for filtering options. Mostly any specific information could be added if considered of use
+ for the public of the platform.
+
+
+
5.1 Minimum filtering set
+
+
Reading systems, commerce, and distribution platforms will typically have specific filtering
+ options; having uniformity for key aspects and providing guidance for a standardized approach can
+ help the discovery process for users searching for relevant titles. Accomplishing this, however, should
+ not prevent users with specific reading needs from finding books they are looking for. To achieve
+ this goal, it is recommended that all platforms present two minimum capabilities, centered around the
+ ways of consuming the content. These are:
+
+
Titles that support nonvisual reading
+
Titles that support visual adjustments
+
+
Of note, only the positive values should be used.
+
+
+
5.2 Extended filtering set
+
+
In specific domains, the addition of other options will become important to help users find content
+ that responds to a particular need or scenarios. Each domain case would uniquely drive the selection
+ of appropriate items. Some examples of these domains (not exclusive) are:
+
+
In an academic context, the presence of printed page numbers may be crucial to make sure the
+ reader will be able to find or make a reference.
+
In a technical or scientific context, the information about ways provided to access complex
+ contents like Charts, Diagrams, and Formulas would have a strong importance to know if
+ accessibility markup were present.
+
In markets where compliance to legislation is required, understanding conformity information
+ becomes mandatory.
+
Platforms dedicated to selling children's books and interactive content may want to allow users
+ to select books with no hazards or inform them about the presence of pre-recorded audio.
+
+
+
+
+
6. Localization
+
+
In these guidelines, we have used simple language to communicate the meaning of the metadata values.
+ Many people have contributed to the development of the words and phrases we have selected. We intend to
+ provide a mechanism for the publishing community to provide translations that localizes the strings
+ for equally effective communication in many languages. We understand that simply translating the
+ strings is not enough; the subtle meaning of the words and phrases of accessibility concepts must be
+ localized for maximum understanding.
+
For users seeking books, a seamless user experience is essential to avoid adding cognitive load to
+ the already complex task of understanding the included features and accessing the book.
+
The wording is part of the UX and similarities of wordings in language areas are as crucial as the
+ organization and categorization of the information.
+
The wording proposed in this guide has been widely discussed by a large group representing different
+ actors of the English-speaking geographies. It has been improved after proof-of-concept
+ implementations and reviewed by panels of testers.
+
To agree on linguistic areas wordings the actors should follow a localization framework. The UX guide
+ translation webpage will propose such framework and list translations with contextualization of the
+ localization process.
We are collecting information on companies and organizations that wish to possibly commit examples of their implementation. Please visit this GitHub issue to review companies and organizations that have put their name forward. To possibly volunteer an implementation, please put your company name, your name and your contact information.
+
These guidelines provide a general framework and make suggestions on the display of accessibility
+ metadata. It is not a normative description of what must be done. It is instructive to provide
+ examples of implementations from the community.
+
+
Linked below are static pages that show real-life implementations. We have captured these examples
+ from organization's websites that have agreed to allow us to showcase the work they have done to
+ display accessibility metadata.
The accessibility of a publication is useful to know regardless of a person's abilities, as features such as the ability to make visual adjustments make for a better reading experience for everybody. This document proposes a shared framework for presenting publication accessibility metadata declarations in a user-friendly manner — to offer the information to end users in a way that is easy to understand regardless of their technical knowledge and is consistent across different publications and different digital catalogs.
+ GitHub Issues are preferred for
+ discussion of this specification.
+
+
+
+
1. Introduction
+
+
+
Reading a publication is a very personal experience. For most people this is routine, and little
+ consideration is given to how the title was obtained before it is read. Users may go to a bookstore, search for the
+ title to purchase online, or have the title selected for them by an instructor for a class.
+
+
Now consider that the person is blind and relies on assistive technology. The user needs that technology to assist them in
+ the purchase process as well as to read the publication. The person may wonder: will the screen reader work with
+ this title; are there image descriptions that will be spoken to describe these images; are there page
+ numbers which are accessible; is the reading order correct so a caution after reading a
+ paragraph which could be dangerous will be announced? All of these, and more accessibility concerns are potential issues
+ consumers have when trying to purchase and ultimately read a digital publication.
+
+
The good news is more and more publishers are creating publications that are Born Accessible (i.e.,
+ accessible from the outset, not fixed later) and getting the accessibility validation or audit done by
+ independent organizations.
+
+
+
+
2. General overview
+
+
+
This document helps those who wish to render accessibility metadata directly to users understand how to
+ represent the accessibility claims inherent in machine-readable accessibility metadata in a user-friendly User Interface / User Experience
+ (UI/UX). This document targets implementers such as bookstores, retailers, distributors etc. Content creators will benefit from reading these Principles and are encouraged to follow EPUB Accessibility 1.1 Conformance and Discoverability Requirements section and its techniques.
+
+
Note
+
This document presents high-level principles without going into technical issues related to the
+ different metadata standards in the publishing industry.
+
Therefore, techniques are available that illustrate to developers how to
+ retrieve data to show the information outlined in this document.
+
+
+
Metadata found either inside a digital publication or in a corresponding external record may have
+ important accessibility claims that helps end users find and determine if the publication can meet
+ their specific accessibility needs.
+
+
All accessibility metadata is meant to be machine-readable – apart from the accessibility summary - in
+ this way accessibility metadata can be extracted and displayed uniformly across different publications
+ and localized to different user interface languages.
+
+
One important aspect is that the role of the Accessibility Summary metadata has changed in the latest
+ version of the EPUB Accessibility specification, so a more in-depth analysis in the Accessibility summary section is recommended.
+
+
This document offers guidance on how to aggregate and display claims inherent in metadata to end users; these are not strict
+ guidelines, but suggestions for providing a consistent experience for users through different portals.
+ Different implementers may choose to implement these guidelines in a slightly different way, some examples
+ can be seen in the Implementations section of the document.
+
2.1 Accessibility claims and declarations
+
+
+
When presenting accessibility metadata provided by the publisher, it is suggested that the section is introduced using terms such as "claims" or "declarations." This heading should clearly convey to the end user that the information comes directly from the publisher and represents the accessibility information that the publisher intends to communicate.
+
+
+
+
2.2 Publisher metadata ecosystem
+
+
It is helpful to visualize the metadata workflow. The image below shows the path publisher's metadata takes to get to the end user through a distributor or library. The two paths visualized for EPUB accessibility metadata and ONIX correspond to the techniques referenced in the linked techniques documents.
+ The digital publication ecosystem has two main channels of "Metadata Delivery": "Embedded inside the EPUB", and "Thru the supply chain."
+
+ From the "Metadata Delivery" this flows into the "Accessibility Metadata spec" where from "Embedded inside the EPUB" flows into the "EPUB Accessibility Metadata 1.1 specification", and from "the supply chain" flows into the "ONIX Accessibility metadata." At this same level the "Crosswalk" links between the EPUB and ONIX metadata.
+
+ From here both flow down into the "Metadata Processing" layer where the EPUB metadata gets processed through the "Display Techniques for EPUB Accessibility Metadata", and the "ONIX accessibility metadata" is processed through the "Display Techniques for ONIX Accessibility Metadata."
+
+ Finally from the "Metadata Processing" layer both the Display Techniques for EPUB and ONIX flow into the "Resulting Statements" layer "User Experience Guide for Displaying Accessibility Metadata"
+
+
+
+
2.3 Metadata techniques
+
+
+
To assist developers in implementing these guidelines, in-depth notes are available to explain how to
+ extract information from publishing industry metadata standards.
+
+
At the time of publishing this document the available techniques for metadata standards are:
Publishers update their ONIX records as needed. We expect "unknown" accessibility metadata may be initially provided but may change as more information becomes available. For this reason, implementors should be prepared to update the accessibility metadata as new ONIX feeds are made available.
+
+
+
+
+
3. General information
+
+
To solve the problem of displaying the accessibility metadata in a human readable form, vendors will determine their correct statement to display (from the User Experience Guide) by parsing the metadata and using the appropriate Display Techniques document.
+
+
The product details provide precious information about the usability of the book in relation to specific user needs. The following information should always be displayed:
+
+
+
File format (EPUB 2 or 3, PDF, MP3, Audiobook, etc.)
+
Protection measure or lack thereof
+
+
Name of the publishing house
+
Main language of the content
+
+
+
3.1 Why this information is important for accessibility
+
+
+
The file format gives a strong indication of accessibility: an MP3 format audiobook will be less
+ structured than an Audiobook; a PDF does not allow for typography modification, EPUB 2 is deprecated, an EPUB 3 supports page navigation and better structural semantics, etc.
+
The protection measure may block assistive technologies such as screen readers. In addition, many
+ specific reading devices such as DAISY readers or Braille notepads are not equipped to read
+ encrypted files.
+
+
The name of the publishing house can highlight the efforts it has made in terms of accessibility.
+
The main language of the content enables readers to be confident that they will be able to read
+ with their Assistive Technology that uses synthesized voice or the corresponding Braille table for
+ the language.
+
+
+
+
+
4. Key accessibility information
+
+
+
Note
+
When the content creator does not provide any accessibility metadata for a publication, the three
+ pieces of key information that should always be present can still be shown (with an indication that
+ the information is missing): Visual adjustments, Supports nonvisual reading,
+ and Conformance.
+
+
+
Note
+
This document does not define the order in which to show the key accessibility information; each
+ implementer can decide the preferred order for showing the accessibility information that
+ follows.
+
+
4.1 Visual adjustments
+
+
+
Note
+
This key information should always be displayed, even if there is no metadata (See the examples where
+ the metadata is not known).
+
+
+
Indicates if users can modify the appearance of the text and the page layout according to the
+ possibilities offered by the reading system.
+
+
This field answers whether visual adjustments are possible, not possible, or unknown.
+
+
Readers with visual impairments or cognitive disabilities need the ability to change the color of
+ text and its background (contrast), the font family and font size used, as well as spacing between
+ letters, words, sentences, or paragraphs.
+
+
Knowing that a publication can reflow to fit the
+ reading system's display area is not sufficient to know that modifications to the font, spacing, and
+ colors are possible or that the changes will not cause other readability issues (e.g., text being
+ clipped by its container).
+
+
4.1.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.1.2 Display techniques for Visual adjustments support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information should always be displayed, even if there is no metadata (See the examples where
+ the metadata is not known).
+
+
+
Indicates whether all content required for comprehension can be consumed in text and therefore is
+ fully available to assistive technologies and reading systems using text-to-speech or electronic
+ braille functionality.
+
Note
+
The terms "electronic braille" and "refreshable braille" are used interchangeably, which denotes a
+ device with pop-up pins to present the braille on a tactile screen.
+
+
This field answers whether nonvisual reading is possible, not possible, or unknown.
+
+
Digital publications with essential content included in non-textual form (such as graphs, tables or
+ equations presented as images, videos, etc.) must include textual alternatives to ensure that users
+ reading with other senses than sight (mainly auditory and tactile) have access to the same
+ information as visual readers. These textual alternatives can include extended descriptions,
+ transcripts, captions, etc. depending on the nature of the nonvisual content.
+
+
4.2.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.2.2 Display techniques for nonvisual reading support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information should always be displayed, even if there is no metadata (See the examples where
+ the metadata is not known).
+
+
+
Identifies whether the digital publication claims to meet internationally recognized conformance
+ standards for accessibility.
+
+
Conformance metadata often uses terminology that most people will not understand, and therefore simple statements should be provided when EPUB accessibility and
+ WCAG levels are identified.
+
+
If the publication does not include a conformance claim,
+ the statement should indicate that the publication does not include a conformance statement.
+
+
In most cases, people will want to know more about the conformance and certification of the
+ publication. The certifying organization should be identified along with their credentials and
+ placed immediately after the conformance statement.
+
+
4.3.1 Conformance statements
+
+
The following list explains the meaning of each recommended conformance statement.
+
+
This publication exceeds accepted accessibility standards.
+
+
The publication contains a conformance statement that it meets the EPUB Accessibility and WCAG 2 Level AAA standard.
+
+
This publication meets accepted accessibility standards.
+
+
The publication contains a conformance statement that it meets the EPUB Accessibility and WCAG 2 Level AA standard.
+
+
+
This publication meets minimum accessibility standards.
+
+
The publication contains a conformance statement that it meets the EPUB Accessibility and WCAG 2 Level A standard.
+
+
+
+
The publication does not include a conformance statement.
+
+
The conformance metadata is missing and conformity to a standard of this publication is unknown.
+
+
+
Certifier's name
+
Identifies the organization providing the certification review or process for certification.
+
+
Certifier's Credentials
+
If the certifier has a badge or a credential, then the text is provided. If there is a link
+ to their credential, then this can be provided as a link. If the certifier has a logo or
+ badge, this can be displayed. The display of the logo or badge can be arranged between the
+ certifier and the distributor showing the accessibility metadata.
+
+
+
+
+
4.3.2 Detailed conformance information
+
+
+
The following information can be placed in a section that shows the details of the conformance
+ information.
+
+
+
Conformance Statement
+
Identifies the accessibility specification and the conformance level to which the
+ publication assertions are made. When the publication claims to conform to more than one
+ specification, additional conformance statements may be provided.
+
+
Certification date
+
If the date of the certifier's evaluation is provided, then this would be of interest. This
+ is normally associated with the certifier.
+
+
Certifier's Report
+
If a link to a report is provided, this may be of interest.
+
+
+
+
4.3.3 Examples
+
+
+
Three examples are provided for the conformance statement, one shows a statement that claims to
+ meet recommended accessibility standards and a second that claims to meet the minimum level. The
+ third example shows a publication with unknown accessibility.
+
+
The examples present the conformance statement, the certifier, the certifiers credentials and is
+ followed by the detailed conformance information section
+
+
+
+
+
+
+
+
+
+
+
4.3.4 Display techniques for conformance support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Indicates the presence of pre-recorded audio and specifies if this audio is standalone (an
+ audiobook), accompanies text (embedded audio and video clips), or represents an alternative to the
+ text (synchronized text-audio playback).
+
+
Audiobooks created for mainstream use provide important access for many users with disabilities even
+ though they are not accessible to all. As they grow in popularity, audiobooks may provide more
+ accessibility options in the future.
+
+
Some publications provide audio (including audio in video) in addition to text. In this case, it is
+ important that the user is informed that they may not be able to access all content in the book.
+
+
Some publications provide pre-recorded audio with text synchronization. Users with hearing
+ impairments still can access the full content of these books.
+
+
4.4.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.4.2 Display techniques for pre-recorded audio support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Identifies the navigation features included in the publication.
+
+
Offering different ways to navigate digital publications (table of contents, index, etc.) is
+ important to allow the user to easily access each part of the content. These features are both
+ essential for accessibility and very important for all users reading publications. Therefore,
+ clearly communicating to the user what navigation features are available in the publication is
+ important to enable proper selection.
+
+
Note that the Web Content Accessibility Guidelines (WCAG) 2.1 standard requires that more than one
+ way is available to locate a Web page within a set of Web pages (Success Criterion 2.4.5 Multiple
+ Ways).
+
+
4.5.1 Examples
+
+
+
The examples are provided as descriptive and compact explanations for flexibility of
+ adoption.
+
+
+
+
+
+
+
4.5.2 Display techniques for navigation support
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Indicates the presence of formulas (including math, chemistry, etc.), graphs, charts, and diagrams
+ within the title and whether these are in an accessible format or available in an alternative form
+ (e.g., whether formulas are navigable with assistive technologies, or whether extended descriptions
+ are available for complex images).
+
+
This group should be displayed only if the metadata indicates the presence of formulas or charts and
+ graphs within the title, otherwise it can be hidden.
+
+
+
4.6.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.6.2 Display techniques for charts, diagrams, and formulas support
+
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
Identifies any potential hazards (e.g., flashing elements, background sounds, and motion simulation)
+ that could afflict physiologically sensitive users.
+
+
Unlike other accessibility properties, the presence of hazards can be expressed either positively or
+ negatively. This is because users search for content that is safe for them as well as want to know
+ when content is potentially dangerous to them.
+
+
The hazards property vocabulary includes a value of unknown, which means the content creator of the metadata explicitly acknowledges that the resource has not been checked for hazards. This is different than providing no metadata for this property which does not carry any meaning.
+
+
+
4.7.1 Examples
+
+
+
The examples are provided as lists of possible descriptive and compact explanations for
+ flexibility of adoption.
+
+
+
+
+
+
+
4.7.2 Display techniques for hazards reporting
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
The accessibility summary was intended (in EPUB Accessibility 1.0) to describe in human-readable
+ prose the accessibility features present in the publication as well as any shortcomings. From EPUB
+ Accessibility version 1.1 the accessibility summary became a human-readable summary of the
+ accessibility that complements, but does not duplicate, the other discoverability metadata.
+
+
It is a free-form field that allows authors to add additional information to the accessible
+ properties of the resource.
+
+
Due to its nature, no specific processing of the content is required; it is sufficient to extract the
+ text from the metadata and display it to end users.
+
+
4.8.1 Examples
+
+
+
+
+
+
4.8.2 Display techniques for accessibility summary support
+
+
Specific techniques for meeting this principle are defined in the following documents:
Issue 350: Feedback requested on exceptions and exemptions from publishers
We are actively seeking comments on this "legal consideration" section. If you are a publisher, we want your feedback! Please visit the GitHub Issue tracking linked above to leave a comment.
+
+
Note
+
This key information should be hidden if metadata is not present .
+
+
+
Note
Disclaimer: nothing here may be construed as legal advice supplied by W3C or any the groups or individuals who have contributed to this document.
+Always get legal advice from in-house or your retained counsel to assess legal compliance and risk.
+
+
In some jurisdictions publishers may be able to claim an exemption from the provision of accessible publications, including the provision of accessibility metadata. This should always be subject to clarification by legal counsel for each jurisdiction.
+ One example of this, at time of writing, is from the European Accessibility Act (EAA) when the publisher is a micro-enterprise (i.e., enterprises employing fewer than 10 people and with annual turnover or balance sheet total not exceeding 2 million euro).
+
Other legal considerations currently included in the EAA may include exceptions on individual versions of a title, where jurisdiction will not require the title to be accessible if it involves a fundamental alteration of the content, or if making it accessible would place a disproportionate burden on the publisher. (This may vary in other jurisdictions).
+
+
Publishers may need to include information about an exemption or exception in metadata for legal or clarity reasons, either to bodies that enforce legislation or for other business to business communication. However this is not information that needs to be displayed on public sites as it does not mean anything to most consumers and could lead to misunderstandings. Nevertheless, the objective is to provide as much accessibility information as is possible.
+
+
4.9.1 Examples
+
+
TBD
+
+
+
+
+
4.9.2 Display techniques for legal considerations
+
+
Specific techniques for meeting this principle are defined in the following documents:
This key information can be hidden if metadata is missing.
+
+
+
This section lists additional metadata categories that can help users better understand the
+ accessibility characteristics of digital publications. These are for metadata that do not fit into
+ the other categories or are rarely used in trade publishing.
+
+
Additional accessibility information includes a wide range of information related to the
+ publication's content. Therefore, the features are grouped so that the presentation is more
+ understandable to end users.
+
+
+
Structure
+
+
For information on any structuring aids that facilitate use of a resource (e.g., ARIA).
+
+
Page breaks
+
The inclusion of page break markers from a print source allows users to identify where they are in a digital publication relative to its print equivalent.
+
Adaptation
+
+
For information on provisions in the content that enable reading in alternative access modes
+ (e.g., closed captions, ruby annotations, sign language, transcript).
+
+
+
+
Clarity
+
+
For information on ways that the content has been enhanced for improved auditory or visual
+ clarity (e.g., high contrast display).
+
+
+
Tactile
+
+
For information on content that is available in tactile form (e.g., tactile content, tactile
+ graphic, tactile objects).
+
+
+
+
Content
+
+
For information on specific types of content present in the digital publication (e.g., text
+ on visual, music on visual).
+
+
+
Other
+
+
For information that does not fall into one of the preceding categories (e.g., timing control
+ and color dependent).
+
+
+
+
4.10.1 Examples
+
+
Note
There are many features that may be present. Some of the features are listed in the examples. A complete list can be found in the techniques.
+
+
+
+
+
+
+
4.10.2 Display techniques for additional accessibility information
+
+
Specific techniques for meeting this principle are defined in the following documents:
The guidelines for presenting accessibility metadata detailed in this document are intended to improve
+ the user experience when readers browse the catalogue entry for a publication. However, accessibility
+ metadata also has a vital role to play in helping readers discover publications that are accessible to
+ them.
+
Publication providers, such as vendors and libraries create searching and filtering tools that interpret
+ accessibility metadata to aid in discovery. The set and variety of filters depend on the public they
+ address and the type of book they propose.
+
User feedback indicates that in the absence of specific accessibility filters, they find product details like file
+ format and protection measures (e.g., digital rights management) crucial information in determining usability.
+
Taking into consideration those realities, the following sections propose a minimum and an
+ extension set for filtering options. Mostly any specific information could be added if considered of use
+ for the public of the platform.
+
+
+
5.1 Minimum filtering set
+
+
Reading systems, commerce, and distribution platforms will typically have specific filtering
+ options; having uniformity for key aspects and providing guidance for a standardized approach can
+ help the discovery process for users searching for relevant titles. Accomplishing this, however, should
+ not prevent users with specific reading needs from finding books they are looking for. To achieve
+ this goal, it is recommended that all platforms present two minimum capabilities, centered around the
+ ways of consuming the content. These are:
+
+
Titles that support nonvisual reading
+
Titles that support visual adjustments
+
+
Of note, only the positive values should be used.
+
+
+
5.2 Extended filtering set
+
+
In specific domains, the addition of other options will become important to help users find content
+ that responds to a particular need or scenarios. Each domain case would uniquely drive the selection
+ of appropriate items. Some examples of these domains (not exclusive) are:
+
+
In an academic context, the presence of printed page numbers may be crucial to make sure the
+ reader will be able to find or make a reference.
+
In a technical or scientific context, the information about ways provided to access complex
+ contents like Charts, Diagrams, and Formulas would have a strong importance to know if
+ accessibility markup were present.
+
In markets where compliance to legislation is required, understanding conformity information
+ becomes mandatory.
+
Platforms dedicated to selling children's books and interactive content may want to allow users
+ to select books with no hazards or inform them about the presence of pre-recorded audio.
+
+
+
+
+
6. Localization
+
+
In these guidelines, we have used simple language to communicate the meaning of the metadata values.
+ Many people have contributed to the development of the words and phrases we have selected. We intend to
+ provide a mechanism for the publishing community to provide translations that localizes the strings
+ for equally effective communication in many languages. We understand that simply translating the
+ strings is not enough; the subtle meaning of the words and phrases of accessibility concepts must be
+ localized for maximum understanding.
+
For users seeking books, a seamless user experience is essential to avoid adding cognitive load to
+ the already complex task of understanding the included features and accessing the book.
+
The wording is part of the UX and similarities of wordings in language areas are as crucial as the
+ organization and categorization of the information.
+
The wording proposed in this guide has been widely discussed by a large group representing different
+ actors of the English-speaking geographies. It has been improved after proof-of-concept
+ implementations and reviewed by panels of testers.
+
To agree on linguistic areas wordings the actors should follow a localization framework. The UX guide
+ translation webpage will propose such framework and list translations with contextualization of the
+ localization process.
We are collecting information on companies and organizations that wish to possibly commit examples of their implementation. Please visit this GitHub issue to review companies and organizations that have put their name forward. To possibly volunteer an implementation, please put your company name, your name and your contact information.
+
These guidelines provide a general framework and make suggestions on the display of accessibility
+ metadata. It is not a normative description of what must be done. It is instructive to provide
+ examples of implementations from the community.
+
+
Linked below are static pages that show real-life implementations. We have captured these examples
+ from organization's websites that have agreed to allow us to showcase the work they have done to
+ display accessibility metadata.
+ GitHub Issues are preferred for
+ discussion of this specification.
+
+
+
+
1. EPUB Accessibility Metadata
+
+
+
This metadata as outlined in EPUB Accessibility 1.1 [epub-a11y-11], can be found in the EPUB package document [EPUB-33].
+
+
Note
+
+
Note
+
+
1.1 EPUB Accessibility Metadata Examples
+
+
1.1.1 EPUB accessibility metadata describing an EPUB
+
+
Here is an example of accessibility metadata embedded within the package document,
+ 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.
+
+
+
+
1.1.2 EPUB accessibility metadata describing an audiobook
+
+
+
Here is an example of an accessibility OPF Metadata for describing an audiobook, 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.
+
+
+
+
+
+
2. Conventions for implementations
+
+
The code conventions used in the provided code snippet follow a structure commonly found in programming languages like Python, Java, or C++. Here's an explanation of the conventions:
+
+
Conditionals and Control Flow:
+
IF, ELSE IF, and ELSE (in bold and capital letters) statements are used to define different conditions and the corresponding actions to be taken.
+
Operators:
+
Written operators (is present) are used to check if a particular code or codelist is present (or not) in the metadata record.
+
Logical operators:
+
Logical operators (AND, OR, NOT, in bold and capital letters) are used to combine conditions.
+
String Literals:
+
String literals are used to represent the text that should be displayed when a particular condition is met.
+
Variable Naming:
+
The terms like "property" and "value" are used in a way that suggests a variable or data structure representing the metadata record.
+
Indentation:
+
The code uses consistent indentation to define blocks of code within conditional statements. This is crucial for readability and maintaining a clear structure.
+
Readability:
+
The code is written in a way that is intended to be easily readable and understandable even by non-coders.
+
+
+
+
3. Common Functions
+
+
In this section we define the functions common to all techniques, which are called by them during execution.
+
3.1 Preprocessing
+
+
Before working directly with the metadata we must read the metadata in the Package document (package document) inside the EPUB. This is a common starting point for all techniques that allows us to query the metadata directly.
+
Note
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
To generate the internal representation, run the following steps:
+
+
LETpackage_document_content be textual representation of the Package document for the publication given package_document_as_text.
+
LETpackage_document be the DOM tree that results from parsing package_document_content using an XML DOM parser.
+
Return package_document.
+
+
+
+
3.2 Check for Node
+
+
Many of the techniques rely on checking for the presence or absence of metadata in the metadata section of the Package document.
+
+
Note
+
+
This algorithm takes:
+
+
the package_document argument: the internal representation of the Package document (output of preprocessing);
+
the path argument: the XPATH of the node to check the presence of.
+
+
To check for node, run the following steps:
+
+
+ IFpackage_document contains path:
+ THEN return True.
+
+
ELSE return False.
+
+
+
3.3 Join array to comma list
+
+
This function serves to concatenate an array of strings, separating each element with a comma, with the last element separated by an ", and" (this string is localizable).
+
For example if the input array has elements ["one", "two", "three"], then the output is going to be "one, two, and three".
+
This algorithm takes the string_array argument: the list of string to join.
+
To join the array, run the following steps:
+
+
LEToutput_string be the result of:
+
+
calling join on string_array with the separator ", "
+
replacing the last occurrence of ", " with ", and ".
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
+
4.1.1 Understanding the variables
+
+
all_textual_content_can_be_modified
+
+
If true it indicates that the accessibilityFeature="displayTransformability" (All textual content can be modified) is present in the package document, otherwise if false it means that the metadata is not present.
+
All textual content can be modified means that the digital publication does not restrict the ability of users to modify and reflow the display of any textual content to the full extent allowed by the reading system (i.e. to change the text size or typeface, line height and word spacing, colors).
+
+
is_fixed_layout
+
+
If true it indicates that the layout="pre-paginated" (Fixed format) is present in the package document, otherwise if false it means that the metadata is not present.
+
Fixed format means that digital publication is in fixed format (e.g. EPUB Fixed Layout).
+
+
+
+
4.1.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETall_textual_content_can_be_modified be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="displayTransformability"].
+
+
LETis_fixed_layout be the result of calling check for node on package_document, /package/metadata/meta[@property="rendition:layout" and text()="pre-paginated"].
+
+
+
4.1.3 Instructions
+
+
+ IFall_textual_content_can_be_modified:
+ THEN display "Appearance can be modified".
+
+
+ ELSE IFis_fixed_layout:
+ THEN display "Appearance cannot be modified".
+
+
ELSE display "Appearance modifiability not known".
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
4.2.1 Understanding the variables
+
+
all_necessary_content_textual
+
+
If true it indicates that the accessModeSufficient="textual" (all main content is provided in textual form) is present in the package document, otherwise if false it means that the metadata is not present.
+
All non-decorative content supports reading without sight means that all contents of the digital publication necessary to use and understanding, including text, images (via their alternative descriptions), audio and video material (via their transcripts, descriptions, captions or subtitles) are fully accessible via suitable reading devices, for example text-to-speech screen readers or tactile reading devices (‘Braille displays’), and nothing in the digital publication prevents or blocks the use of alternative reading modes. The entire publication can be navigated and ‘read’ using only text rendered via sound or touch, and does not require visual perception.
+
+
non_textual_content_images
+
+
If true it indicates that at least one of the following is present in the package document:
+
+
accessMode="chartOnVisual" (Charts and Graphs);
+
accessMode="chemOnVisual" (Chemistry);
+
accessMode="diagramOnVisual" (Diagrams);
+
accessMode="mathOnVisual" (Math);
+
accessMode="musicOnVisual" (Music);
+
accessMode="textOnVisual" (Images of text);
+
otherwise if false it means that this metadata is not present.
+
+
This means that the content contains images of any type.
+
+
textual_alternative_images
+
+
If true it indicates that at least one of the following is present in the package document:
+
+
accessibilityFeature="alternativeText" (Short alternative textual descriptions);
+
accessibilityFeature="longDescription" (Full alternative textual descriptions);
+
accessibilityFeature="describedMath" (Visual of math fully described));
+
otherwise if false it means that this metadata is not present.
+
+
This means that there are textual alternatives for images.
+
+
+
4.2.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETall_necessary_content_textual be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessModeSufficient" and text()="textual"].
+
+ LETnon_textual_content_images be the result of calling check for node on
+ package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and (text()="chartOnVisual" or text()="chemOnVisual" or
+ text()="diagramOnVisual" or text()="mathOnVisual" or
+ text()="musicOnVisual" or text()="textOnVisual")].
+
+
+
LETtextual_alternative_images be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and (text()="longDescription" or text()="alternativeText" or text()="describedMath")].
+
+
+
+
4.2.3 Instructions
+
+
+ IFall_necessary_content_textual:
+ THEN display "Readable in read aloud and braille".
+
+
+ ELSE IFnon_textual_content_imagesANDNOTtextual_alternative_images:
+ THEN display "Not fully readable in read aloud and braille".
+
+
ELSE display "May not be fully readable in read aloud and braille".
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.3.1 Understanding the variables
+
+
epub_accessibility_1_0
+
+
If true it indicates that the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a" (EPUB Accessibility Specification 1.0 A) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa" (EPUB Accessibility Specification 1.0 AA) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa" (EPUB Accessibility Specification 1.0 AAA) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with either the requirements of EPUB Accessibility Spec 1.0, at level A, AA, or AAA.
+
+
epub_accessibility_1_1
+
+
If true it indicates that the conformsTo contains "EPUB Accessibility 1.1" (EPUB Accessibility Specification 1.1) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of EPUB Accessibility Spec 1.1.
+
+
wcag_20
+
+
If true it indicates that the conformsTo contains "WCAG 2.0" or conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a" (EPUB Accessibility Specification 1.0 A) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa" (EPUB Accessibility Specification 1.0 AA) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa" (EPUB Accessibility Specification 1.0 AAA) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.0 or with the requirements of EPUB Accessibility Spec 1.0 (at level A, AA, or AAA). This is because being compliant with EPUB Accessibility 1.0 specification means at least being compliant with WCAG 2.0 specification.
+
+
wcag_21
+
+
If true it indicates that the conformsTo contains "WCAG 2.1" is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.1.
+
+
wcag_22
+
+
If true it indicates that the conformsTo contains "WCAG 2.2" is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.2.
+
+
level_a
+
+
If true it indicates that the conformsTo contains "Level A" or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a" (EPUB Accessibility Specification 1.0 A) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level A or with the requirements of EPUB Accessibility Spec 1.0 level A.
+
+
level_aa
+
+
If true it indicates that the conformsTo contains "Level AA" or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa" (EPUB Accessibility Specification 1.0 AA) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AA or with the requirements of EPUB Accessibility Spec 1.0 level AA.
+
+
level_aaa
+
+
If true it indicates that the conformsTo contains "Level AAA" or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa" (EPUB Accessibility Specification 1.0 A) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AAA or with the requirements of EPUB Accessibility Spec 1.0 level AAA.
+
+
certifier
+
+
Returns the description of a11y:certifiedBy (Compliance certification by (name)) if present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the name of the organization responsible for compliance testing and certification of the product is present.
+
+
certifier_credentials
+
+
Returns the description of a11y:certifierCredential (Compliance certification by (URL)) if present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the the URL of a web page belonging to an organization responsible for compliance testing and certification of the product is present – typically a ‘home page’ or a page describing the certification scheme itself.
+
+
certification_date
+
+
Returns the description of dcterms:date if that date property is associated with the a11y:certifiedBy (Latest accessibility assessment date) if present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the date of the latest assessment or re-assessment of the accessibility of the product is present.
+
+
certifier_report
+
+
Returns the description of a11y:certifierReport (Compliance web page for detailed accessibility information) if present in the OPF, otherwise if false it means that the metadata is not present.
+
This means that is present the URL of a compliance web page for detailed accessibility information. The web page should be maintained by an independent compliance scheme or testing organization. Note the web page may include information about specific national requirements or voluntary conformance reports.
+
+
conformance-claimed
+
+
If true it indicates that the conformsTo is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms to some specification.
+
+
+
+
+
4.3.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETepub_accessibility_1_0 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-"].
+
+
LETepub_accessibility_1_1 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), "EPUB Accessibility 1.1")].
+
+
LETwcag_20 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), "WCAG 2.0")]
+
+
LETwcag_21 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), WCAG 2.1")].
+
+
LETwcag_22 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), WCAG 2.2")].
+
+
LETlevel_a be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), Level A")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and text()=http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a"].
+
+
LETlevel_aa be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), Level AA")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and text()=http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa"].
+
+
LETlevel_aaa be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), Level AAA")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and text()=http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa"].
+
+
+
LETcertifier be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifiedBy"]/text().
+
+
LETcertifier_credentials be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifierCredential"]/text().
+
+
LETcertification_date be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="dcterms:date" and @refines=//meta[@property="a11y:certifiedBy"]/@id]/text()].
+
+
LETcertifier_report be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifierReport"]/text()].
+
+
LETconformance_claimed be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo"].
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.4.1 Understanding the variables
+
+
all_content_audio
+
+
If true it indicates that the accessModeSufficient="auditory" (all main content is provided in audio form) is present in the package document, otherwise if false it means that the metadata is not present.
+
+
synchronised_pre_recorded_audio
+
+
If true it indicates that the accessibilityFeature="sychronizedAudioText" is present in the package document, otherwise, if false, it means that the metadata is not present.
+
This indicates that text-synchronised pre-recorded audio narration (natural or synthesised voice) is included for substantially all textual matter, including all alternative descriptions, e.g. via a SMIL media overlay.
+
+
+
audio_content
+
+
If true it indicates that the accessMode="auditory" is present in the package document, otherwise, if false, it means that the metadata is not present.
+
+
This indicates that pre-recorded audio content is included as part of the work.
+
+
+
+
+
4.4.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETall_content_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessModeSufficient" and text()="auditory"].
+
+
LETsynchronised_pre_recorded_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="sychronizedAudioText"].
+
+
LETaudio_content be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessMode" and text()="auditory"].
+
+
+
4.4.3 Instructions
+
+
+ IFall_content_audio:
+ THEN display "Audio only".
+
+
+ ELSE IFsynchronised_pre_recorded_audio:
+ THEN display "Synchronized audio and text".
+
+
+ ELSE IFaudio_content:
+ THEN display "Complementary audio and text".
+
+
+
+ ELSE either omit this key informtion if metadata is missing or display "No information about pre-recorded audio".
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.5.1 Understanding the variables
+
+
table_of_contents_navigation
+
+
If true it indicates that the accessibilityFeature="tableOfContents" (Table of contents navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
+
This means that the resource includes a table of contents that provides links to the major sections of the content.
+
+
index_navigation
+
+
If true it indicates that the accessibilityFeature="index" (Index navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
+
This means that there is an index that provides direct (eg hyperlinked) access to uses of the index terms in the document body.
+
+
page_navigation
+
+
If true it indicates that the accessibilityFeature="pageNavigation" (Page Navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the e-publication includes a means of navigating to static page break locations.
+
+
next_previous_structural_navigation
+
+
If true it indicates that the accessibilityFeature="structuralNavigation" (Next / Previous structural navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that all levels of heading and other structural elements of the content are correctly marked up and (if applicable) numbered, to enable fast next heading / previous heading, next chapter / previous chapter navigation without returning to the table of contents.
+
+
+
4.5.2 Variables setup
+
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETtable_of_contents_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tableOfContents"].
+
+
LETindex_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="index"].
+
+
LETpage_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="pageNavigation"].
+
+
LETnext_previous_structural_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="structuralNavigation"].
+
+
+
4.5.3 Instructions
+
+
+ IFtable_of_contents_navigationORindex_navigationORprint_equivalent_page_numberingORnext_previous_structural_navigation:
+ THENLETnavigation be an empty array.
+
+
+ IFtable_of_contents_navigation:
+ THENAPPEND"table of contents" to navigation.
+
+
+ IFindex_navigation:
+ THENAPPEND"index" to navigation.
+
+
+ IFpage_navigation:
+ THENAPPEND"supports page navigation" to navigation.
+
+
+ IFnext_previous_structural_navigation:
+ THENAPPEND"structural navigation" to navigation.
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
4.6.1 Understanding the variables
+
+
contains_charts_diagrams
+
+
If true it indicates that the accessibilityFeature="chartOnVisual" (charts encoded in visual form) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has some information conveyed via some form of illustration, such as a graph, a chart, a diagram, a figure, etc).
+
+
long_text_descriptions
+
+
If true it indicates that the accessibilityFeature="longDescriptions" (Full alternative textual description) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that a full alternative textual description has been supplied for all of the graphs, charts, diagrams, or figures necessary to understand the content.
+
+
contains_chemical_formula
+
+
If true it indicates that the accessibilityFeature="chemOnVisual" (Chemical content) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains chemical notations, formulae.
+
+
chemical_formula_as_chemml
+
+
If true it indicates that the accessibilityFeature="ChemML" (Accessible chemistry content as ChemML) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using ChemML and works with compatible assistive technology.
+
+
contains_math_formula
+
+
If true it indicates that the accessibilityFeature="describedMath" (Mathematical content) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains mathematical notation, equations, formulae.
+
+
math_formula_as_latex
+
+
If true it indicates that the accessibilityFeature="latex" (Accessible math content as LaTeX) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using LaTeX and works with compatible assistive technology.
+
+
math_formula_as_mathml
+
+
If true it indicates that the accessibilityFeature="MathML" (Accessible math content as MathML) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that all mathematical content is presented using MathML and works with compatible assistive technology.
+
+
+
4.6.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETcontains_charts_diagrams be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="chartOnVisual"].
+
+
LETlong_text_descriptions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="longDescriptions"].
+
+
LETcontains_chemical_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="chemOnVisual"].
+
+
LETchemical_formula_as_chemml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="ChemML"].
+
+
+
LETcontains_math_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="describedMath"].
+
+
LETmath_formula_as_latex be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="latex"].
+
+
LETmath_formula_as_mathml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="MathML"].
+
+
4.6.3 Instructions
+
+
+ IF (contains_charts_diagramsANDlong_text_descriptions):
+ THEN display "Charts and diagrams have extended descriptions".
+
+
+ IFchemical_formula_as_chemml:
+ THEN display "Accessible chemistry content".
+
+
+ IFmath_formula_as_latexORmath_formula_as_mathml:
+ THEN display "Accessible math content".
+
+
+ IF (contains_charts_diagramsORcontains_chemical_formulaORcontains_math_formula) ANDNOT (long_text_descriptionsORchemical_formula_as_chemmlORmath_formula_as_latexORmath_formula_as_mathml):
+ THEN display "Accessibility of formulas, charts, and diagrams unknown".
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.7.1 Understanding the variables
+
+
no_hazards_or_warnings_confirmed
+
+
If true it indicates that the accessibilityHazard="none" (no accessibility hazards) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no associated hazard warnings with this product.
+
+
flashing_hazard
+
+
If true it indicates that the accessibilityHazard="flashing" (WARNING - Flashing hazards) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a flashing hazard which must be displayed.
+
+
no_flashing_hazards
+
+
If true it indicates that the accessibilityHazard="noFlashingHazard" (No flashing hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no flashing hazards associated with this product.
+
+
motion_simulation_hazard
+
+
If true it indicates that the accessibilityHazard="motionSimulation" (WARNING - Motion simulation hazard) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a motion simulation hazard which must be displayed.
+
+
no_motion_hazards
+
+
If true it indicates that the accessibilityHazard="noMotionSimulationHazard" (No motion simulation hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no motion simulation hazards associated with this product.
+
+
sound_hazard
+
+
If true it indicates that the accessibilityHazard="Sound" (WARNING - Sound hazard) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a sound hazard which must be displayed.
+
+
no_sound_hazards
+
+
If true it indicates that the accessibilityHazard="noSoundHazard" (No sound hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no sound hazards associated with this product.
+
+
unknown_if_contains_hazards
+
+
If true it indicates that the accessibilityHazard="unknown" (unknown hazards) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the product has not been assessed for hazards and there is no information about potential hazards.
+
+
+
+
+
4.7.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETno_hazards_or_warnings_confirmed be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="none"].
+
+
LETflashing_hazard be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="flashing"].
+
+
+
LETno_flashing_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="noFlashingHazard"].
+
+
+
LETmotion_simulation_hazard be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="motionSimulation"].
+
+
+
LETno_motion_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="noMotionSimulation"].
+
+
+
LETsound_hazard be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="sound"].
+
+
+
+
LETno_sound_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="noSoundHazard"].
+
+
+
LETunknown_if_contains_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="unknown"].
+
+
+
4.7.3 Instructions
+
+
+ IFno_hazards_or_warnings_confirmedOR (no_flashing_hazardsANDno_motion_hazardsANDno_sound_hazards):
+ THEN display "No hazards".
+
+
+ ELSE IFflashing_hazardORmotion_simulation_hazardORsound_hazard:
+ THENLEThazards be an empty array.
+
+
+ IFflashing_hazard:
+ THENAPPEND"flashing" to hazards.
+
+
+ IFmotion_simulation_hazard:
+ THENAPPEND"motion" to hazards.
+
+
+ IFsound_hazard:
+ THENAPPEND"sound" to hazards.
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
Note
+ Being human-written, the accessibility summary will appear in the original language of the publication. Therefore it is necessary to take care of setting up the correct language tag information.
+
+
+
Note
Accessibility summaries were necessary when no systems exposed computed accessibility metadata. With more systems now displaying this information, much of the accessibility summary may be redundant. Publishers should focus on adding information not provided within the computed metadata, such as specifying where in a video file a flashing hazard exists, or noting the reason why they failed to meet WCAG-AA due to color contrast issues in the Appendix.
+
+
4.8.1 Understanding the variables
+
+
accessibility_summary
+
+
If true it indicates that the accessibilitySummary is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing a short explanatory summary of the accessibility of the product or the URL of a web page comprising such a summary. Summarizes the already existent information and may add information that the publisher could not express with the other codes.
+
+
lang_attribute_accessibility_summary
+
+
Returns the lang attribute of the node containing the accessibility_summary, or the lang attribute of the nearest anchestor.
+
This is the language code in which the text of the Accessibility summary was written.
+
+
language_of_text
+
+
Returns the value of nearest "language" (Language of content) if present in the package document, otherwise if false it means that the metadata is not present.
+
This indicates the main language of the content and therefore the most probable language of accessibility summary.
+
+
+
4.8.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETaccessibility_summary be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilitySummary"].
+
+
LETlang_attribute_accessibility_summary be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilitySummary"]/(@lang|ancestor::*/@lang)[last()].
+
+
LETlanguage_of_text be the result of calling check for node on package_document, /package/metadata/dc:language[1]/text().
+
+
+
4.8.3 Instructions
+
+
+ IFlang_attribute_accessibility_summary is NOT empty:
+ THENLETlanguage_accessibility_summary be the value of lang_attribute_accessibility_summary.
+
+
+ ELSELETlanguage_accessibility_summary be the value of language_of_text.
+
+
+ ELSE IFaccessibility_summary is NOT empty:
+ THEN display the content of accessibility_summary with language_accessibility_summary as language.
+
+ ELSE either omit this key informtion if metadata is missing or display "No accessibility summary".
+
+
+
+
+
4.9 Legal considerations
+
+
Issue 350: Feedback requested on exceptions and exemptions from publishers
We are actively seeking comments on this "legal consideration" section. If you are a publisher, we want your feedback! Please visit the GitHub Issue tracking linked above to leave a comment.
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.9.1 Understanding the variables
+
+
eaa_exemption_micro_enterprises
+
+
If true it indicates that the a11y:exemption="eaa-microenterprise" (EEA exception 1 – Micro-enterprises) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exemption for Micro-enterprises (as defined by current regulations). The product may not have to comply with requirements of the EAA if the publisher is a micro-enterprise.
+
+
eaa_exception_disproportionate_burden
+
+
If true it indicates that the a11y:exemption="eaa_disproportionate_burden" (EAA exception 2 – Disproportionate burden) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Disproportionate burden (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so would financially overburden the publisher.
+
+
eaa_exception_fundamental_modification
+
+
If true it indicates that the a11y:exemption="eaa_fundamental_modification" (EAA exception 3 – Fundamental modification) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Fundamental modification (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so requires a fundamental modification of the nature of the product or service.
+
+
+
4.9.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
LETeaa_exemption_micro_enterprises be the result of calling check for node on package_document, /package/metadata/meta[@property="a11y:exemption" and text()="eaa-microenterprise"].
+
LETeaa_exception_disproportionate_burden be the result of calling check for node on package_document, /package/metadata/meta[@property="a11y:exemption" and text()="eaa-disproportionate-burden"].
+
LETeaa_exception_fundamental_modification be the result of calling check for node on package_document, /package/metadata/meta[@property="a11y:exemption" and text()="eaa-fundamental-alteration"].
+
+
4.9.3 Instructions
+
+
+ IFeaa_exemption_micro_enterprisesOReaa_exception_disproportionate_burdenOReaa_exception_fundamental_modification:
+ THEN display "TBD".
+
+
+ ELSE either omit this key informtion if metadata is missing or display "No legal considerations".
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.10.1 Adaptation
+
+
+
4.10.1.1 Understanding the variables
+
+
audio_descriptions
+
+
If true it indicates that the accessibilityFeature="audioDescriptions" (Audio Descriptions) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is an audio descriptions track available for video content.
+
+
braille
+
+
If true it indicates that the accessibilityFeature="braille" (Braille) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is braille available within the publication.
+
+
closed_captions
+
+
If true it indicates that the accessibilityFeature="closedCaptions" (Closed captions) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via closed captions that can be turned on or off by the viewer and which will be a separate file from the video itself.
+
+
open_captions
+
+
If true it indicates that the accessibilityFeature="openCaptions" (Open captions) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via open captions, which means they cannot be turned off and are always visible when the video plays.
+
+
tactile_graphic
+
+
If true it indicates that the accessibilityFeature="tactileGraphic" (tactile 2D graphic) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is tactile graphic(s) contained within this publication.
+
+
tactile_object
+
+
If true it indicates that the accessibilityFeature="tactileObject" (tactile 3D object) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is tactile 3D object(s) contained within this publication.
+
+
transcript
+
+
If true it indicates that the accessibilityFeature="transcript" (transcript) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that a transcript of the audio content of the product is supplied with it.
+
+
sign_language
+
+
If true it indicates that the accessibilityFeature="signLanguage" (Sign language interpretation) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that a full signing of audio content of the product is supplied with the video file.
+
+
+
+
4.10.1.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
LETaudio_descriptions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="audioDescription"].
+
LETbraille be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="braille"].
+
LETclosed_captions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="closedCaptions"].
+
LETopen_captions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="openCaptions"].
+
LETtactile_graphic be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tactileGraphic"].
+
LETtactile_object be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tactileObject"].
+
LETtranscript be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="transcript"].
+
LETsign_language be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="signLanguage"].
+
+
+
4.10.1.3 Instructions
+
+
LETadaptation be an empty array.
+
+ IFaudio_descriptions:
+ THENAPPEND"audio descriptions" to adaptation.
+
+
+ IFbraille:
+ THENAPPEND"braille" to adaptation.
+
+
+ IFclosed_captions:
+ THENAPPEND"closed captions" to adaptation.
+
+
+ IFopen_captions:
+ THENAPPEND"open captions" to adaptation.
+
+
+ IFtactile_graphic:
+ THENAPPEND"tactile graphic" to adaptation.
+
+
+ IFtactile_object:
+ THENAPPEND"tactile 3D object" to adaptation.
+
+
+ IFtranscript:
+ THENAPPEND"transcript" to adaptation.
+
+
+ IFsign_language:
+ THENAPPEND"sign language" to adaptation.
+
If true it indicates that the accessibilityFeature="aria" (ARIA roles - semantic markup) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the use of AIRA, including DPUB ARIA is used to improve the semantic markup of the publication.
+
+
full_ruby_annotations
+
+
If true it indicates that the accessibilityFeature="fullRubyAnnotations" (Full Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that ruby annotations are attached to every CJK ideographic character in the content. Ruby annotations are used as pronunciation guides for the logographic characters for languages like Chinese or Japanese. They make difficult CJK ideographic characters more accessible.
+
+
+
text_to_speech_hinting
+
+
If true it indicates that the accessibilityFeature="ttsMarkup" (Text-to-speech markup provided) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that text-to-speech has been optimised through provision of PLS lexicons, SSML or CSS Speech synthesis hints or other speech synthesis markup languages or hinting.
If true it indicates that the accessibilityFeature="highContrastAudio" (Use of high contrast between foreground and background audio) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that foreground audio content (eg voice) is presented with no or low background noise (eg ambient sounds, music), at least 20dB below the level of the foreground, or background noise can be switched off (eg via an alternative audio track). Brief and occasional sound effects may be as loud as foreground voice so long as they are isolated from the foreground.
+
+
high_contrast_between_text_and_background
+
+
If true it indicates that the accessibilityFeature="highContrastDisplay" (Use of high contrast between text and background color) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that body text is presented with a contrast ratio of at least 4.5:1 (or 3:1 for large/heading text).
+
+
large_print
+
+
If true it indicates that the accessibilityFeature="largePrint" (Large Print) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the e-publication has been formatted to meet large print guidelines.
+
+
page_break_markers
+
+
If true it indicates that the accessibilityFeature="pageBreakMarkers" (Print-equivalent page numbering) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication contains references to the page numbering.
+
+
ruby_annotations
+
+
If true it indicates that the accessibilityFeature="rubyAnnotations" (Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that ruby annotations are attached to some but not all CJK ideographic characters in the content.
+
+
+
+
+
4.10.2.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
LETaria be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="aria"].
+
LETfull_ruby_annotations be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="fullRubyAnnotations"].
+
LETtext_to_speech_hinting be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="ttsMarkup"].
+
LEThigh_contrast_between_foreground_and_background_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="highContrastAudio"].
+
LEThigh_contrast_between_text_and_background be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="highContrastDisplay"].
+
LETlarge_print be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="largePrint"].
+
LETpage_break_markers be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="pageBreakMarkers"].
+
LETruby_annotations be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="rubyAnnotations"].
+
+
+
4.10.2.3 Instructions
+
+
LETclarity be an empty array.
+
+ IFaria:
+ THENAPPEND"aria" to clarity.
+
+
+ IFfull_ruby_annotations:
+ THENAPPEND"full ruby annotations" to clarity.
+
+
+ IFtext_to_speech_hinting:
+ THENAPPEND"text-to-speech hinting provided" to clarity.
+
+
+ IFhigh_contrast_between_foreground_and_background_audio:
+ THENAPPEND"high contrast between foreground and background audio" to clarity.
+
+
+ IFhigh_contrast_between_text_and_background:
+ THENAPPEND"high contrast between text and background" to clarity.
+
+
+ IFlarge_print:
+ THENAPPEND"large print" to clarity.
+
+
+ IFpage_break_markers:
+ THENAPPEND"page breaks" to clarity.
+
+
+ IFruby_annotations:
+ THENAPPEND"ruby annotations" to clarity.
+
+ GitHub Issues are preferred for
+ discussion of this specification.
+
+
+
+
1. EPUB Accessibility Metadata
+
+
+
This metadata as outlined in EPUB Accessibility 1.1 [epub-a11y-11], can be found in the EPUB package document [EPUB-33].
+
+
Note
+
+
Note
+
+
1.1 EPUB Accessibility Metadata Examples
+
+
1.1.1 EPUB accessibility metadata describing an EPUB
+
+
Here is an example of accessibility metadata embedded within the package document,
+ 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.
+
+
+
+
1.1.2 EPUB accessibility metadata describing an audiobook
+
+
+
Here is an example of an accessibility OPF Metadata for describing an audiobook, 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.
+
+
+
+
+
+
2. Conventions for implementations
+
+
The code conventions used in the provided code snippet follow a structure commonly found in programming languages like Python, Java, or C++. Here's an explanation of the conventions:
+
+
Conditionals and Control Flow:
+
IF, ELSE IF, and ELSE (in bold and capital letters) statements are used to define different conditions and the corresponding actions to be taken.
+
Operators:
+
Written operators (is present) are used to check if a particular code or codelist is present (or not) in the metadata record.
+
Logical operators:
+
Logical operators (AND, OR, NOT, in bold and capital letters) are used to combine conditions.
+
String Literals:
+
String literals are used to represent the text that should be displayed when a particular condition is met.
+
Variable Naming:
+
The terms like "property" and "value" are used in a way that suggests a variable or data structure representing the metadata record.
+
Indentation:
+
The code uses consistent indentation to define blocks of code within conditional statements. This is crucial for readability and maintaining a clear structure.
+
Readability:
+
The code is written in a way that is intended to be easily readable and understandable even by non-coders.
+
+
+
+
3. Common Functions
+
+
In this section we define the functions common to all techniques, which are called by them during execution.
+
3.1 Preprocessing
+
+
Before working directly with the metadata we must read the metadata in the Package document (package document) inside the EPUB. This is a common starting point for all techniques that allows us to query the metadata directly.
+
Note
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
To generate the internal representation, run the following steps:
+
+
LETpackage_document_content be textual representation of the Package document for the publication given package_document_as_text.
+
LETpackage_document be the DOM tree that results from parsing package_document_content using an XML DOM parser.
+
Return package_document.
+
+
+
+
3.2 Check for Node
+
+
Many of the techniques rely on checking for the presence or absence of metadata in the metadata section of the Package document.
+
+
Note
+
+
This algorithm takes:
+
+
the package_document argument: the internal representation of the Package document (output of preprocessing);
+
the path argument: the XPATH of the node to check the presence of.
+
+
To check for node, run the following steps:
+
+
+ IFpackage_document contains path:
+ THEN return True.
+
+
ELSE return False.
+
+
+
3.3 Join array to comma list
+
+
This function serves to concatenate an array of strings, separating each element with a comma, with the last element separated by an ", and" (this string is localizable).
+
For example if the input array has elements ["one", "two", "three"], then the output is going to be "one, two, and three".
+
This algorithm takes the string_array argument: the list of string to join.
+
To join the array, run the following steps:
+
+
LEToutput_string be the result of:
+
+
calling join on string_array with the separator ", "
+
replacing the last occurrence of ", " with ", and ".
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
+
4.1.1 Understanding the variables
+
+
all_textual_content_can_be_modified
+
+
If true it indicates that the accessibilityFeature="displayTransformability" (All textual content can be modified) is present in the package document, otherwise if false it means that the metadata is not present.
+
All textual content can be modified means that the digital publication does not restrict the ability of users to modify and reflow the display of any textual content to the full extent allowed by the reading system (i.e. to change the text size or typeface, line height and word spacing, colors).
+
+
is_fixed_layout
+
+
If true it indicates that the layout="pre-paginated" (Fixed format) is present in the package document, otherwise if false it means that the metadata is not present.
+
Fixed format means that digital publication is in fixed format (e.g. EPUB Fixed Layout).
+
+
+
+
4.1.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETall_textual_content_can_be_modified be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="displayTransformability"].
+
+
LETis_fixed_layout be the result of calling check for node on package_document, /package/metadata/meta[@property="rendition:layout" and text()="pre-paginated"].
+
+
+
4.1.3 Instructions
+
+
+ IFall_textual_content_can_be_modified:
+ THEN display "Appearance can be modified".
+
+
+ ELSE IFis_fixed_layout:
+ THEN display "Appearance cannot be modified".
+
+
ELSE display "Appearance modifiability not known".
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
4.2.1 Understanding the variables
+
+
all_necessary_content_textual
+
+
If true it indicates that the accessModeSufficient="textual" (all main content is provided in textual form) is present in the package document, otherwise if false it means that the metadata is not present.
+
All non-decorative content supports reading without sight means that all contents of the digital publication necessary to use and understanding, including text, images (via their alternative descriptions), audio and video material (via their transcripts, descriptions, captions or subtitles) are fully accessible via suitable reading devices, for example text-to-speech screen readers or tactile reading devices (‘Braille displays’), and nothing in the digital publication prevents or blocks the use of alternative reading modes. The entire publication can be navigated and ‘read’ using only text rendered via sound or touch, and does not require visual perception.
+
+
non_textual_content_images
+
+
If true it indicates that at least one of the following is present in the package document:
+
+
accessMode="chartOnVisual" (Charts and Graphs);
+
accessMode="chemOnVisual" (Chemistry);
+
accessMode="diagramOnVisual" (Diagrams);
+
accessMode="mathOnVisual" (Math);
+
accessMode="musicOnVisual" (Music);
+
accessMode="textOnVisual" (Images of text);
+
otherwise if false it means that this metadata is not present.
+
+
This means that the content contains images of any type.
+
+
textual_alternative_images
+
+
If true it indicates that at least one of the following is present in the package document:
+
+
accessibilityFeature="alternativeText" (Short alternative textual descriptions);
+
accessibilityFeature="longDescription" (Full alternative textual descriptions);
+
accessibilityFeature="describedMath" (Visual of math fully described));
+
otherwise if false it means that this metadata is not present.
+
+
This means that there are textual alternatives for images.
+
+
+
4.2.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETall_necessary_content_textual be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessModeSufficient" and text()="textual"].
+
+ LETnon_textual_content_images be the result of calling check for node on
+ package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and (text()="chartOnVisual" or text()="chemOnVisual" or
+ text()="diagramOnVisual" or text()="mathOnVisual" or
+ text()="musicOnVisual" or text()="textOnVisual")].
+
+
+
LETtextual_alternative_images be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and (text()="longDescription" or text()="alternativeText" or text()="describedMath")].
+
+
+
+
4.2.3 Instructions
+
+
+ IFall_necessary_content_textual:
+ THEN display "Readable in read aloud and braille".
+
+
+ ELSE IFnon_textual_content_imagesANDNOTtextual_alternative_images:
+ THEN display "Not fully readable in read aloud and braille".
+
+
ELSE display "May not be fully readable in read aloud and braille".
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.3.1 Understanding the variables
+
+
epub_accessibility_1_0
+
+
If true it indicates that the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a" (EPUB Accessibility Specification 1.0 A) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa" (EPUB Accessibility Specification 1.0 AA) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa" (EPUB Accessibility Specification 1.0 AAA) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with either the requirements of EPUB Accessibility Spec 1.0, at level A, AA, or AAA.
+
+
epub_accessibility_1_1
+
+
If true it indicates that the conformsTo contains "EPUB Accessibility 1.1" (EPUB Accessibility Specification 1.1) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of EPUB Accessibility Spec 1.1.
+
+
wcag_20
+
+
If true it indicates that the conformsTo contains "WCAG 2.0" or conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a" (EPUB Accessibility Specification 1.0 A) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa" (EPUB Accessibility Specification 1.0 AA) or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa" (EPUB Accessibility Specification 1.0 AAA) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.0 or with the requirements of EPUB Accessibility Spec 1.0 (at level A, AA, or AAA). This is because being compliant with EPUB Accessibility 1.0 specification means at least being compliant with WCAG 2.0 specification.
+
+
wcag_21
+
+
If true it indicates that the conformsTo contains "WCAG 2.1" is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.1.
+
+
wcag_22
+
+
If true it indicates that the conformsTo contains "WCAG 2.2" is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.2.
+
+
level_a
+
+
If true it indicates that the conformsTo contains "Level A" or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a" (EPUB Accessibility Specification 1.0 A) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level A or with the requirements of EPUB Accessibility Spec 1.0 level A.
+
+
level_aa
+
+
If true it indicates that the conformsTo contains "Level AA" or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa" (EPUB Accessibility Specification 1.0 AA) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AA or with the requirements of EPUB Accessibility Spec 1.0 level AA.
+
+
level_aaa
+
+
If true it indicates that the conformsTo contains "Level AAA" or the conformsTo="http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa" (EPUB Accessibility Specification 1.0 A) are present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AAA or with the requirements of EPUB Accessibility Spec 1.0 level AAA.
+
+
certifier
+
+
Returns the description of a11y:certifiedBy (Compliance certification by (name)) if present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the name of the organization responsible for compliance testing and certification of the product is present.
+
+
certifier_credentials
+
+
Returns the description of a11y:certifierCredential (Compliance certification by (URL)) if present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the the URL of a web page belonging to an organization responsible for compliance testing and certification of the product is present – typically a ‘home page’ or a page describing the certification scheme itself.
+
+
certification_date
+
+
Returns the description of dcterms:date if that date property is associated with the a11y:certifiedBy (Latest accessibility assessment date) if present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the date of the latest assessment or re-assessment of the accessibility of the product is present.
+
+
certifier_report
+
+
Returns the description of a11y:certifierReport (Compliance web page for detailed accessibility information) if present in the OPF, otherwise if false it means that the metadata is not present.
+
This means that is present the URL of a compliance web page for detailed accessibility information. The web page should be maintained by an independent compliance scheme or testing organization. Note the web page may include information about specific national requirements or voluntary conformance reports.
+
+
conformance-claimed
+
+
If true it indicates that the conformsTo is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms to some specification.
+
+
+
+
+
4.3.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETepub_accessibility_1_0 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-"].
+
+
LETepub_accessibility_1_1 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), "EPUB Accessibility 1.1")].
+
+
LETwcag_20 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), "http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), "WCAG 2.0")]
+
+
LETwcag_21 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), WCAG 2.1")].
+
+
LETwcag_22 be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), WCAG 2.2")].
+
+
LETlevel_a be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), Level A")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and text()=http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a"].
+
+
LETlevel_aa be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), Level AA")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and text()=http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa"].
+
+
LETlevel_aaa be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and contains(text(), Level AAA")]OR calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo" and text()=http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aaa"].
+
+
+
LETcertifier be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifiedBy"]/text().
+
+
LETcertifier_credentials be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifierCredential"]/text().
+
+
LETcertification_date be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="dcterms:date" and @refines=//meta[@property="a11y:certifiedBy"]/@id]/text()].
+
+
LETcertifier_report be the value of the node extracted from package_document, using the xpath /package/metadata/meta[@property="a11y:certifierReport"]/text()].
+
+
LETconformance_claimed be the result of calling check for node on package_document, /package/metadata/meta[@property="dcterms:conformsTo"].
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.4.1 Understanding the variables
+
+
all_content_audio
+
+
If true it indicates that the accessModeSufficient="auditory" (all main content is provided in audio form) is present in the package document, otherwise if false it means that the metadata is not present.
+
+
synchronised_pre_recorded_audio
+
+
If true it indicates that the accessibilityFeature="sychronizedAudioText" is present in the package document, otherwise, if false, it means that the metadata is not present.
+
This indicates that text-synchronised pre-recorded audio narration (natural or synthesised voice) is included for substantially all textual matter, including all alternative descriptions, e.g. via a SMIL media overlay.
+
+
+
audio_content
+
+
If true it indicates that the accessMode="auditory" is present in the package document, otherwise, if false, it means that the metadata is not present.
+
+
This indicates that pre-recorded audio content is included as part of the work.
+
+
+
+
+
4.4.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETall_content_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessModeSufficient" and text()="auditory"].
+
+
LETsynchronised_pre_recorded_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="sychronizedAudioText"].
+
+
LETaudio_content be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessMode" and text()="auditory"].
+
+
+
4.4.3 Instructions
+
+
+ IFall_content_audio:
+ THEN display "Audio only".
+
+
+ ELSE IFsynchronised_pre_recorded_audio:
+ THEN display "Synchronized audio and text".
+
+
+ ELSE IFaudio_content:
+ THEN display "Complementary audio and text".
+
+
+
+ ELSE either omit this key informtion if metadata is missing or display "No information about pre-recorded audio".
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.5.1 Understanding the variables
+
+
table_of_contents_navigation
+
+
If true it indicates that the accessibilityFeature="tableOfContents" (Table of contents navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
+
This means that the resource includes a table of contents that provides links to the major sections of the content.
+
+
index_navigation
+
+
If true it indicates that the accessibilityFeature="index" (Index navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
+
This means that there is an index that provides direct (eg hyperlinked) access to uses of the index terms in the document body.
+
+
page_navigation
+
+
If true it indicates that the accessibilityFeature="pageNavigation" (Page Navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the e-publication includes a means of navigating to static page break locations.
+
+
next_previous_structural_navigation
+
+
If true it indicates that the accessibilityFeature="structuralNavigation" (Next / Previous structural navigation) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that all levels of heading and other structural elements of the content are correctly marked up and (if applicable) numbered, to enable fast next heading / previous heading, next chapter / previous chapter navigation without returning to the table of contents.
+
+
+
4.5.2 Variables setup
+
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETtable_of_contents_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tableOfContents"].
+
+
LETindex_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="index"].
+
+
LETpage_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="pageNavigation"].
+
+
LETnext_previous_structural_navigation be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="structuralNavigation"].
+
+
+
4.5.3 Instructions
+
+
+ IFtable_of_contents_navigationORindex_navigationORprint_equivalent_page_numberingORnext_previous_structural_navigation:
+ THENLETnavigation be an empty array.
+
+
+ IFtable_of_contents_navigation:
+ THENAPPEND"table of contents" to navigation.
+
+
+ IFindex_navigation:
+ THENAPPEND"index" to navigation.
+
+
+ IFpage_navigation:
+ THENAPPEND"supports page navigation" to navigation.
+
+
+ IFnext_previous_structural_navigation:
+ THENAPPEND"structural navigation" to navigation.
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
4.6.1 Understanding the variables
+
+
contains_charts_diagrams
+
+
If true it indicates that the accessibilityFeature="chartOnVisual" (charts encoded in visual form) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has some information conveyed via some form of illustration, such as a graph, a chart, a diagram, a figure, etc).
+
+
long_text_descriptions
+
+
If true it indicates that the accessibilityFeature="longDescriptions" (Full alternative textual description) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that a full alternative textual description has been supplied for all of the graphs, charts, diagrams, or figures necessary to understand the content.
+
+
contains_chemical_formula
+
+
If true it indicates that the accessibilityFeature="chemOnVisual" (Chemical content) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains chemical notations, formulae.
+
+
chemical_formula_as_chemml
+
+
If true it indicates that the accessibilityFeature="ChemML" (Accessible chemistry content as ChemML) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using ChemML and works with compatible assistive technology.
+
+
contains_math_formula
+
+
If true it indicates that the accessibilityFeature="describedMath" (Mathematical content) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains mathematical notation, equations, formulae.
+
+
math_formula_as_latex
+
+
If true it indicates that the accessibilityFeature="latex" (Accessible math content as LaTeX) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using LaTeX and works with compatible assistive technology.
+
+
math_formula_as_mathml
+
+
If true it indicates that the accessibilityFeature="MathML" (Accessible math content as MathML) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that all mathematical content is presented using MathML and works with compatible assistive technology.
+
+
+
4.6.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETcontains_charts_diagrams be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="chartOnVisual"].
+
+
LETlong_text_descriptions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="longDescriptions"].
+
+
LETcontains_chemical_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="chemOnVisual"].
+
+
LETchemical_formula_as_chemml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="ChemML"].
+
+
+
LETcontains_math_formula be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="describedMath"].
+
+
LETmath_formula_as_latex be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="latex"].
+
+
LETmath_formula_as_mathml be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="MathML"].
+
+
4.6.3 Instructions
+
+
+ IF (contains_charts_diagramsANDlong_text_descriptions):
+ THEN display "Charts and diagrams have extended descriptions".
+
+
+ IFchemical_formula_as_chemml:
+ THEN display "Accessible chemistry content".
+
+
+ IFmath_formula_as_latexORmath_formula_as_mathml:
+ THEN display "Accessible math content".
+
+
+ IF (contains_charts_diagramsORcontains_chemical_formulaORcontains_math_formula) ANDNOT (long_text_descriptionsORchemical_formula_as_chemmlORmath_formula_as_latexORmath_formula_as_mathml):
+ THEN display "Accessibility of formulas, charts, and diagrams unknown".
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.7.1 Understanding the variables
+
+
no_hazards_or_warnings_confirmed
+
+
If true it indicates that the accessibilityHazard="none" (no accessibility hazards) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no associated hazard warnings with this product.
+
+
flashing_hazard
+
+
If true it indicates that the accessibilityHazard="flashing" (WARNING - Flashing hazards) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a flashing hazard which must be displayed.
+
+
no_flashing_hazards
+
+
If true it indicates that the accessibilityHazard="noFlashingHazard" (No flashing hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no flashing hazards associated with this product.
+
+
motion_simulation_hazard
+
+
If true it indicates that the accessibilityHazard="motionSimulation" (WARNING - Motion simulation hazard) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a motion simulation hazard which must be displayed.
+
+
no_motion_hazards
+
+
If true it indicates that the accessibilityHazard="noMotionSimulationHazard" (No motion simulation hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no motion simulation hazards associated with this product.
+
+
sound_hazard
+
+
If true it indicates that the accessibilityHazard="Sound" (WARNING - Sound hazard) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication in the accessiblity metadata within the EPUB confirming that the product has a sound hazard which must be displayed.
+
+
no_sound_hazards
+
+
If true it indicates that the accessibilityHazard="noSoundHazard" (No sound hazard warning necessary) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the accessiblity metadata within the EPUB confirming there are no sound hazards associated with this product.
+
+
unknown_if_contains_hazards
+
+
If true it indicates that the accessibilityHazard="unknown" (unknown hazards) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the product has not been assessed for hazards and there is no information about potential hazards.
+
+
+
+
+
4.7.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETno_hazards_or_warnings_confirmed be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="none"].
+
+
LETflashing_hazard be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="flashing"].
+
+
+
LETno_flashing_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="noFlashingHazard"].
+
+
+
LETmotion_simulation_hazard be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="motionSimulation"].
+
+
+
LETno_motion_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="noMotionSimulation"].
+
+
+
LETsound_hazard be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="sound"].
+
+
+
+
LETno_sound_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="noSoundHazard"].
+
+
+
LETunknown_if_contains_hazards be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityHazard" and text()="unknown"].
+
+
+
4.7.3 Instructions
+
+
+ IFno_hazards_or_warnings_confirmedOR (no_flashing_hazardsANDno_motion_hazardsANDno_sound_hazards):
+ THEN display "No hazards".
+
+
+ ELSE IFflashing_hazardORmotion_simulation_hazardORsound_hazard:
+ THENLEThazards be an empty array.
+
+
+ IFflashing_hazard:
+ THENAPPEND"flashing" to hazards.
+
+
+ IFmotion_simulation_hazard:
+ THENAPPEND"motion" to hazards.
+
+
+ IFsound_hazard:
+ THENAPPEND"sound" to hazards.
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
Note
+ Being human-written, the accessibility summary will appear in the original language of the publication. Therefore it is necessary to take care of setting up the correct language tag information.
+
+
+
Note
Accessibility summaries were necessary when no systems exposed computed accessibility metadata. With more systems now displaying this information, much of the accessibility summary may be redundant. Publishers should focus on adding information not provided within the computed metadata, such as specifying where in a video file a flashing hazard exists, or noting the reason why they failed to meet WCAG-AA due to color contrast issues in the Appendix.
+
+
4.8.1 Understanding the variables
+
+
accessibility_summary
+
+
If true it indicates that the accessibilitySummary is present in the package document, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing a short explanatory summary of the accessibility of the product or the URL of a web page comprising such a summary. Summarizes the already existent information and may add information that the publisher could not express with the other codes.
+
+
lang_attribute_accessibility_summary
+
+
Returns the lang attribute of the node containing the accessibility_summary, or the lang attribute of the nearest anchestor.
+
This is the language code in which the text of the Accessibility summary was written.
+
+
language_of_text
+
+
Returns the value of nearest "language" (Language of content) if present in the package document, otherwise if false it means that the metadata is not present.
+
This indicates the main language of the content and therefore the most probable language of accessibility summary.
+
+
+
4.8.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
+
LETaccessibility_summary be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilitySummary"].
+
+
LETlang_attribute_accessibility_summary be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilitySummary"]/(@lang|ancestor::*/@lang)[last()].
+
+
LETlanguage_of_text be the result of calling check for node on package_document, /package/metadata/dc:language[1]/text().
+
+
+
4.8.3 Instructions
+
+
+ IFlang_attribute_accessibility_summary is NOT empty:
+ THENLETlanguage_accessibility_summary be the value of lang_attribute_accessibility_summary.
+
+
+ ELSELETlanguage_accessibility_summary be the value of language_of_text.
+
+
+ ELSE IFaccessibility_summary is NOT empty:
+ THEN display the content of accessibility_summary with language_accessibility_summary as language.
+
+ ELSE either omit this key informtion if metadata is missing or display "No accessibility summary".
+
+
+
+
+
4.9 Legal considerations
+
+
Issue 350: Feedback requested on exceptions and exemptions from publishers
We are actively seeking comments on this "legal consideration" section. If you are a publisher, we want your feedback! Please visit the GitHub Issue tracking linked above to leave a comment.
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.9.1 Understanding the variables
+
+
eaa_exemption_micro_enterprises
+
+
If true it indicates that the a11y:exemption="eaa-microenterprise" (EEA exception 1 – Micro-enterprises) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exemption for Micro-enterprises (as defined by current regulations). The product may not have to comply with requirements of the EAA if the publisher is a micro-enterprise.
+
+
eaa_exception_disproportionate_burden
+
+
If true it indicates that the a11y:exemption="eaa_disproportionate_burden" (EAA exception 2 – Disproportionate burden) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Disproportionate burden (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so would financially overburden the publisher.
+
+
eaa_exception_fundamental_modification
+
+
If true it indicates that the a11y:exemption="eaa_fundamental_modification" (EAA exception 3 – Fundamental modification) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Fundamental modification (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so requires a fundamental modification of the nature of the product or service.
+
+
+
4.9.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
LETeaa_exemption_micro_enterprises be the result of calling check for node on package_document, /package/metadata/meta[@property="a11y:exemption" and text()="eaa-microenterprise"].
+
LETeaa_exception_disproportionate_burden be the result of calling check for node on package_document, /package/metadata/meta[@property="a11y:exemption" and text()="eaa-disproportionate-burden"].
+
LETeaa_exception_fundamental_modification be the result of calling check for node on package_document, /package/metadata/meta[@property="a11y:exemption" and text()="eaa-fundamental-alteration"].
+
+
4.9.3 Instructions
+
+
+ IFeaa_exemption_micro_enterprisesOReaa_exception_disproportionate_burdenOReaa_exception_fundamental_modification:
+ THEN display "TBD".
+
+
+ ELSE either omit this key informtion if metadata is missing or display "No legal considerations".
+
This algorithm takes the package_document_as_text argument: a UTF-8 string representing the Package document.
+
+
4.10.1 Adaptation
+
+
+
4.10.1.1 Understanding the variables
+
+
audio_descriptions
+
+
If true it indicates that the accessibilityFeature="audioDescriptions" (Audio Descriptions) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is an audio descriptions track available for video content.
+
+
braille
+
+
If true it indicates that the accessibilityFeature="braille" (Braille) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is braille available within the publication.
+
+
closed_captions
+
+
If true it indicates that the accessibilityFeature="closedCaptions" (Closed captions) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via closed captions that can be turned on or off by the viewer and which will be a separate file from the video itself.
+
+
open_captions
+
+
If true it indicates that the accessibilityFeature="openCaptions" (Open captions) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via open captions, which means they cannot be turned off and are always visible when the video plays.
+
+
tactile_graphic
+
+
If true it indicates that the accessibilityFeature="tactileGraphic" (tactile 2D graphic) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is tactile graphic(s) contained within this publication.
+
+
tactile_object
+
+
If true it indicates that the accessibilityFeature="tactileObject" (tactile 3D object) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that there is tactile 3D object(s) contained within this publication.
+
+
transcript
+
+
If true it indicates that the accessibilityFeature="transcript" (transcript) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that a transcript of the audio content of the product is supplied with it.
+
+
sign_language
+
+
If true it indicates that the accessibilityFeature="signLanguage" (Sign language interpretation) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that a full signing of audio content of the product is supplied with the video file.
+
+
+
+
4.10.1.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
LETaudio_descriptions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="audioDescription"].
+
LETbraille be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="braille"].
+
LETclosed_captions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="closedCaptions"].
+
LETopen_captions be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="openCaptions"].
+
LETtactile_graphic be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tactileGraphic"].
+
LETtactile_object be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="tactileObject"].
+
LETtranscript be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="transcript"].
+
LETsign_language be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="signLanguage"].
+
+
+
4.10.1.3 Instructions
+
+
LETadaptation be an empty array.
+
+ IFaudio_descriptions:
+ THENAPPEND"audio descriptions" to adaptation.
+
+
+ IFbraille:
+ THENAPPEND"braille" to adaptation.
+
+
+ IFclosed_captions:
+ THENAPPEND"closed captions" to adaptation.
+
+
+ IFopen_captions:
+ THENAPPEND"open captions" to adaptation.
+
+
+ IFtactile_graphic:
+ THENAPPEND"tactile graphic" to adaptation.
+
+
+ IFtactile_object:
+ THENAPPEND"tactile 3D object" to adaptation.
+
+
+ IFtranscript:
+ THENAPPEND"transcript" to adaptation.
+
+
+ IFsign_language:
+ THENAPPEND"sign language" to adaptation.
+
If true it indicates that the accessibilityFeature="aria" (ARIA roles - semantic markup) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the use of AIRA, including DPUB ARIA is used to improve the semantic markup of the publication.
+
+
full_ruby_annotations
+
+
If true it indicates that the accessibilityFeature="fullRubyAnnotations" (Full Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that ruby annotations are attached to every CJK ideographic character in the content. Ruby annotations are used as pronunciation guides for the logographic characters for languages like Chinese or Japanese. They make difficult CJK ideographic characters more accessible.
+
+
+
text_to_speech_hinting
+
+
If true it indicates that the accessibilityFeature="ttsMarkup" (Text-to-speech markup provided) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that text-to-speech has been optimised through provision of PLS lexicons, SSML or CSS Speech synthesis hints or other speech synthesis markup languages or hinting.
If true it indicates that the accessibilityFeature="highContrastAudio" (Use of high contrast between foreground and background audio) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that foreground audio content (eg voice) is presented with no or low background noise (eg ambient sounds, music), at least 20dB below the level of the foreground, or background noise can be switched off (eg via an alternative audio track). Brief and occasional sound effects may be as loud as foreground voice so long as they are isolated from the foreground.
+
+
high_contrast_between_text_and_background
+
+
If true it indicates that the accessibilityFeature="highContrastDisplay" (Use of high contrast between text and background color) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that body text is presented with a contrast ratio of at least 4.5:1 (or 3:1 for large/heading text).
+
+
large_print
+
+
If true it indicates that the accessibilityFeature="largePrint" (Large Print) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the e-publication has been formatted to meet large print guidelines.
+
+
page_break_markers
+
+
If true it indicates that the accessibilityFeature="pageBreakMarkers" (Print-equivalent page numbering) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that the publication contains references to the page numbering.
+
+
ruby_annotations
+
+
If true it indicates that the accessibilityFeature="rubyAnnotations" (Ruby Annotations) is present in the package document, otherwise if false it means that the metadata is not present.
+
This means that ruby annotations are attached to some but not all CJK ideographic characters in the content.
+
+
+
+
+
4.10.2.2 Variables setup
+
+
LETpackage_document be the result of calling preprocessing given package_document_as_text.
+
LETaria be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="aria"].
+
LETfull_ruby_annotations be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="fullRubyAnnotations"].
+
LETtext_to_speech_hinting be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="ttsMarkup"].
+
LEThigh_contrast_between_foreground_and_background_audio be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="highContrastAudio"].
+
LEThigh_contrast_between_text_and_background be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="highContrastDisplay"].
+
LETlarge_print be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="largePrint"].
+
LETpage_break_markers be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="pageBreakMarkers"].
+
LETruby_annotations be the result of calling check for node on package_document, /package/metadata/meta[@property="schema:accessibilityFeature" and text()="rubyAnnotations"].
+
+
+
4.10.2.3 Instructions
+
+
LETclarity be an empty array.
+
+ IFaria:
+ THENAPPEND"aria" to clarity.
+
+
+ IFfull_ruby_annotations:
+ THENAPPEND"full ruby annotations" to clarity.
+
+
+ IFtext_to_speech_hinting:
+ THENAPPEND"text-to-speech hinting provided" to clarity.
+
+
+ IFhigh_contrast_between_foreground_and_background_audio:
+ THENAPPEND"high contrast between foreground and background audio" to clarity.
+
+
+ IFhigh_contrast_between_text_and_background:
+ THENAPPEND"high contrast between text and background" to clarity.
+
+
+ IFlarge_print:
+ THENAPPEND"large print" to clarity.
+
+
+ IFpage_break_markers:
+ THENAPPEND"page breaks" to clarity.
+
+
+ IFruby_annotations:
+ THENAPPEND"ruby annotations" to clarity.
+
+ 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
+ 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.
+
+
+
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.
+
+
+
+
+
2. Conventions for implementations
+
+
The code conventions used in the provided code snippet follow a structure commonly found in programming languages like Python, Java, or C++. Here's an explanation of the conventions:
+
+
Conditionals and Control Flow:
+
IF, ELSE IF, and ELSE (in bold and capital letters) statements are used to define different conditions and the corresponding actions to be taken.
+
Operators:
+
Written operators (is present) are used to check if a particular code or codelist is present (or not) in the metadata record.
+
Logical operators:
+
Logical operators (AND, OR, NOT, in bold and capital letters) are used to combine conditions.
+
String Literals:
+
String literals are used to represent the text that should be displayed when a particular condition is met.
+
Variable Naming:
+
The terms like "codelist" and "code" are used in a way that suggests a variable or data structure representing a code or codelist to be accessed directly after the ingestion of the metadata record.
+
Indentation:
+
The code uses consistent indentation to define blocks of code within conditional statements. This is crucial for readability and maintaining a clear structure.
+
Readability:
+
The code is written in a way that is intended to be easily readable and understandable even by non-coders.
+
+
+
3. Common Functions
+
+
In this section we define the functions common to all techniques, which are called by them during execution.
+
3.1 Preprocessing
+
+
Before working directly with the metadata we must read the ONIX record. This is a common starting point for all techniques that allows us to query the record directly.
+
Note
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
To generate the internal representation, run the following steps:
+
+
LETrecord be textual representation of the ONIX record for the publication given onix_record_as_text.
+
LETonix be the DOM tree that results from parsing record using an XML DOM parser.
+
return onix.
+
+
Note
+
+
3.2 Check for Node
+
+
Many of the techniques rely on checking for the presence or absence of metadata in the ONIX record.
+
This algorithm takes:
+
+
the onix argument: the internal representation of ONIX record (output of preprocessing);
+
the path argument: the XPATH of the node to check the presence of.
+
+
To check for node, run the following steps:
+
+
+ IFonix contains path:
+ THEN return True.
+
+
ELSE return False.
+
+
+
3.3 Join array to comma list
+
+
This function serves to concatenate an array of strings, separating each element with a comma, with the last element separated by an ", and" (this string is localizable).
+
For example if the input array has elements ["one", "two", "three"], then the output is going to be "one, two, and three".
+
This algorithm takes the string_array argument: the list of string to join.
+
To join the array, run the following steps:
+
+
LEToutput_string be the result of:
+
+
calling join on string_array with the separator ", "
+
replacing the last occurrence of ", " with ", and ".
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.1.1 Understanding the variables
+
+
all_textual_content_can_be_modified
+
+
If true it indicates that the code 36 of codelist 196 (All textual content can be modified) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
All textual content can be modified means that the digital publication does not restrict the ability of users to modify and reflow the display of any textual content to the full extent allowed by the reading system (i.e. to change the text size or typeface, line height and word spacing, colors).
+
+
is_fixed_layout
+
+
If true it indicates that the code E201 of codelist 175 (Fixed format) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
Fixed format means that digital publication is in fixed format (e.g. EPUB Fixed Layout).
+
+
+
4.1.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETall_textual_content_can_be_modified be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "36"].
+
LETis_fixed_layout be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormDetail[text() = "E201"]ANDNOT the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormDetail[text() = "E200"].
+
+
4.1.3 Instructions
+
+
+ IFall_textual_content_can_be_modified:
+ THEN display "Appearance can be modified".
+
+
+ ELSE IFis_fixed_layout:
+ THEN display "Appearance cannot be modified".
+
+
ELSE display "Appearance modifiability not known".
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.2.1 Understanding the variables
+
+
all_necessary_content_textual
+
+
If true it indicates that the code 52 of codelist 196 (All non-decorative content supports reading without sight) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
All non-decorative content supports reading without sight means that all contents of the digital publication necessary to use and understanding, including text, images (via their alternative descriptions), audio and video material (via their transcripts, descriptions, captions or subtitles) are fully accessible via suitable reading devices, for example text-to-speech screen readers or tactile reading devices (‘Braille displays’), and nothing in the digital publication prevents or blocks the use of alternative reading modes. The entire publication can be navigated and ‘read’ using only text rendered via sound or touch, and does not require visual perception.
+
+
real_text
+
+
If true it indicates that the code 10 of codelist 81 (Text) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
Text means that digital publication contains "real" text (user-selectable) as its main content (or as secondary content).
+
+
non_textual_content_images
+
+
If true it indicates that at least one of the following is present in the ONIX record:
otherwise if false it means that this metadata is not present.
+
+
This means that there are textual alternatives for images.
+
+
+
4.2.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETall_necessary_content_textual be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "52"].
+
LETreal_text be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[PrimaryContentType = "10" or ProductContentType = "10"].
+
LETnon_textual_content_images be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[PrimaryContentType = "07" or PrimaryContentType = "18" or PrimaryContentType = "19" or PrimaryContentType = "12" or PrimaryContentType = "49" or PrimaryContentType = "20" or ProductContentType = "07" or ProductContentType = "18" or ProductContentType = "19" or ProductContentType = "12" or ProductContentType = "49" or ProductContentType = "20"].
+
LETtextual_alternative_images be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and (ProductFormFeatureValue = "14" or ProductFormFeatureValue = "15" or ProductFormFeatureValue = "16")].
+
+
4.2.3 Instructions
+
+
+ IFall_necessary_content_textual:
+ THEN display "Readable in read aloud and braille".
+
+
+ ELSE IFreal_textANDnon_textual_content_imagesANDNOTtextual_alternative_images:
+ THEN display "Not fully readable in read aloud and braille".
+
+
ELSE display "May not be fully readable in read aloud and braille".
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.3.1 Understanding the variables
+
+
epub_accessibility_10
+
+
If true it indicates that either the code 02 of codelist 196 (EPUB Accessibility Specification 1.0 A) or the code 03 of codelist 196 (EPUB Accessibility Specification 1.0 AA) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with either the requirements of EPUB Accessibility Spec 1.0, at level A or level AA.
+
+
epub_accessibility_11
+
+
If true it indicates that the code 04 of codelist 196 (EPUB Accessibility Specification 1.1) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of EPUB Accessibility Spec 1.1.
+
+
wcag_20
+
+
If true it indicates that the code 80 of codelist 196 (WCAG v2.0) or the code 02 of codelist 196 (EPUB Accessibility Specification 1.0 A) or the code 03 of codelist 196 (EPUB Accessibility Specification 1.0 AA) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.0 or with the requirements of EPUB Accessibility Spec 1.0 (at level A or level AA). This is because being compliant with EPUB Accessibility 1.0 specification means at least being compliant with WCAG 2.0 specification.
+
+
wcag_21
+
+
If true it indicates that the code 81 of codelist 196 (WCAG v2.1) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.1.
+
+
wcag_22
+
+
If true it indicates that the code 82 of codelist 196 (WCAG v2.2) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.2.
+
+
level_a
+
+
If true it indicates that the code 84 of codelist 196 (WCAG level A) or the code 02 of codelist 196 (EPUB Accessibility Specification 1.0 A) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level A or with the requirements of EPUB Accessibility Spec 1.0 level A.
+
+
level_aa
+
+
If true it indicates that the code 85 of codelist 196 (WCAG level AA) or the code 03 of codelist 196 (EPUB Accessibility Specification 1.0 AA) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AA or with the requirements of EPUB Accessibility Spec 1.0 level AA.
+
+
level_aaa
+
+
If true it indicates that the code 86 of codelist 196 (WCAG level AAA) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AAA.
+
+
certifier
+
+
Returns the description of code 90 of codelist 196 (Compliance certification by (name)) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the name of the organization responsible for compliance testing and certification of the product is present.
+
+
certifier_credentials
+
+
Returns the description of code 93 of codelist 196 (Compliance certification by (URL)) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the the URL of a web page belonging to an organization responsible for compliance testing and certification of the product is present – typically a ‘home page’ or a page describing the certification scheme itself.
+
+
certification_date
+
+
Returns the description of code 91 of codelist 196 (Latest accessibility assessment date) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the date of the latest assessment or re-assessment of the accessibility of the product is present.
+
+
certifier_report
+
+
Returns the description of code 94 of codelist 196 (Compliance web page for detailed accessibility information) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that is present the URL of a compliance web page for detailed accessibility information. The web page should be maintained by an independent compliance scheme or testing organization. Note the web page may include information about specific national requirements or voluntary conformance reports.
+
+
+
+
4.3.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETepub_accessibility_10 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "02"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "03"].
+
LETepub_accessibility_11 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "04"].
+
LETwcag_20 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "80"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "02"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "03"].
+
LETwcag_21 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "81"].
+
LETwcag_22 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "82"].
+
LETlevel_a be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "84"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "02"].
+
LETlevel_aa be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "85"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "03"].
+
LETlevel_aaa be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "86"].
+
LETcertifier be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "90"]/ProductFormFeatureDescription.
+
LETcertifier_credentials be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "93"]/ProductFormFeatureDescription.
+
LETcertification_date be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "91"]/ProductFormFeatureDescription.
+
LETcertifier_report be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "94"]/ProductFormFeatureDescription.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.4.1 Understanding the variables
+
+
audiobook
+
+
If true it indicates that the code 01 of codelist 81 (Audiobook) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the primary content is an Audio recording of a reading of a book or other text.
+
+
all_content_audio
+
+
If true it indicates that the code 39 of codelist 196 (Supplementary material to an audiobook is accessible) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that all supplementary visual or textual material necessary for understanding of an audiobook, is available as pre-recorded audio, or has full alternative text that can be read via text-to- speech. Only for use in ONIX 3.0 or later.
+
+
all_content_pre_recorded
+
+
If true it indicates that the code 51 of codelist 196 (All non-decorative content supports reading via pre-recorded audio) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that all contents of the digital publication necessary to use and understanding, including any text, images (via alternative descriptions), video (via audio description) is fully accessible via suitable audio reproduction. The entire publication can be navigated and ‘read’ using only pre-recorded sound, and does not require visual or tactile perception.
+
+
synchronised_pre_recorded_audio
+
+
If true it indicates that one of the following codes is present in the ONIX record:
Otherwise, if false, it means that none of the above metadata is present.
+
This indicates that text-synchronised pre-recorded audio narration (natural or synthesised voice) is included for substantially all textual matter, including all alternative descriptions, e.g. via a SMIL media overlay.
+
+
non_textual_content_audio
+
+
If true it indicates that one of the following codes is present in the ONIX record:
Otherwise, if false, it means that none of the above metadata is present.
+
This indicates that pre-recorded audio content is included as part of the work. It can be Audio recording of a reading, performance or dramatization of part of the work or additional pre-recorded audio of any supplementary material such as full or partial reading, lecture, performance, dramatization, interview, background documentary or other audio content not included in the primary or unenhanced version
+
+
non_textual_content_audio_in_video
+
+
If true it indicates that one of the following codes is present in the ONIX record:
Otherwise, if false, it means that none of the above metadata is present.
+
This indicates that pre-recorded video including audio content is included as part of the work. It can be video recording of a reading, performance of part of the work or additional pre-recorded video of any supplementary material such as full or partial reading, lecture, performance, dramatization, interview, background documentary or other video containing audio content.
+
+
+
4.4.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETaudiobook be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "81" or ContentType = "81"] .
+
LETall_content_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "39"].
+
LETall_content_pre_recorded be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "51"].
+
LETsynchronised_pre_recorded_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "20"]
+ AND calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormDetail[text() = "A305"].
+
+
LETnon_textual_content_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[ContentType = "21" or ContentType = "22"] .
+
+
LETnon_textual_content_audio_in_video be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[ContentType = "06" or ContentType = "25" or ContentType = "26" or ContentType = "27" or ContentType = "28" or ContentType = "29" or ContentType = "30"] .
+
+
+
4.4.3 Instructions
+
+
+ IFall_content_audioANDNOTsynchronised_pre_recorded_audio:
+ THEN display "Audio only".
+
+
+ ELSE IFaudiobook OR non_textual_content_audio OR non_textual_content_audio_in_videoANDNOTall_content_pre_recorded:
+ THEN display "Complementary audio and text".
+
+
+ ELSE IFall_content_pre_recordedANDsynchronised_pre_recorded_audio:
+ THEN display "Synchronized audio and text".
+
+
+ ELSE display "No information about pre-recorded audio".
+
Note
This key information can be hidden if metadata is missing.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.5.1 Understanding the variables
+
+
table_of_contents_navigation
+
+
If true it indicates that the code 11 of codelist 196 (Table of contents navigation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a Table of Contents in the publication that allows direct (eg hyperlinked) access to all levels of text organization above individual paragraphs (eg to all sections and subsections) and to all tables, figures, illustrations etc.
+
+
index_navigation
+
+
If true it indicates that the code 12 of codelist 196 (Index navigation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is an index that provides direct (eg hyperlinked) access to uses of the index terms in the document body.
+
+
print_equivalent_page_numbering
+
+
If true it indicates that the code 19 of codelist 196 (Print-equivalent page numbering) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that in the publication contains references to the page numbering of an equivalent printed product.
+
+
next_previous_structural_navigation
+
+
If true it indicates that the code 29 of codelist 196 (Next / Previous structural navigation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that all levels of heading and other structural elements of the content are correctly marked up and (if applicable) numbered, to enable fast next heading / previous heading, next chapter / previous chapter navigation without returning to the table of contents.
+
+
+
4.5.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETtable_of_contents_navigation be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "11"].
+
LETindex_navigation be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "12"].
+
LETprint_equivalent_page_numbering be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "19"].
+
LETnext_previous_structural_navigation be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "29"].
+
+
4.5.3 Instructions
+
+
+ IFtable_of_contents_navigationORindex_navigationORprint_equivalent_page_numberingORnext_previous_structural_navigation:
+ THENLETnavigation be an empty array.
+
+
+ IFtable_of_contents_navigation:
+ THENAPPEND"table of contents" to navigation.
+
+
+ IFindex_navigation:
+ THENAPPEND"index" to navigation.
+
+
+ IFprint_equivalent_page_numbering:
+ THENAPPEND"supports page navigation" to navigation.
+
+
+ IFnext_previous_structural_navigation:
+ THENAPPEND"structural navigation" to navigation.
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.6.1 Understanding the variables
+
+
contains_charts_diagrams
+
+
If true it indicates that the code 19 of codelist 81 (Figures, diagrams, charts, graphs) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has some information conveyed via some form of illustration, such as a graph, a chart, a diagram, a figure, etc).
+
+
charts_diagrams_as_non_graphical_data
+
+
If true it indicates that the code 16 of codelist 196 (Visualized data also available as non-graphical datas) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that all data presented in a visual format (graph, chart, etc) has an alternative non-graphical presentation of the same data.
+
+
charts_diagrams_diagrams_as_long_text
+
+
If true it indicates that the code 15 of codelist 196 (Full alternative textual description) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that a full alternative textual description has been supplied for all of the graphs, charts, diagrams, or figures necessary to understand the content.
+
+
contains_chemical_formula
+
+
If true it indicates that the code 47 of codelist 81 (Chemical content) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains chemical notations, formulae.
+
+
chemical_formula_as_chemml
+
+
If true it indicates that the code 18 of codelist 196 (Accessible chemistry content as ChemML) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using ChemML and works with compatible assistive technology.
+
+
chemical_formula_as_mathml
+
+
If true it indicates that the code 34 of codelist 196 (Accessible chemistry content as MathML) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using MathML and works with compatible assistive technology.
+
+
contains_math_formula
+
+
If true it indicates that the code 48 of codelist 81 (Mathematical content) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains mathematical notation, equations, formulae.
+
+
math_formula_as_latex
+
+
If true it indicates that the code 35 of codelist 196 (Accessible math content as LaTeX) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using LaTeX and works with compatible assistive technology.
+
+
math_formula_as_mathml
+
+
If true it indicates that the code 17 of codelist 196 (Accessible math content as MathML) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that all mathematical content is presented using MathML and works with compatible assistive technology.
+
+
+
4.6.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETcontains_charts_diagrams be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "19" or ContentType = "19"] .
+
LETcharts_diagrams_as_non_graphical_data be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "16"].
+
LETcharts_diagrams_diagrams_as_long_text be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "15"].
+
LETcontains_chemical_formula be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "47" or ContentType = "47"] .
+
LETchemical_formula_as_chemml be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "18"].
+
LETchemical_formula_as_mathml be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "34"].
+
LETcontains_math_formula be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "48" or ContentType = "48"] .
+
LETmath_formula_as_latex be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "35"].
+
LETmath_formula_as_mathml be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "17"].
+
+
4.6.3 Instructions
+
+
+ IFcontains_charts_diagramsANDcharts_diagrams_diagrams_as_long_text:
+ THEN display "Charts and diagrams have extended descriptions".
+
+
+ IFcontains_charts_diagramsANDcharts_diagrams_as_non_graphical_data:
+ THEN display "Visualized data also available as non-graphical data".
+
+
+ IFchemical_formula_as_chemmlORchemical_formula_as_mathml:
+ THEN display "Accessible chemistry content".
+
+
+ IFmath_formula_as_latexORmath_formula_as_mathml:
+ THEN display "Accessible math content".
+
+
+ IF (contains_charts_diagramsORcontains_chemical_formulaORcontains_math_formula) ANDNOT (charts_diagrams_diagrams_as_long_textORcharts_diagrams_as_non_graphical_dataORchemical_formula_as_chemmlORchemical_formula_as_mathmlORmath_formula_as_latexORmath_formula_as_mathml):
+ THEN display "Accessibility of formulas, charts, and diagrams unknown".
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.7.1 Understanding the variables
+
+
no_hazards_or_warnings_confirmed
+
+
If true it indicates that the code 00 of codelist 143 (No known hazards or warnings) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no associated hazard warnings with this product.
+
+
flashing_hazard
+
+
If true it indicates that the code 13 of codelist 143 (WARNING - Flashing hazard) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has a flashing hazard which must be displayed.
+
+
no_flashing_hazards
+
+
If true it indicates that the code 14 of codelist 143 (No flashing hazard warning necessary) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no flashing hazards associated with this product.
+
+
motion_simulation_hazard
+
+
If true it indicates that the code 17 of codelist 143 (WARNING - Motion simulation hazard) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has a motion simulation hazard which must be displayed.
+
+
no_motion_hazards
+
+
If true it indicates that the code 18 of codelist 143 (No motion simulation hazard warning necessary) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no motion simulation hazards associated with this product.
+
+
sound_hazard
+
+
If true it indicates that the code 15 of codelist 143 (WARNING - Sound hazard) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has a sound hazard which must be displayed.
+
+
no_sound_hazards
+
+
If true it indicates that the code 16 of codelist 143 (No sound hazard warning necessary) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no sound hazards associated with this product.
+
+
unknown_if_contains_hazards
+
+
If true it indicates that the code 08 of codelist 196 (Unknown accessibility) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the product has not been assessed for hazards and there is no information about potential hazards.
+
+
+
4.7.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETno_hazards_or_warnings_confirmed be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "00"].
+
LETflashing_hazard be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "13"].
+
LETno_flashing_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "14"].
+
LETmotion_simulation_hazard be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "17"].
+
LETno_motion_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "18"].
+
LETsound_hazard be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "15"].
+
LETno_sound_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "16"].
+
LETunknown_if_contains_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "08"].
+
+
4.7.3 Instructions
+
+
+ IFno_hazards_or_warnings_confirmedOR (no_flashing_hazardsANDno_motion_hazardsANDno_sound_hazards):
+ THEN display "No hazards".
+
+
+ ELSE IFflashing_hazardORmotion_simulation_hazardORsound_hazard:
+ THENLEThazards be an empty array.
+
+
+ IFflashing_hazard:
+ THENAPPEND"flashing" to hazards.
+
+
+ IFmotion_simulation_hazard:
+ THENAPPEND"motion" to hazards.
+
+
+ IFsound_hazard:
+ THENAPPEND"sound" to hazards.
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
Note
+ Being human-written, the accessibility summary and addendum will appear in the original language of the publication. Therefore it is necessary of take care of setting up the correct language tag information.
+
+
+
Note
Accessibility summary existed when no system exposed the computed accessibility metadata. With more and more systems displaying this information, most of the accessibility summary may be redundant. It may be advised to display only the accessibility addendum.
+
+
4.8.1 Understanding the variables
+
+
accessibility_summary
+
+
Returns the description of code 00 of codelist 196 (Accessibility summary) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing a short explanatory summary of the accessibility of the product or the URL of a web page comprising such a summary. Summarizes the already existent information and may add information that the publisher could not express with the other codes.
+
+
lang_attribute_accessibility_summary
+
+
Returns the lang attribute of the node containing the accessibility_summary, or the lang attribute of the nearest ancestor.
+
This is the language code in which the text of the Accessibility summary was written.
+
+
accessibility_addendum
+
+
Returns the description of code 92 of codelist 196 (Accessibility addendum) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing a short addendum to the accessibility detail of the product. It contains precise information that the publisher could not express with the other's codes.
+
+
lang_attribute_accessibility_addendum
+
+
Returns the lang attribute of the node containing the accessibility_addendum, or the lang attribute of the nearest ancestor.
+
This is the language code in which the text of the Accessibility addendum was written.
+
+
known_limited_accessibility
+
+
Returns the description of code 09 of codelist 196 (Inaccessible, or known limited accessibility) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing details of and reasons for limitations on accessibility of an ebook.
+
+
lang_known_limited_accessibility
+
+
Returns the lang attribute of the node containing the known_limited_accessibility, or the lang attribute of the nearest ancestor.
+
This is the language code in which the text of the Inaccessible, or known limited accessibility was written.
+
+
language_of_text
+
+
Returns the value of nearest code 01 of codelist 22 (Language of text) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This indicates the main language of the content and therefore the most probable language of accessibility summary and addendum.
+
+
+
4.8.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETaccessibility_addendum be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "92"]/ProductFormFeatureDescription.
+
LETlang_attribute_accessibility_addendum be the value extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "92"]/ProductFormFeatureDescription/(@lang|ancestor::*/@lang)[last()].
+
LETknown_limited_accessibility be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "09"]/ProductFormFeatureDescription.
+
LETlang_known_limited_accessibility be the value extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "09"]/ProductFormFeatureDescription/(@lang|ancestor::*/@lang)[last()].
+
LETaccessibility_summary be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "00"]/ProductFormFeatureDescription.
+
LETlang_attribute_accessibility_summary be the value extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "00"]/ProductFormFeatureDescription/(@lang|ancestor::*/@lang)[last()].
+
LETlanguage_of_text be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/Language[LanguageRole="01"]/LanguageCode.
+
+
4.8.3 Instructions
+
+
+ IFlang_attribute_accessibility_addendum is NOT empty:
+ THENLETlanguage_accessibility_addendum be the value of lang_attribute_accessibility_addendum.
+
+
+ ELSELETlanguage_accessibility_addendum be the value of language_of_text.
+
+
+ IFlang_known_limited_accessibility is NOT empty:
+ THENLETlanguage_known_limited_accessibility be the value of lang_known_limited_accessibility.
+
+
+ ELSELETlanguage_known_limited_accessibility be the value of language_of_text.
+
+
+ IFlang_attribute_accessibility_summary is NOT empty:
+ THENLETlanguage_accessibility_summary be the value of lang_attribute_accessibility_summary.
+
+
+ ELSELETlanguage_accessibility_summary be the value of language_of_text.
+
+
+ IFknown_limited_accessibility is NOT empty:
+ THEN display the content of known_limited_accessibility with language_known_limited_accessibility as language.
+
+
+ IFaccessibility_addendum is NOT empty:
+ THEN display the content of accessibility_addendum with language_accessibility_addendum as language.
+
+
+ ELSE IFaccessibility_summary is NOT empty:
+ THEN display the content of accessibility_summary with language_accessibility_summary as language.
+
+
+ ELSE display "No accessibility summary".
+
Note
This key information can be hidden if metadata is missing.
+
+
+
+
+
4.9 Legal considerations
+
+
Issue 350: Feedback requested on exceptions and exemptions from publishers
We are actively seeking comments on this "legal consideration" section. If you are a publisher, we want your feedback! Please visit the GitHub Issue tracking linked above to leave a comment.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.9.1 Understanding the variables
+
+
eaa_exemption_micro_enterprises
+
+
If true it indicates that the code 75 of codelist 196 (EEA exception 1 – Micro-enterprises) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exemption for Micro-enterprises (as defined by current regulations). The product may not have to comply with requirements of the EAA if the publisher is a micro-enterprise.
+
+
eaa_exception_disproportionate_burden
+
+
If true it indicates that the code 76 of codelist 196 (EAA exception 2 – Disproportionate burden) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Disproportionate burden (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so would financially overburden the publisher.
+
+
eaa_exception_fundamental_modification
+
+
If true it indicates that the code 77 of codelist 196 (EAA exception 3 – Fundamental modification) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Fundamental modification (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so requires a fundamental modification of the nature of the product or service.
+
+
+
4.9.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETeaa_exemption_micro_enterprises be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "75"].
+
LETeaa_exception_disproportionate_burden be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "76"].
+
LETeaa_exception_fundamental_modification be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "77"].
+
+
4.9.3 Instructions
+
+
+ IFeaa_exemption_micro_enterprisesOReaa_exception_disproportionate_burdenOReaa_exception_fundamental_modification:
+ THEN display "TBD".
+
+
+ ELSE display "No legal considerations".
+
Note
This key information can be hidden if metadata is missing.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.10.1.1 Understanding the variables
+
+
dyslexia_readability
+
+
If true it indicates that the code 24 of codelist 196 (Dyslexia readability) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the product has been specifically adapted or has features specifically to improve readability for dyslexic readers, for example specialised font, character and/or line spacing, justification and paragraph spacing, coloring and other options provided specifically to improve readability for dyslexic readers.
+
+
closed_captions
+
+
If true it indicates that the code V210 of codelist 175 (Closed captions) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via closed captions that can be turned on or off by the viewer and which will be a separate file from the video itself.
+
+
open_captions
+
+
If true it indicates that the code V211 of codelist 175 (Open captions) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via open captions, which means they cannot be turned off and are always visible when the video plays.
+
+
full_transcript
+
+
If true it indicates that the code V212 of codelist 175 (Full transcript) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that a full transcript of the audio content of the product is supplied with it.
+
+
sign_language
+
+
If true it indicates that the code V213 of codelist 175 (Sign language interpretation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that a full signing of audio content of the product supplied with the video file.
+
+
+
+
4.10.1.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETdyslexia_readability be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "24"].
+
LETclosed_captions be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V210"].
+
LETopen_captions be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V211"].
+
LETfull_transcript be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V212"].
+
LETsign_language be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V213"].
+
+
+
4.10.1.3 Instructions
+
+
LETadaptation be an empty array.
+
+ IFdyslexia_readability:
+ THENAPPEND"dyslexia readability" to adaptation.
+
+
+ IFclosed_captions:
+ THENAPPEND"closed captions" to adaptation.
+
+
+ IFopen_captions:
+ THENAPPEND"open captions" to adaptation.
+
+
+ IFfull_transcript:
+ THENAPPEND"full transcript" to adaptation.
+
+
+ IFsign_language:
+ THENAPPEND"sign language" to adaptation.
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.10.2.1 Understanding the variables
+
+
text_to_speech_hinting
+
+
If true it indicates that the code 21 of codelist 196 (Text-to-speech hinting provided) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that text-to-speech has been optimised through provision of PLS lexicons, SSML or CSS Speech synthesis hints or other speech synthesis markup languages or hinting.
+
+
color_not_sole_means_of_conveying_information
+
+
If true it indicates that the code 25 of codelist 196 (Use of color is not sole means of conveying information) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that for readers with color vision deficiency, use of color (eg in diagrams, graphs and charts, in prompts or on buttons inviting a response) is not the sole means of graphical distinction or of conveying information.
+
+
high_contrast_between_text_and_background
+
+
If true it indicates that the code 26 of codelist 196 (Use of high contrast between text and background color) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that body text is presented with a contrast ratio of at least 4.5:1 (or 3:1 for large/heading text).
+
+
ultra_high_contrast_between_text_and_background
+
+
If true it indicates that the code 37 of codelist 196 (Use of ultra-high contrast between text foreground and background) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that body text is presented with a contrast ratio of at least 7:1 (or 4.5:1 for large/heading text).
+
+
visible_page_numbering
+
+
If true it indicates that the code E205 of codelist 175 (Visible page numbering) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the e-publication (mostly in the case of a fixed-format) contains visible page numbers.
If true it indicates that the code 27 of codelist 196 (Use of high contrast between foreground and background audio) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that foreground audio content (eg voice) is presented with no or low background noise (eg ambient sounds, music), at least 20dB below the level of the foreground, or background noise can be switched off (eg via an alternative audio track). Brief and occasional sound effects may be as loud as foreground voice so long as they are isolated from the foreground.
+
+
without_background_sounds
+
+
If true it indicates that the code A312 of codelist 175 (Without background sounds) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that pre-recorded audiobook narration does not contain any background sounds, including music, sound effects, etc, though music and effects may be present if isolated from the speech (ie the sounds do not overlap).
+
+
+
+
4.10.2.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETtext_to_speech_hinting be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "21"].
+
LETcolor_not_sole_means_of_conveying_information be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "25"].
+
LEThigh_contrast_between_text_and_background be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "26"].
+
LETultra_high_contrast_between_text_and_background be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "37"].
+
LETvisible_page_numbering be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "E205"].
+
LEThigh_contrast_between_foreground_and_background_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "27"].
+
LETwithout_background_sounds be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "A312"].
+
+
+
4.10.2.3 Instructions
+
+
LETclarity be an empty array.
+
+ IFtext_to_speech_hinting:
+ THENAPPEND"text-to-speech hinting provided" to clarity.
+
+
+ IFcolor_not_sole_means_of_conveying_information:
+ THENAPPEND"color is not the sole means of conveying information" to clarity.
+
+
+ IFhigh_contrast_between_text_and_background:
+ THENAPPEND"high contrast between text and background" to clarity.
+
+
+ IFultra_high_contrast_between_text_and_background:
+ THENAPPEND"ultra high contrast between text and background" to clarity.
+
+
+ IFvisible_page_numbering:
+ THENAPPEND"visible page numbering " to clarity.
+
+
+ IFhigh_contrast_between_foreground_and_background_audio:
+ THENAPPEND"high contrast between foreground and background audio" to clarity.
+
+
+ IFwithout_background_sounds:
+ THENAPPEND"without background sounds" to clarity.
+
+ 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
+ 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.
+
+
+
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.
+
+
+
+
+
2. Conventions for implementations
+
+
The code conventions used in the provided code snippet follow a structure commonly found in programming languages like Python, Java, or C++. Here's an explanation of the conventions:
+
+
Conditionals and Control Flow:
+
IF, ELSE IF, and ELSE (in bold and capital letters) statements are used to define different conditions and the corresponding actions to be taken.
+
Operators:
+
Written operators (is present) are used to check if a particular code or codelist is present (or not) in the metadata record.
+
Logical operators:
+
Logical operators (AND, OR, NOT, in bold and capital letters) are used to combine conditions.
+
String Literals:
+
String literals are used to represent the text that should be displayed when a particular condition is met.
+
Variable Naming:
+
The terms like "codelist" and "code" are used in a way that suggests a variable or data structure representing a code or codelist to be accessed directly after the ingestion of the metadata record.
+
Indentation:
+
The code uses consistent indentation to define blocks of code within conditional statements. This is crucial for readability and maintaining a clear structure.
+
Readability:
+
The code is written in a way that is intended to be easily readable and understandable even by non-coders.
+
+
+
3. Common Functions
+
+
In this section we define the functions common to all techniques, which are called by them during execution.
+
3.1 Preprocessing
+
+
Before working directly with the metadata we must read the ONIX record. This is a common starting point for all techniques that allows us to query the record directly.
+
Note
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
To generate the internal representation, run the following steps:
+
+
LETrecord be textual representation of the ONIX record for the publication given onix_record_as_text.
+
LETonix be the DOM tree that results from parsing record using an XML DOM parser.
+
return onix.
+
+
Note
+
+
3.2 Check for Node
+
+
Many of the techniques rely on checking for the presence or absence of metadata in the ONIX record.
+
This algorithm takes:
+
+
the onix argument: the internal representation of ONIX record (output of preprocessing);
+
the path argument: the XPATH of the node to check the presence of.
+
+
To check for node, run the following steps:
+
+
+ IFonix contains path:
+ THEN return True.
+
+
ELSE return False.
+
+
+
3.3 Join array to comma list
+
+
This function serves to concatenate an array of strings, separating each element with a comma, with the last element separated by an ", and" (this string is localizable).
+
For example if the input array has elements ["one", "two", "three"], then the output is going to be "one, two, and three".
+
This algorithm takes the string_array argument: the list of string to join.
+
To join the array, run the following steps:
+
+
LEToutput_string be the result of:
+
+
calling join on string_array with the separator ", "
+
replacing the last occurrence of ", " with ", and ".
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.1.1 Understanding the variables
+
+
all_textual_content_can_be_modified
+
+
If true it indicates that the code 36 of codelist 196 (All textual content can be modified) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
All textual content can be modified means that the digital publication does not restrict the ability of users to modify and reflow the display of any textual content to the full extent allowed by the reading system (i.e. to change the text size or typeface, line height and word spacing, colors).
+
+
is_fixed_layout
+
+
If true it indicates that the code E201 of codelist 175 (Fixed format) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
Fixed format means that digital publication is in fixed format (e.g. EPUB Fixed Layout).
+
+
+
4.1.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETall_textual_content_can_be_modified be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "36"].
+
LETis_fixed_layout be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormDetail[text() = "E201"]ANDNOT the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormDetail[text() = "E200"].
+
+
4.1.3 Instructions
+
+
+ IFall_textual_content_can_be_modified:
+ THEN display "Appearance can be modified".
+
+
+ ELSE IFis_fixed_layout:
+ THEN display "Appearance cannot be modified".
+
+
ELSE display "Appearance modifiability not known".
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.2.1 Understanding the variables
+
+
all_necessary_content_textual
+
+
If true it indicates that the code 52 of codelist 196 (All non-decorative content supports reading without sight) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
All non-decorative content supports reading without sight means that all contents of the digital publication necessary to use and understanding, including text, images (via their alternative descriptions), audio and video material (via their transcripts, descriptions, captions or subtitles) are fully accessible via suitable reading devices, for example text-to-speech screen readers or tactile reading devices (‘Braille displays’), and nothing in the digital publication prevents or blocks the use of alternative reading modes. The entire publication can be navigated and ‘read’ using only text rendered via sound or touch, and does not require visual perception.
+
+
real_text
+
+
If true it indicates that the code 10 of codelist 81 (Text) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
Text means that digital publication contains "real" text (user-selectable) as its main content (or as secondary content).
+
+
non_textual_content_images
+
+
If true it indicates that at least one of the following is present in the ONIX record:
otherwise if false it means that this metadata is not present.
+
+
This means that there are textual alternatives for images.
+
+
+
4.2.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETall_necessary_content_textual be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "52"].
+
LETreal_text be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[PrimaryContentType = "10" or ProductContentType = "10"].
+
LETnon_textual_content_images be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[PrimaryContentType = "07" or PrimaryContentType = "18" or PrimaryContentType = "19" or PrimaryContentType = "12" or PrimaryContentType = "49" or PrimaryContentType = "20" or ProductContentType = "07" or ProductContentType = "18" or ProductContentType = "19" or ProductContentType = "12" or ProductContentType = "49" or ProductContentType = "20"].
+
LETtextual_alternative_images be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and (ProductFormFeatureValue = "14" or ProductFormFeatureValue = "15" or ProductFormFeatureValue = "16")].
+
+
4.2.3 Instructions
+
+
+ IFall_necessary_content_textual:
+ THEN display "Readable in read aloud and braille".
+
+
+ ELSE IFreal_textANDnon_textual_content_imagesANDNOTtextual_alternative_images:
+ THEN display "Not fully readable in read aloud and braille".
+
+
ELSE display "May not be fully readable in read aloud and braille".
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.3.1 Understanding the variables
+
+
epub_accessibility_10
+
+
If true it indicates that either the code 02 of codelist 196 (EPUB Accessibility Specification 1.0 A) or the code 03 of codelist 196 (EPUB Accessibility Specification 1.0 AA) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with either the requirements of EPUB Accessibility Spec 1.0, at level A or level AA.
+
+
epub_accessibility_11
+
+
If true it indicates that the code 04 of codelist 196 (EPUB Accessibility Specification 1.1) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of EPUB Accessibility Spec 1.1.
+
+
wcag_20
+
+
If true it indicates that the code 80 of codelist 196 (WCAG v2.0) or the code 02 of codelist 196 (EPUB Accessibility Specification 1.0 A) or the code 03 of codelist 196 (EPUB Accessibility Specification 1.0 AA) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.0 or with the requirements of EPUB Accessibility Spec 1.0 (at level A or level AA). This is because being compliant with EPUB Accessibility 1.0 specification means at least being compliant with WCAG 2.0 specification.
+
+
wcag_21
+
+
If true it indicates that the code 81 of codelist 196 (WCAG v2.1) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.1.
+
+
wcag_22
+
+
If true it indicates that the code 82 of codelist 196 (WCAG v2.2) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG version 2.2.
+
+
level_a
+
+
If true it indicates that the code 84 of codelist 196 (WCAG level A) or the code 02 of codelist 196 (EPUB Accessibility Specification 1.0 A) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level A or with the requirements of EPUB Accessibility Spec 1.0 level A.
+
+
level_aa
+
+
If true it indicates that the code 85 of codelist 196 (WCAG level AA) or the code 03 of codelist 196 (EPUB Accessibility Specification 1.0 AA) are present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AA or with the requirements of EPUB Accessibility Spec 1.0 level AA.
+
+
level_aaa
+
+
If true it indicates that the code 86 of codelist 196 (WCAG level AAA) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the publication conforms with the requirements of WCAG level AAA.
+
+
certifier
+
+
Returns the description of code 90 of codelist 196 (Compliance certification by (name)) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the name of the organization responsible for compliance testing and certification of the product is present.
+
+
certifier_credentials
+
+
Returns the description of code 93 of codelist 196 (Compliance certification by (URL)) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the the URL of a web page belonging to an organization responsible for compliance testing and certification of the product is present – typically a ‘home page’ or a page describing the certification scheme itself.
+
+
certification_date
+
+
Returns the description of code 91 of codelist 196 (Latest accessibility assessment date) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the date of the latest assessment or re-assessment of the accessibility of the product is present.
+
+
certifier_report
+
+
Returns the description of code 94 of codelist 196 (Compliance web page for detailed accessibility information) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that is present the URL of a compliance web page for detailed accessibility information. The web page should be maintained by an independent compliance scheme or testing organization. Note the web page may include information about specific national requirements or voluntary conformance reports.
+
+
+
+
4.3.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETepub_accessibility_10 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "02"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "03"].
+
LETepub_accessibility_11 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "04"].
+
LETwcag_20 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "80"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "02"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "03"].
+
LETwcag_21 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "81"].
+
LETwcag_22 be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "82"].
+
LETlevel_a be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "84"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "02"].
+
LETlevel_aa be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "85"]OR calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "03"].
+
LETlevel_aaa be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "86"].
+
LETcertifier be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "90"]/ProductFormFeatureDescription.
+
LETcertifier_credentials be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "93"]/ProductFormFeatureDescription.
+
LETcertification_date be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "91"]/ProductFormFeatureDescription.
+
LETcertifier_report be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "94"]/ProductFormFeatureDescription.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.4.1 Understanding the variables
+
+
audiobook
+
+
If true it indicates that the code 01 of codelist 81 (Audiobook) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the primary content is an Audio recording of a reading of a book or other text.
+
+
all_content_audio
+
+
If true it indicates that the code 39 of codelist 196 (Supplementary material to an audiobook is accessible) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that all supplementary visual or textual material necessary for understanding of an audiobook, is available as pre-recorded audio, or has full alternative text that can be read via text-to- speech. Only for use in ONIX 3.0 or later.
+
+
all_content_pre_recorded
+
+
If true it indicates that the code 51 of codelist 196 (All non-decorative content supports reading via pre-recorded audio) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that all contents of the digital publication necessary to use and understanding, including any text, images (via alternative descriptions), video (via audio description) is fully accessible via suitable audio reproduction. The entire publication can be navigated and ‘read’ using only pre-recorded sound, and does not require visual or tactile perception.
+
+
synchronised_pre_recorded_audio
+
+
If true it indicates that one of the following codes is present in the ONIX record:
Otherwise, if false, it means that none of the above metadata is present.
+
This indicates that text-synchronised pre-recorded audio narration (natural or synthesised voice) is included for substantially all textual matter, including all alternative descriptions, e.g. via a SMIL media overlay.
+
+
non_textual_content_audio
+
+
If true it indicates that one of the following codes is present in the ONIX record:
Otherwise, if false, it means that none of the above metadata is present.
+
This indicates that pre-recorded audio content is included as part of the work. It can be Audio recording of a reading, performance or dramatization of part of the work or additional pre-recorded audio of any supplementary material such as full or partial reading, lecture, performance, dramatization, interview, background documentary or other audio content not included in the primary or unenhanced version
+
+
non_textual_content_audio_in_video
+
+
If true it indicates that one of the following codes is present in the ONIX record:
Otherwise, if false, it means that none of the above metadata is present.
+
This indicates that pre-recorded video including audio content is included as part of the work. It can be video recording of a reading, performance of part of the work or additional pre-recorded video of any supplementary material such as full or partial reading, lecture, performance, dramatization, interview, background documentary or other video containing audio content.
+
+
+
4.4.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETaudiobook be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "81" or ContentType = "81"] .
+
LETall_content_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "39"].
+
LETall_content_pre_recorded be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "51"].
+
LETsynchronised_pre_recorded_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "20"]
+ AND calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormDetail[text() = "A305"].
+
+
LETnon_textual_content_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[ContentType = "21" or ContentType = "22"] .
+
+
LETnon_textual_content_audio_in_video be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[ContentType = "06" or ContentType = "25" or ContentType = "26" or ContentType = "27" or ContentType = "28" or ContentType = "29" or ContentType = "30"] .
+
+
+
4.4.3 Instructions
+
+
+ IFall_content_audioANDNOTsynchronised_pre_recorded_audio:
+ THEN display "Audio only".
+
+
+ ELSE IFaudiobook OR non_textual_content_audio OR non_textual_content_audio_in_videoANDNOTall_content_pre_recorded:
+ THEN display "Complementary audio and text".
+
+
+ ELSE IFall_content_pre_recordedANDsynchronised_pre_recorded_audio:
+ THEN display "Synchronized audio and text".
+
+
+ ELSE display "No information about pre-recorded audio".
+
Note
This key information can be hidden if metadata is missing.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.5.1 Understanding the variables
+
+
table_of_contents_navigation
+
+
If true it indicates that the code 11 of codelist 196 (Table of contents navigation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a Table of Contents in the publication that allows direct (eg hyperlinked) access to all levels of text organization above individual paragraphs (eg to all sections and subsections) and to all tables, figures, illustrations etc.
+
+
index_navigation
+
+
If true it indicates that the code 12 of codelist 196 (Index navigation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is an index that provides direct (eg hyperlinked) access to uses of the index terms in the document body.
+
+
print_equivalent_page_numbering
+
+
If true it indicates that the code 19 of codelist 196 (Print-equivalent page numbering) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that in the publication contains references to the page numbering of an equivalent printed product.
+
+
next_previous_structural_navigation
+
+
If true it indicates that the code 29 of codelist 196 (Next / Previous structural navigation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that all levels of heading and other structural elements of the content are correctly marked up and (if applicable) numbered, to enable fast next heading / previous heading, next chapter / previous chapter navigation without returning to the table of contents.
+
+
+
4.5.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETtable_of_contents_navigation be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "11"].
+
LETindex_navigation be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "12"].
+
LETprint_equivalent_page_numbering be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "19"].
+
LETnext_previous_structural_navigation be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "29"].
+
+
4.5.3 Instructions
+
+
+ IFtable_of_contents_navigationORindex_navigationORprint_equivalent_page_numberingORnext_previous_structural_navigation:
+ THENLETnavigation be an empty array.
+
+
+ IFtable_of_contents_navigation:
+ THENAPPEND"table of contents" to navigation.
+
+
+ IFindex_navigation:
+ THENAPPEND"index" to navigation.
+
+
+ IFprint_equivalent_page_numbering:
+ THENAPPEND"supports page navigation" to navigation.
+
+
+ IFnext_previous_structural_navigation:
+ THENAPPEND"structural navigation" to navigation.
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.6.1 Understanding the variables
+
+
contains_charts_diagrams
+
+
If true it indicates that the code 19 of codelist 81 (Figures, diagrams, charts, graphs) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has some information conveyed via some form of illustration, such as a graph, a chart, a diagram, a figure, etc).
+
+
charts_diagrams_as_non_graphical_data
+
+
If true it indicates that the code 16 of codelist 196 (Visualized data also available as non-graphical datas) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that all data presented in a visual format (graph, chart, etc) has an alternative non-graphical presentation of the same data.
+
+
charts_diagrams_diagrams_as_long_text
+
+
If true it indicates that the code 15 of codelist 196 (Full alternative textual description) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that a full alternative textual description has been supplied for all of the graphs, charts, diagrams, or figures necessary to understand the content.
+
+
contains_chemical_formula
+
+
If true it indicates that the code 47 of codelist 81 (Chemical content) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains chemical notations, formulae.
+
+
chemical_formula_as_chemml
+
+
If true it indicates that the code 18 of codelist 196 (Accessible chemistry content as ChemML) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using ChemML and works with compatible assistive technology.
+
+
chemical_formula_as_mathml
+
+
If true it indicates that the code 34 of codelist 196 (Accessible chemistry content as MathML) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using MathML and works with compatible assistive technology.
+
+
contains_math_formula
+
+
If true it indicates that the code 48 of codelist 81 (Mathematical content) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the publication contains mathematical notation, equations, formulae.
+
+
math_formula_as_latex
+
+
If true it indicates that the code 35 of codelist 196 (Accessible math content as LaTeX) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the chemical formulae are presented using LaTeX and works with compatible assistive technology.
+
+
math_formula_as_mathml
+
+
If true it indicates that the code 17 of codelist 196 (Accessible math content as MathML) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that all mathematical content is presented using MathML and works with compatible assistive technology.
+
+
+
4.6.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETcontains_charts_diagrams be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "19" or ContentType = "19"] .
+
LETcharts_diagrams_as_non_graphical_data be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "16"].
+
LETcharts_diagrams_diagrams_as_long_text be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "15"].
+
LETcontains_chemical_formula be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "47" or ContentType = "47"] .
+
LETchemical_formula_as_chemml be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "18"].
+
LETchemical_formula_as_mathml be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "34"].
+
LETcontains_math_formula be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/DescriptiveDetail[PrimaryContentType = "48" or ContentType = "48"] .
+
LETmath_formula_as_latex be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "35"].
+
LETmath_formula_as_mathml be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "17"].
+
+
4.6.3 Instructions
+
+
+ IFcontains_charts_diagramsANDcharts_diagrams_diagrams_as_long_text:
+ THEN display "Charts and diagrams have extended descriptions".
+
+
+ IFcontains_charts_diagramsANDcharts_diagrams_as_non_graphical_data:
+ THEN display "Visualized data also available as non-graphical data".
+
+
+ IFchemical_formula_as_chemmlORchemical_formula_as_mathml:
+ THEN display "Accessible chemistry content".
+
+
+ IFmath_formula_as_latexORmath_formula_as_mathml:
+ THEN display "Accessible math content".
+
+
+ IF (contains_charts_diagramsORcontains_chemical_formulaORcontains_math_formula) ANDNOT (charts_diagrams_diagrams_as_long_textORcharts_diagrams_as_non_graphical_dataORchemical_formula_as_chemmlORchemical_formula_as_mathmlORmath_formula_as_latexORmath_formula_as_mathml):
+ THEN display "Accessibility of formulas, charts, and diagrams unknown".
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.7.1 Understanding the variables
+
+
no_hazards_or_warnings_confirmed
+
+
If true it indicates that the code 00 of codelist 143 (No known hazards or warnings) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no associated hazard warnings with this product.
+
+
flashing_hazard
+
+
If true it indicates that the code 13 of codelist 143 (WARNING - Flashing hazard) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has a flashing hazard which must be displayed.
+
+
no_flashing_hazards
+
+
If true it indicates that the code 14 of codelist 143 (No flashing hazard warning necessary) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no flashing hazards associated with this product.
+
+
motion_simulation_hazard
+
+
If true it indicates that the code 17 of codelist 143 (WARNING - Motion simulation hazard) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has a motion simulation hazard which must be displayed.
+
+
no_motion_hazards
+
+
If true it indicates that the code 18 of codelist 143 (No motion simulation hazard warning necessary) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no motion simulation hazards associated with this product.
+
+
sound_hazard
+
+
If true it indicates that the code 15 of codelist 143 (WARNING - Sound hazard) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that there is a positive indication that the product has a sound hazard which must be displayed.
+
+
no_sound_hazards
+
+
If true it indicates that the code 16 of codelist 143 (No sound hazard warning necessary) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a positive indication in the ONIX record confirming there are no sound hazards associated with this product.
+
+
unknown_if_contains_hazards
+
+
If true it indicates that the code 08 of codelist 196 (Unknown accessibility) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the product has not been assessed for hazards and there is no information about potential hazards.
+
+
+
4.7.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETno_hazards_or_warnings_confirmed be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "00"].
+
LETflashing_hazard be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "13"].
+
LETno_flashing_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "14"].
+
LETmotion_simulation_hazard be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "17"].
+
LETno_motion_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "18"].
+
LETsound_hazard be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "15"].
+
LETno_sound_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "12" and ProductFormFeatureValue = "16"].
+
LETunknown_if_contains_hazards be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "08"].
+
+
4.7.3 Instructions
+
+
+ IFno_hazards_or_warnings_confirmedOR (no_flashing_hazardsANDno_motion_hazardsANDno_sound_hazards):
+ THEN display "No hazards".
+
+
+ ELSE IFflashing_hazardORmotion_simulation_hazardORsound_hazard:
+ THENLEThazards be an empty array.
+
+
+ IFflashing_hazard:
+ THENAPPEND"flashing" to hazards.
+
+
+ IFmotion_simulation_hazard:
+ THENAPPEND"motion" to hazards.
+
+
+ IFsound_hazard:
+ THENAPPEND"sound" to hazards.
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
Note
+ Being human-written, the accessibility summary and addendum will appear in the original language of the publication. Therefore it is necessary of take care of setting up the correct language tag information.
+
+
+
Note
Accessibility summary existed when no system exposed the computed accessibility metadata. With more and more systems displaying this information, most of the accessibility summary may be redundant. It may be advised to display only the accessibility addendum.
+
+
4.8.1 Understanding the variables
+
+
accessibility_summary
+
+
Returns the description of code 00 of codelist 196 (Accessibility summary) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing a short explanatory summary of the accessibility of the product or the URL of a web page comprising such a summary. Summarizes the already existent information and may add information that the publisher could not express with the other codes.
+
+
lang_attribute_accessibility_summary
+
+
Returns the lang attribute of the node containing the accessibility_summary, or the lang attribute of the nearest ancestor.
+
This is the language code in which the text of the Accessibility summary was written.
+
+
accessibility_addendum
+
+
Returns the description of code 92 of codelist 196 (Accessibility addendum) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing a short addendum to the accessibility detail of the product. It contains precise information that the publisher could not express with the other's codes.
+
+
lang_attribute_accessibility_addendum
+
+
Returns the lang attribute of the node containing the accessibility_addendum, or the lang attribute of the nearest ancestor.
+
This is the language code in which the text of the Accessibility addendum was written.
+
+
known_limited_accessibility
+
+
Returns the description of code 09 of codelist 196 (Inaccessible, or known limited accessibility) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means there is a human-written text containing details of and reasons for limitations on accessibility of an ebook.
+
+
lang_known_limited_accessibility
+
+
Returns the lang attribute of the node containing the known_limited_accessibility, or the lang attribute of the nearest ancestor.
+
This is the language code in which the text of the Inaccessible, or known limited accessibility was written.
+
+
language_of_text
+
+
Returns the value of nearest code 01 of codelist 22 (Language of text) if present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This indicates the main language of the content and therefore the most probable language of accessibility summary and addendum.
+
+
+
4.8.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETaccessibility_addendum be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "92"]/ProductFormFeatureDescription.
+
LETlang_attribute_accessibility_addendum be the value extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "92"]/ProductFormFeatureDescription/(@lang|ancestor::*/@lang)[last()].
+
LETknown_limited_accessibility be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "09"]/ProductFormFeatureDescription.
+
LETlang_known_limited_accessibility be the value extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "09"]/ProductFormFeatureDescription/(@lang|ancestor::*/@lang)[last()].
+
LETaccessibility_summary be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "00"]/ProductFormFeatureDescription.
+
LETlang_attribute_accessibility_summary be the value extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "00"]/ProductFormFeatureDescription/(@lang|ancestor::*/@lang)[last()].
+
LETlanguage_of_text be the value of the node extracted from onix, using the xpath /ONIXMessage/Product/DescriptiveDetail/Language[LanguageRole="01"]/LanguageCode.
+
+
4.8.3 Instructions
+
+
+ IFlang_attribute_accessibility_addendum is NOT empty:
+ THENLETlanguage_accessibility_addendum be the value of lang_attribute_accessibility_addendum.
+
+
+ ELSELETlanguage_accessibility_addendum be the value of language_of_text.
+
+
+ IFlang_known_limited_accessibility is NOT empty:
+ THENLETlanguage_known_limited_accessibility be the value of lang_known_limited_accessibility.
+
+
+ ELSELETlanguage_known_limited_accessibility be the value of language_of_text.
+
+
+ IFlang_attribute_accessibility_summary is NOT empty:
+ THENLETlanguage_accessibility_summary be the value of lang_attribute_accessibility_summary.
+
+
+ ELSELETlanguage_accessibility_summary be the value of language_of_text.
+
+
+ IFknown_limited_accessibility is NOT empty:
+ THEN display the content of known_limited_accessibility with language_known_limited_accessibility as language.
+
+
+ IFaccessibility_addendum is NOT empty:
+ THEN display the content of accessibility_addendum with language_accessibility_addendum as language.
+
+
+ ELSE IFaccessibility_summary is NOT empty:
+ THEN display the content of accessibility_summary with language_accessibility_summary as language.
+
+
+ ELSE display "No accessibility summary".
+
Note
This key information can be hidden if metadata is missing.
+
+
+
+
+
4.9 Legal considerations
+
+
Issue 350: Feedback requested on exceptions and exemptions from publishers
We are actively seeking comments on this "legal consideration" section. If you are a publisher, we want your feedback! Please visit the GitHub Issue tracking linked above to leave a comment.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.9.1 Understanding the variables
+
+
eaa_exemption_micro_enterprises
+
+
If true it indicates that the code 75 of codelist 196 (EEA exception 1 – Micro-enterprises) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exemption for Micro-enterprises (as defined by current regulations). The product may not have to comply with requirements of the EAA if the publisher is a micro-enterprise.
+
+
eaa_exception_disproportionate_burden
+
+
If true it indicates that the code 76 of codelist 196 (EAA exception 2 – Disproportionate burden) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Disproportionate burden (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so would financially overburden the publisher.
+
+
eaa_exception_fundamental_modification
+
+
If true it indicates that the code 77 of codelist 196 (EAA exception 3 – Fundamental modification) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the digital product falls under European Accessibility Act exception for Fundamental modification (as defined by current regulations). The product may not have to comply with requirements of the EAA if doing so requires a fundamental modification of the nature of the product or service.
+
+
+
4.9.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETeaa_exemption_micro_enterprises be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "75"].
+
LETeaa_exception_disproportionate_burden be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "76"].
+
LETeaa_exception_fundamental_modification be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "77"].
+
+
4.9.3 Instructions
+
+
+ IFeaa_exemption_micro_enterprisesOReaa_exception_disproportionate_burdenOReaa_exception_fundamental_modification:
+ THEN display "TBD".
+
+
+ ELSE display "No legal considerations".
+
Note
This key information can be hidden if metadata is missing.
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.10.1.1 Understanding the variables
+
+
dyslexia_readability
+
+
If true it indicates that the code 24 of codelist 196 (Dyslexia readability) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the product has been specifically adapted or has features specifically to improve readability for dyslexic readers, for example specialised font, character and/or line spacing, justification and paragraph spacing, coloring and other options provided specifically to improve readability for dyslexic readers.
+
+
closed_captions
+
+
If true it indicates that the code V210 of codelist 175 (Closed captions) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via closed captions that can be turned on or off by the viewer and which will be a separate file from the video itself.
+
+
open_captions
+
+
If true it indicates that the code V211 of codelist 175 (Open captions) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the audio content of a video can be seen via open captions, which means they cannot be turned off and are always visible when the video plays.
+
+
full_transcript
+
+
If true it indicates that the code V212 of codelist 175 (Full transcript) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that a full transcript of the audio content of the product is supplied with it.
+
+
sign_language
+
+
If true it indicates that the code V213 of codelist 175 (Sign language interpretation) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that a full signing of audio content of the product supplied with the video file.
+
+
+
+
4.10.1.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETdyslexia_readability be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "24"].
+
LETclosed_captions be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V210"].
+
LETopen_captions be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V211"].
+
LETfull_transcript be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V212"].
+
LETsign_language be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "V213"].
+
+
+
4.10.1.3 Instructions
+
+
LETadaptation be an empty array.
+
+ IFdyslexia_readability:
+ THENAPPEND"dyslexia readability" to adaptation.
+
+
+ IFclosed_captions:
+ THENAPPEND"closed captions" to adaptation.
+
+
+ IFopen_captions:
+ THENAPPEND"open captions" to adaptation.
+
+
+ IFfull_transcript:
+ THENAPPEND"full transcript" to adaptation.
+
+
+ IFsign_language:
+ THENAPPEND"sign language" to adaptation.
+
This algorithm takes the onix_record_as_text argument: a UTF-8 string representing the ONIX record.
+
4.10.2.1 Understanding the variables
+
+
text_to_speech_hinting
+
+
If true it indicates that the code 21 of codelist 196 (Text-to-speech hinting provided) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that text-to-speech has been optimised through provision of PLS lexicons, SSML or CSS Speech synthesis hints or other speech synthesis markup languages or hinting.
+
+
color_not_sole_means_of_conveying_information
+
+
If true it indicates that the code 25 of codelist 196 (Use of color is not sole means of conveying information) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that for readers with color vision deficiency, use of color (eg in diagrams, graphs and charts, in prompts or on buttons inviting a response) is not the sole means of graphical distinction or of conveying information.
+
+
high_contrast_between_text_and_background
+
+
If true it indicates that the code 26 of codelist 196 (Use of high contrast between text and background color) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that body text is presented with a contrast ratio of at least 4.5:1 (or 3:1 for large/heading text).
+
+
ultra_high_contrast_between_text_and_background
+
+
If true it indicates that the code 37 of codelist 196 (Use of ultra-high contrast between text foreground and background) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that body text is presented with a contrast ratio of at least 7:1 (or 4.5:1 for large/heading text).
+
+
visible_page_numbering
+
+
If true it indicates that the code E205 of codelist 175 (Visible page numbering) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that the e-publication (mostly in the case of a fixed-format) contains visible page numbers.
If true it indicates that the code 27 of codelist 196 (Use of high contrast between foreground and background audio) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that foreground audio content (eg voice) is presented with no or low background noise (eg ambient sounds, music), at least 20dB below the level of the foreground, or background noise can be switched off (eg via an alternative audio track). Brief and occasional sound effects may be as loud as foreground voice so long as they are isolated from the foreground.
+
+
without_background_sounds
+
+
If true it indicates that the code A312 of codelist 175 (Without background sounds) is present in the ONIX record, otherwise if false it means that the metadata is not present.
+
This means that pre-recorded audiobook narration does not contain any background sounds, including music, sound effects, etc, though music and effects may be present if isolated from the speech (ie the sounds do not overlap).
+
+
+
+
4.10.2.2 Variables setup
+
+
LETonix be the result of calling preprocessing given onix_record_as_text.
+
LETtext_to_speech_hinting be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "21"].
+
LETcolor_not_sole_means_of_conveying_information be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "25"].
+
LEThigh_contrast_between_text_and_background be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "26"].
+
LETultra_high_contrast_between_text_and_background be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "37"].
+
LETvisible_page_numbering be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "E205"].
+
LEThigh_contrast_between_foreground_and_background_audio be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail/ProductFormFeature[ProductFormFeatureType = "09" and ProductFormFeatureValue = "27"].
+
LETwithout_background_sounds be the result of calling check for node on onix, /ONIXMessage/Product/DescriptiveDetail[ProductFormDetail = "A312"].
+
+
+
4.10.2.3 Instructions
+
+
LETclarity be an empty array.
+
+ IFtext_to_speech_hinting:
+ THENAPPEND"text-to-speech hinting provided" to clarity.
+
+
+ IFcolor_not_sole_means_of_conveying_information:
+ THENAPPEND"color is not the sole means of conveying information" to clarity.
+
+
+ IFhigh_contrast_between_text_and_background:
+ THENAPPEND"high contrast between text and background" to clarity.
+
+
+ IFultra_high_contrast_between_text_and_background:
+ THENAPPEND"ultra high contrast between text and background" to clarity.
+
+
+ IFvisible_page_numbering:
+ THENAPPEND"visible page numbering " to clarity.
+
+
+ IFhigh_contrast_between_foreground_and_background_audio:
+ THENAPPEND"high contrast between foreground and background audio" to clarity.
+
+
+ IFwithout_background_sounds:
+ THENAPPEND"without background sounds" to clarity.
+
\ No newline at end of file
diff --git a/UX-Guide-Metadata/bin/publish-principles.sh b/UX-Guide-Metadata/bin/1.0/publish-principles.sh
similarity index 100%
rename from UX-Guide-Metadata/bin/publish-principles.sh
rename to UX-Guide-Metadata/bin/1.0/publish-principles.sh
diff --git a/UX-Guide-Metadata/bin/publish-techniques.sh b/UX-Guide-Metadata/bin/1.0/publish-techniques.sh
similarity index 100%
rename from UX-Guide-Metadata/bin/publish-techniques.sh
rename to UX-Guide-Metadata/bin/1.0/publish-techniques.sh
diff --git a/UX-Guide-Metadata/bin/publish-drafts.sh b/UX-Guide-Metadata/bin/publish-drafts.sh
new file mode 100755
index 00000000..3c59e28c
--- /dev/null
+++ b/UX-Guide-Metadata/bin/publish-drafts.sh
@@ -0,0 +1,84 @@
+#!/bin/bash
+
+# Script for creating static version for the UX-Guide-Metadata documents
+# It starts from the published draft (in the main branch): https://w3c.github.io/publ-a11y/UX-Guide-Metadata/draft/principles/
+# It generates the static version
+# It runs nuchecker and link checker
+# The output is a zip folder that can be sent to W3C staff for publishing on the website
+
+# pre-run: cleans and temporary directory...
+basedir=$(readlink -f "$0")
+basedir=$(dirname "$basedir")
+documents=( "principles" "techniques/epub-metadata" "techniques/onix-metadata" )
+bold=$(tput bold)
+normal=$(tput sgr0)
+
+# input
+read -p 'Publishing date (format YYYY-MM-DD): ' publishDate
+publishDateWithoutDashes=${publishDate//-/}
+
+for document in "${documents[@]}"
+do
+ printf "\n\nDocument ${bold}$document${normal}...\n"
+
+ # variables for document
+ tmpdir=$(mktemp -d)
+ filename=${document##*/}
+ versionFilename="$filename-draft-note-$publishDateWithoutDashes.html"
+ versionURL="https://w3c.github.io/publ-a11y/UX-Guide-Metadata/2.0/$document/$versionFilename"
+
+ # copies the content to the temporary directory
+ printf "\nCopying the content to the temporary directory..."
+ cp -a "$basedir/../draft/$document/." $tmpdir
+ rm $tmpdir/*.md
+
+ # generates the static version
+ printf "\nGenerating static version...\n"
+ curl \
+ -G \
+ --data-urlencode "type=respec" \
+ --data-urlencode "url=https://w3c.github.io/publ-a11y/UX-Guide-Metadata/draft/$document/?specStatus=CG-DRAFT&publishDate=$publishDate&thisVersion=$versionURL" \
+ https://labs.w3.org/spec-generator/ \
+ -o "$tmpdir/index.html"
+
+ # runs nuchecker
+ nuVersion=$(java -jar "$basedir/libs/vnu/vnu.jar" --version)
+ printf "\nRunning Nu Html Checker version $nuVersion...\n"
+ java -jar "$basedir/libs/vnu/vnu.jar" \
+ "$tmpdir/index.html"
+
+
+ # commenting while waiting for this issue to be fixed: https://github.com/validator/validator/issues/1745
+ # if [ $? -gt 0 ]
+ # then
+ # exit 1
+ # fi
+
+ # runs link checker
+ # installed via commands:
+ # cpan install App::cpanminus
+ # cpanm W3C::LinkChecker@4.81
+ # cpan install Mozilla::CA
+ # tried to install version 5.0.0 on mac, but I got errors
+ checklinkVersion=$(checklink --version)
+ printf "\nRunning $checklinkVersion...\n"
+ checklink \
+ --summary \
+ --broken \
+ "https://w3c.github.io/publ-a11y/UX-Guide-Metadata/draft/$document/?specStatus=CG-DRAFT&publishDate=$publishDate"
+
+ # commenting while waiting for this issue to be fixed: https://github.com/w3c/publ-a11y/issues/386
+ # if [ $? -gt 0 ]
+ # then
+ # exit 1
+ # fi
+
+ printf "\nMoving temporary files to directory..."
+ mv $tmpdir/* "$basedir/../2.0/$document/"
+
+ printf "\nCopying for versioning..."
+ cp "$basedir/../2.0/$document/index.html" "$basedir/../2.0/$document/$versionFilename"
+
+done
+
+printf "\nDone"
\ No newline at end of file
+