Meta properties vocabulary

The properties in this vocabulary are usable in the [^meta^] element's property attribute.

Unless indicated otherwise in its "Extends" field, the properties defined in this section are used to define subexpressions: in other words, a [^meta^] element carrying a property defined in this section MUST have a refines attribute referencing a resource or expression being augmented.

The prefix URL for referencing these properties is http://idpf.org/epub/vocab/package/meta/#.

alternate-script
Name: alternate-script
Description:

The alternate-script property provides an alternate expression of the associated property value in a different language and/or script. The language tags of the alternate-script property and its associated property — as expressed by their respective in-scope xml:lang attributes — MUST NOT be the same.

This property is typically attached to creator and title properties for internationalization purposes.

Allowed value(s): xsd:string
Cardinality: zero or more
Extends: All properties.
authority
Name: authority
Description:

The authority property identifies the system or scheme the referenced element's value is drawn from.

Allowed value(s): xsd:string

The former IDPF EPUB 3 Working Group maintained a registry of subject authorities for use with this property. This Working Group no longer maintains the registry.

Cardinality: zero or one
Extends: [^dc:subject^]
belongs-to-collection
Name: belongs-to-collection
Description:

The belongs-to-collection property identifies the name of a collection to which the [=EPUB publication=] belongs. An EPUB publication MAY belong to one or more collections.

It is also possible to chain these properties using the refines attribute to indicate that one collection is itself a member of another collection.

To allow [=reading systems=] to organize collections and avoid naming collisions (e.g., unrelated collections might share a similar name, or different editions of a collection could be released), [=EPUB creators=] SHOULD provide an identifier that uniquely identifies the instance of the collection. The dcterms:identifier property must carry this identifier.

The collection MAY more precisely define its nature by attaching a collection-type property.

The position of the EPUB publication within the collection MAY be provided by attaching a group-position property.

Allowed value(s): xsd:string
Cardinality: zero or more
Extends: Applies to the EPUB publication and can refine other instances of itself.
collection-type
Name: collection-type
Description:

The collection-type property indicates the form or nature of a collection.

When the collection-type value is drawn from a code list or other formal enumeration, [=EPUB creators=] SHOULD attach a scheme attribute to identify its source.

This specification also defines the following collection types when no scheme is specified:

series

A sequence of related works that are formally identified as a group, typically open-ended with works issued individually over time.

set

A finite collection of works that together constitute a single intellectual unit, typically issued together and able to be sold as a unit.

Although [=reading systems=] are not required to support these values, specifying them provides the option to group related [=EPUB publications=] in more meaningful ways.

Allowed value(s): xsd:string
Cardinality: zero or one
Extends: belongs-to-collection
display-seq
Name: display-seq
Description:

The display-seq property indicates the numeric position in which to display the current property relative to identical metadata properties.

This property only applies where precedence rules have not already been defined (e.g., precedence is given to creators based on their appearance in document order).

Allowed value(s): xsd:unsignedInt
Cardinality: zero or one
Extends: All properties.
file-as
Name: file-as
Description: The file-as property provides the normalized form of the associated property for sorting.
Allowed value(s): xsd:string
Cardinality: zero or one
Extends: All properties.
group-position
Name: group-position
Description:

The group-position property indicates the numeric position in which the [=EPUB publication=] is ordered relative to other works belonging to the same group (whether all EPUB publications or not).

[=EPUB creators=] can attach the group-position property to any metadata property that establishes the group but it is typically associated with the belongs-to-collection property.

An EPUB publication can belong to more than one group.

Allowed value(s): A single xsd:unsignedInt or series of decimal-separated numbers (e.g., 1 or 2.2.1).
Cardinality: zero or one
Extends: All properties.
identifier-type
Name: identifier-type
Description:

The identifier-type property indicates the form or nature of an identifier.

When the identifier-type value is drawn from a code list or other formal enumeration, [=EPUB creators=] SHOULD attach a scheme attribute to identify its source.

Allowed value(s): xsd:string
Cardinality: zero or one
Extends: [^dc:identifier^], dc:source
meta-auth (deprecated)

Use of this property is deprecated.

Refer to the meta-auth property definition in [[!epubpublications-30]] for more information.

role
Name: role
Description:

The role property describes the role of a creator, contributor or publisher in the creation of an EPUB publication.

When the role value is drawn from a code list or other formal enumeration, [=EPUB creators=] SHOULD attach a scheme attribute to identify its source.

When attaching multiple roles to an individual or organization, the importance of the roles should match the document order of their containing meta elements (i.e., the first meta element encountered should contain the most important role).

Allowed value(s): xsd:string
Cardinality: zero or more
Extends: [^dc:contributor^], [^dc:creator^], dc:publisher
source-of
Name: source-of
Description:

The source-of property indicates a unique aspect of an adapted source resource that has been retained in the [=EPUB publication=].

This specification defines the pagination value to indicate that the referenced dc:source element is the source of the pagebreak properties defined in the content.

Allowed value(s): pagination
Cardinality: zero or one
Extends: dc:source

See [[epub-a11y-tech-11]] for information on how to provide accessible page navigation.

term
Name: term
Description:

The term property provides a subject code.

Allowed value(s): xsd:string
Cardinality: zero or one
Extends: [^dc:subject^]
title-type
Name: title-type
Description:

The title-type property indicates the form or nature of a title.

When the title-type value is drawn from a code list or other formal enumeration, [=EPUB creators=] SHOULD attach a scheme attribute to identify its source. When a scheme is not specified, [=reading systems=] SHOULD recognize the following title type values: main, subtitle, short, collection, edition and expanded.

Allowed value(s): xsd:string
Cardinality: zero or one
Extends: [^dc:title^]
Examples