Options
All
  • Public
  • Public/Protected
  • All
Menu

Contains all the canonical (normalized and processed) manifest data for a Web Publication.

Hierarchy

  • IWpManifestData

Index

Properties

abridged?: boolean

The abridged property provides information on whether or not a digital publication has been shortened from its original form.

accessMode?: string[]

The human sensory perceptual system or cognitive faculty through which a person may process or perceive information.

Expected values include: auditory, tactile, textual, visual, colorDependent, chartOnVisual, chemOnVisual, diagramOnVisual, mathOnVisual, musicOnVisual, textOnVisual.

See: https://www.w3.org/2021/a11y-discov-vocab/latest/#accessMode

accessModeSufficient?: string[]

A list of single or combined access modes that are sufficient to understand all the intellectual content of a resource.

Expected values include: auditory, tactile, textual, visual.

See: https://www.w3.org/2021/a11y-discov-vocab/latest/#accessModeSufficient

accessibilityFeature?: string[]

Content features of the resource, such as accessible media, alternatives and supported enhancements for accessibility.

accessibilityHazard?: string[]

A characteristic of the described resource that is physiologically dangerous to some users.

accessibilitySummary?: IWpLocalizableString

A human-readable summary of specific accessibility features or deficiencies that is consistent with the other accessibility metadata.

artist?: IWpEntityData[]

The primary artist for the publication, in a medium other than pencils or digital line art.

author?: IWpEntityData[]

The author of the publication.

Synonymous with the creator property. If both are specified, it is advised to use the more specific author property.

See: https://schema.org/author

colorist?: IWpEntityData[]

The individual who adds color to inked drawings.

conformsTo: string[]

Indicates the profile the manifest and content conforms to.

contributor?: IWpEntityData[]

Contributor whose role does not fit to one of the other roles in this table.

creator?: IWpEntityData[]

The creator of the publication.

Synonymous with the author property. If both are specified, it is advised to use the more specific author property.

See: https://schema.org/creator

dateModified?: string

Last modification date of the publication, expressed in ISO 8601 Date, or Date Time formats.

datePublished?: string

The date on which the digital publication was originally published, expressed in ISO 8601 Date, or Date Time formats.

direction?: string

Gives the base direction for localizable strings.

duration?: string

Indicates the overall length of a time-based digital publication (e.g., an audiobook or a book consisting of a series of video clips).

If defined, it must be a duration value as defined by ISO 8601-1.

editor?: IWpEntityData[]

The editor of the publication.

id?: string

The canonical identifier of the publication. Must be a valid URL.

Example: "http://www.w3.org/TR/tabular-data-model/" "urn:isbn:9780123456789"

illustrator?: IWpEntityData[]

The illustrator of the publication.

inLanguage?: string[]

Default language for the publication.

One or more well-formed language tags [bcp47].

inker?: IWpEntityData[]

The individual who traces over the pencil drawings in ink.

letterer?: IWpEntityData[]

The individual who adds lettering, including speech balloons and sound effects, to artwork.

List of resources associated with the publication but not required for its processing or rendering.

The human-readable title of the publication.

penciler?: IWpEntityData[]

The individual who draws the primary narrative artwork.

publisher?: IWpEntityData[]

The publisher of the publication.

readBy?: IWpEntityData[]

A person who reads (performs) the publication (for audiobooks).

readingOrder: IWpLinkedResourceData[]

An ordered list, defining the default order of progression through the resources of the publication.

WpPublication.getSpine() is built using this reading order.

readingProgression?: string

Reading progression direction from one resource to the other. Is One of: "ltr" or "rtl"

List of additional publication resources used in the processing or rendering of a publication.

translator?: IWpEntityData[]

The translator of the publication.

type: string[]

Defines the Publication Type. The type MAY be mapped onto any [schema.org] type.

When no type is specified in the manifest, a default value will be set:

  • If "conformsTo" contains the Audiobook profile "https://www.w3.org/TR/audiobooks/", then type will default to "Audiobook".
  • Otherwise, "CreativeWork" is assumed as the default type.

See https://schema.org/CreativeWork#subtypes for sub-types to CreativeWork.

uniqueResources: string[]

List of unique resource URLs in this publication. This is the set of all URLs from "readingOrder" and "resources"

url?: string[]

Identifies the source URL of the publication.

Generated using TypeDoc