package
0.4.4
Repository: https://github.com/readium/go-toolkit.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Parses a [Contributor] from its RWPM JSON representation.
No description provided by the author
No description provided by the author
No description provided by the author
Creates an [Link] from its RWPM JSON representation.
Default href normalizer for [Link], doing nothing.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Parses a [Manifest] from its RWPM JSON representation.
No description provided by the author
NewA11y creates a new empty A11y.
No description provided by the author
Shortcut to create a [LocalizedString] using a map of translations indexed by the BCP 47 language tag.
No description provided by the author
No description provided by the author
Parses a [PublicationCollection] from its RWPM JSON representation.
Parses a map of [PublicationCollection] indexed by their roles from its RWPM JSON representation.
Parses a [Subject] from its RWPM JSON representation.
Creates a list of [Subject] from its RWPM JSON representation.
No description provided by the author

# Constants

Indicates that the resource contains information encoded in auditory form.
Indicates that the resource contains charts encoded in visual form.
Indicates that the resource contains chemical equations encoded in visual form.
Indicates that the resource contains information encoded such that color perception is necessary.
Indicates that the resource contains diagrams encoded in visual form.
Indicates that the resource contains mathematical notations encoded in visual form.
Indicates that the resource contains musical notation encoded in visual form.
Indicates that the resource contains information encoded in tactile form.
Indicates that the resource contains text encoded in visual form.
Indicates that the resource contains information encoded in textual form.
Indicates that the resource contains information encoded in visual form.
Alternative text is provided for visual content (e.g., via the HTML `alt` attribute).
The work includes annotations from the author, instructor and/or others.
Indicates the resource includes ARIA roles to organize and improve the structure and navigation.
Audio descriptions are available (e.g., via an HTML `track` element with its `kind` attribute set to "descriptions".
The work includes bookmarks to facilitate navigation to key points.
The content is in braille format, or alternatives are available in braille.
Indicates that synchronized captions are available for audio and video content.
Identifies that chemical information is encoded using the ChemML markup language.
Textual descriptions of math equations are included, whether in the alt attribute for image-based equations,.
Display properties are controllable by the user.
Audio content with speech in the foreground meets the contrast thresholds set out in WCAG Success Criteria 1.4.7.
Content meets the visual contrast threshold set out in WCAG Success Criteria 1.4.6.
The work includes an index to the content.
The content has been formatted to meet large print guidelines.
Identifies that mathematical equations and formulas are encoded in the LaTeX typesetting system.
Descriptions are provided for image-based visual content and/or complex structures such as tables, mathematics, diagrams, and charts.
Identifies that mathematical equations and formulas are encoded in MathML.
Indicates that the resource does not contain any accessibility features.
The work includes equivalent print page numbers.
The reading order of the content is clearly defined in the markup (e.g., figures, sidebars and other secondary content has been marked up to allow it to be skipped automatically and/or manually escaped from).
Indicates that `ruby` annotations HTML are provided in the content.
Sign language interpretation is available for audio and video content.
The use of headings in the work fully and accurately reflects the document hierarchy, allowing navigation by assistive technologies.
Describes a resource that offers both audio and text, with information that allows them to be rendered simultaneously.
The work includes a table of contents that provides links to the major sections of the content.
When used with creative works such as books, indicates that the resource includes tactile graphics.
When used with creative works such as books, indicates that the resource includes models to generate tactile 3D objects.
The contents of the PDF have been tagged to permit access by assistive technologies.
For content with timed interaction, this value indicates that the user can control the timing to meet their needs (e.g., pause and reset).
Indicates that a transcript of the audio content is available.
One or more of SSML, Pronunciation-Lexicon, and CSS3-Speech properties has been used to enhance text-to-speech playback quality.
No digital rights management or other content restriction protocols have been applied to the resource.
Indicates that the resource presents a flashing hazard for photosensitive persons.
Indicates that the resource contains instances of motion simulation that may affect some individuals.
Indicates that the resource does not present a flashing hazard.
Indicates that the resource does not contain instances of motion simulation.
Indicates that the resource does not contain any hazards.
Indicates that the resource does not contain auditory hazards.
Indicates that the resource contains auditory sounds that may affect some individuals.
Indicates that the author is not able to determine if the resource presents any hazards.
Indicates that auditory perception is necessary to consume the information.
Indicates that tactile perception is necessary to consume the information.
Indicates that the ability to read textual content is necessary to consume the information.
Indicates that visual perception is necessary to consume the information.
No description provided by the author
No description provided by the author
EPUB Accessibility 1.0 - WCAG 2.0 Level A.
EPUB Accessibility 1.0 - WCAG 2.0 Level AA.
EPUB Accessibility 1.0 - WCAG 2.0 Level AAA.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Default value for Presentation.Clipped.
Default value for Presentation.Continuous.
Profile for audiobooks.
Profile for visual narratives (comics, manga and bandes dessinées).
Profile for EPUB publications.
Profile for PDF documents.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

A11y holds the accessibility metadata of a Publication.
A11yCertification represents a certification for an accessible publication.
Contributor https://github.com/readium/webpub-manifest/tree/master/contexts/default#contributors https://github.com/readium/webpub-manifest/schema/contributor-object.schema.json.
Encryption contains metadata from encryption xml.
Link https://github.com/readium/webpub-manifest/blob/master/README.md#24-the-link-object https://github.com/readium/webpub-manifest/blob/master/schema/link.schema.json.
No description provided by the author
One or more alternative expressions of the location.
Locator provides a precise location in a publication in a format that can be stored and shared.
Manifest Main structure for a publication.
Metadata for the default context in WebPub.
* * The Presentation Hints extension defines a number of hints for User Agents about the way content * should be presented to the user.
PublicationCollection can be used as extension point in the Readium Web Publication Manifest.
Subject https://github.com/readium/webpub-manifest/tree/master/contexts/default#subjects https://github.com/readium/webpub-manifest/blob/master/schema/subject-object.schema.json.
Textual context of the locator.

# Type aliases

A11yAccessMode is a human sensory perceptual system or cognitive faculty through which a person may process or perceive information.
A11yFeature is a content feature of the described resource, such as accessible media, alternatives and supported enhancements for accessibility.
A11yHazard is a characteristic of the described resource that is physiologically dangerous to some users.
A11yPrimaryAccessMode is a human primary sensory perceptual system or cognitive faculty through which a person may process or perceive information.
A11yProfile represents an established accessibility standard a publication can conform to.
No description provided by the author
No description provided by the author
TODO replace with generic.
Hints how the layout of the resource should be presented.
No description provided by the author
Function used to recursively transform the href of a [Link] when parsing its JSON representation.
Slice of links.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TODO replace with generic.
No description provided by the author
No description provided by the author
ReadingProgression This is not a proper enum replacement! Use the validator to enforce the values.
No description provided by the author
TODO replace with generic.