readium-shared/org.readium.r2.shared.accessibility/AccessibilityMetadataDisplayGuide

AccessibilityMetadataDisplayGuide

When presenting accessibility metadata provided by the publisher, it is suggested that the section is introduced using terms such as "claims" or "declarations" (e.g., "Accessibility Claims").

Parameters

waysOfReading

The ways of reading display field is a banner heading that groups together the following information about how the content facilitates access.

navigation

Identifies the navigation features included in the publication.

richContent

Indicates the presence of math, chemical formulas, extended descriptions for information rich images, e.g., charts, diagrams, figures, graphs, and whether these are in an accessible format or available in an alternative form, e.g., whether math and chemical formulas are navigable with assistive technologies, or whether extended descriptions are available for information-rich images. In addition, it indicates the presence of videos and if closed captions, open captions, or transcripts for prerecorded audio are available.

additionalInformation

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.

hazards

Identifies any potential hazards (e.g., flashing elements, sounds, and motion simulation) that could afflict physiologically sensitive users.

conformance

Identifies whether the digital publication claims to meet internationally recognized conformance standards for accessibility.

legal

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.

accessibilitySummary

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. Starting with 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.

Constructors

AccessibilityMetadataDisplayGuide

constructor(publication: Publication)

Creates a new display guide for the given publication metadata.

Types

AccessibilitySummary

data class AccessibilitySummary(val summary: String? = null) : AccessibilityMetadataDisplayGuide.Field

AdditionalInformation

data class AdditionalInformation(val pageBreakMarkers: Boolean = false, val aria: Boolean = false, val audioDescriptions: Boolean = false, val braille: Boolean = false, val rubyAnnotations: Boolean = false, val fullRubyAnnotations: Boolean = false, val highAudioContrast: Boolean = false, val highDisplayContrast: Boolean = false, val largePrint: Boolean = false, val signLanguage: Boolean = false, val tactileGraphics: Boolean = false, val tactileObjects: Boolean = false, val textToSpeechHinting: Boolean = false) : AccessibilityMetadataDisplayGuide.Field

Conformance

data class Conformance(val profiles: Set<Accessibility.Profile> = emptySet()) : AccessibilityMetadataDisplayGuide.Field

Identifies whether the digital publication claims to meet internationally recognized conformance standards for accessibility.

Field

sealed interface Field

Represents a collection of related accessibility claims which should be displayed together in a section.

Hazards

data class Hazards(val flashing: AccessibilityMetadataDisplayGuide.Hazards.Hazard = Hazard.NO_METADATA, val motion: AccessibilityMetadataDisplayGuide.Hazards.Hazard = Hazard.NO_METADATA, val sound: AccessibilityMetadataDisplayGuide.Hazards.Hazard = Hazard.NO_METADATA) : AccessibilityMetadataDisplayGuide.Field

Identifies any potential hazards (e.g., flashing elements, sounds, and motion simulation) that could afflict physiologically sensitive users.

Legal

data class Legal(val exemption: Boolean = false) : AccessibilityMetadataDisplayGuide.Field

Navigation

data class Navigation(val tableOfContents: Boolean = false, val index: Boolean = false, val headings: Boolean = false, val page: Boolean = false) : AccessibilityMetadataDisplayGuide.Field

Identifies the navigation features included in the publication.

RichContent

data class RichContent(val extendedAltTextDescriptions: Boolean = false, val mathFormula: Boolean = false, val mathFormulaAsMathML: Boolean = false, val mathFormulaAsLaTeX: Boolean = false, val chemicalFormulaAsMathML: Boolean = false, val chemicalFormulaAsLaTeX: Boolean = false, val closedCaptions: Boolean = false, val openCaptions: Boolean = false, val transcript: Boolean = false) : AccessibilityMetadataDisplayGuide.Field

Statement

sealed interface Statement

Represents a single accessibility claim, such as "Appearance can be modified".

WaysOfReading