Show / Hide Table of Contents

Namespace VersOne.Epub.Schema

Classes

Epub2Ncx

Parsed content of the EPUB 2 NCX (Navigation Center eXtended, also known as Navigation Control file for XML applications) document of the EPUB book. NCX document exposes the hierarchical structure of the book to allow the user to navigate through it.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxContent

Pointer to the book's content associated with a navigational element.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxHead

NCX document head which contains all NCX metadata.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxHeadMeta

NCX document metadata item.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxNavigationLabel

Textual description of a navigational element for the reader.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxNavigationList

NCX navigation list which contains a distinct, flat set of navigable elements for the secondary navigation within the book (e.g., lists of notes, figures, tables, etc.).

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxNavigationMap

NCX navigation map which acts as a container for one or more NCX navigation points for the primary navigation within the book (e.g., table of contents).

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxNavigationPoint

NCX navigation point which contains a description of the target and a pointer to content. It is used for the primary navigation within the book (e.g., for the table of contents).

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxNavigationTarget

NCX navigation target which represents a navigable element for the secondary navigation within the book (e.g., lists of notes, figures, tables, etc.).

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxPageList

NCX page list. It contains one or more NCX page targets which provide pagination information.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub2NcxPageTarget

NCX page target. It provides pagination information for a single page within the EPUB book.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1, https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#NCX, and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub3Nav

Navigation section in the Epub3NavDocument.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

Epub3NavAnchor

Navigation link associated with a Epub3NavLi (represented by the <a> HTML tag in the navigation document).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

Epub3NavDocument

Parsed content of the EPUB 3 navigation document of the EPUB book. Navigation document includes human- and machine-readable content that facilitates navigation through the book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav for more information.

Epub3NavLi

Navigation element which represents a heading, structure or other item of interest for navigation purposes within Epub3NavOl (represented by the <li> HTML tag in the navigation document).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

Epub3NavOl

Top navigation level or a sub-level in the Epub3Nav (represented by the <ol> HTML tag in the navigation document).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

Epub3NavSpan

Navigation header associated with a Epub3NavLi (represented by the <span> HTML tag in the navigation document).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-nav-def-model for more information.

EpubCollection

Represents a unified collection of EPUB metadata items. A collection allows resources to be assembled into logical groups for a variety of potential uses: enabling content that has been split across multiple EPUB Content Documents to be reassembled back into a meaningful unit (e.g., an index split across multiple documents), identifying resources for specialized purposes (e.g., preview content), or collecting together resources that present additional information about this EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#elemdef-collection for more information.

EpubGuide

EPUB 2 guide. Provides machine-processable navigation to the key structural components of the EPUB book (e.g., cover page, table of contents, etc.).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf2-guide and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6 for more information.

EpubGuideReference

Reference element of the EpubGuide.

See https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.6 for more information.

EpubManifest

EPUB manifest. Provides an exhaustive list of the content items that constitute the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-manifest-elem and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.3 for more information.

EpubManifestItem

An item within the EpubManifest. Represents a single content item of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-item-elem for more information.

EpubMetadata

Encapsulates meta information for the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-pkg-metadata and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2 for more information.

EpubMetadataContributor

Contributor of the book. Represents the name of a person, organization, etc. that played a secondary role in the creation of the content of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dccontributor, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.6, and http://purl.org/dc/elements/1.1/contributor for more information.

EpubMetadataCoverage

Represents a coverage of the EPUB book. A coverage is the spatial or temporal topic of the book, the spatial applicability of the book, or the jurisdiction under which the book is relevant.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.14, and http://purl.org/dc/elements/1.1/coverage for more information.

EpubMetadataCreator

Creator of the book. Represents the name of a person, organization, etc. responsible for the creation of the content of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dccreator, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.2, and http://purl.org/dc/elements/1.1/creator for more information.

EpubMetadataDate

The date of the publication or some other event associated with the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcdate, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.7, and http://purl.org/dc/elements/1.1/date for more information.

EpubMetadataDescription

Represents a description of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.4, and http://purl.org/dc/elements/1.1/description for more information.

EpubMetadataFormat

Represents a file format, physical media, or dimensions of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.9, and http://purl.org/dc/elements/1.1/format for more information.

EpubMetadataIdentifier

An identifier associated with the EPUB book, such as a UUID, DOI, or ISBN.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcidentifier, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.10, and http://purl.org/dc/elements/1.1/identifier for more information.

EpubMetadataLanguage

Represents a language of the content of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dclanguage, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.12, and http://purl.org/dc/elements/1.1/language for more information.

EpubMetadataLink

A metadata link. Links are used to associate resources with the EPUB book, such as metadata records.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-link-elem for more information.

EpubMetadataMeta

A generic metadata item of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-meta-elem, https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf2-meta, and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2 for more information.

EpubMetadataPublisher

Represents a publisher of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.5, and http://purl.org/dc/elements/1.1/publisher for more information.

EpubMetadataRelation

Represents a related resource of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.13, and http://purl.org/dc/elements/1.1/relation for more information.

EpubMetadataRights

Represents the rights held in and over the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.15, and http://purl.org/dc/elements/1.1/rights for more information.

EpubMetadataSource

Represents a source of the EPUB book. A source is a related resource from which the EPUB book is derived.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcmes-optional-def, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.11, and http://purl.org/dc/elements/1.1/source for more information.

EpubMetadataSubject

Represents a subject of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dcsubject, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.3, and http://purl.org/dc/elements/1.1/subject for more information.

EpubMetadataTitle

Represents an instance of a name given to the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dctitle, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.1, and http://purl.org/dc/elements/1.1/title for more information.

EpubMetadataType

Represents a type of the EPUB book. Types are used to indicate that the EPUB book is of a specialized type (e.g., annotations or a dictionary packaged in EPUB format).

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-opf-dctype, https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.8, and http://purl.org/dc/elements/1.1/type for more information.

EpubPackage

Parsed content of the OPF package of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-package-doc and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm for more information.

EpubSpine

EPUB spine. Defines an ordered list of EpubSpineItemRef items that represent the default reading order of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-pkg-spine and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4 for more information.

EpubSpineItemRef

An element of the EpubSpine list which references a EpubManifestItem declared in the EpubManifest. The order of the EpubSpineItemRef items in the EpubSpine list defines the default reading order of the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-itemref-elem and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4 for more information.

Smil

Parsed content of a EPUB 3 media overlay document. This class corresponds to the <smil> element which is the root element for a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-smil-elem for more information.

SmilAudio

Parsed content of the reference to a clip of audio media. This class corresponds to the <audio> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-audio-elem for more information.

SmilBody

Parsed content of the media overlay body which is the starting point for the presentation contained in the media overlay document. This class corresponds to the <body> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#elemdef-smil-body for more information.

SmilHead

Parsed content of the media overlay head which acts as a container for metadata elements. This class corresponds to the <head> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-head-elem for more information.

SmilMetadata

The metadata of the media overlay document. This is an extension point that allows the inclusion of metadata from any metainformation structuring language. This class corresponds to the <metadata> element in a media overlay document. The content of this XML element is not parsed because EPUB 3 SMIL standard doesn't put any restrictions on its structure.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-metadata-elem for more information.

SmilPar

Parsed content of a SMIL phrase which identifies a text and audio component to synchronize during playback. This class corresponds to the <par> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-par-elem for more information.

SmilSeq

Parsed content of a single item within the SMIL sequence which contains media objects that need to be rendered sequentially. The SMIL sequence consists of nested containers such as sections, asides, headers, and footnotes. It allows the structure inherent in these containers to be retained in the media overlay document. This class corresponds to the <seq> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-seq-elem for more information.

SmilText

Parsed content of the reference to an element (typically, a textual element) in the EPUB content document. This class corresponds to the <text> element in a media overlay document.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-text-elem for more information.

Enums

Epub2NcxPageTargetType

The type of the page target in EPUB 2 NCX.

See https://daisy.org/activities/standards/daisy/daisy-3/z39-86-2005-r2012-specifications-for-the-digital-talking-book/#li_392f and http://www.daisy.org/z3986/2005/ncx-2005-1.dtd for more information.

Epub3StructuralSemanticsProperty

Structural semantics property used within EPUB 3 navigation or SMIL document.

See https://www.w3.org/TR/epub-ssv-11/ for more information.

EpubManifestProperty

Property of EPUB manifest item.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-properties, https://www.w3.org/publishing/epub32/epub-packages.html#sec-item-elem, and https://www.w3.org/publishing/epub32/epub-packages.html#app-item-properties-vocab for more information.

EpubMetadataLinkProperty

Property of EpubMetadataLink.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-link-properties for more information.

EpubMetadataLinkRelationship

Property that describes the relationship between the resource referenced by EpubMetadataLink and the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-link-rel for more information.

EpubPageProgressionDirection

Page progression direction within the spine. Represents the global direction in which the content flows.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-spine-page-progression-direction for more information.

EpubSpineProperty

Property of EpubSpineItemRef.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-itemref-property-values for more information.

EpubTextDirection

Text direction of the content.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-dir for more information.

EpubVersion

Version of the EPUB specification to which the given EpubPackage conforms.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-package-version and https://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section1.3.2 for more information.

SmilVersion

Version of the SMIL specification to which the given media overlay document conforms.

See https://www.w3.org/publishing/epub32/epub-mediaoverlays.html#sec-smil-smil-elem for more information.

In this article
Back to top Generated by DocFX