EPUB Annotations Vocabulary 1.0

Abstract

This document defines the vocabulary for the EPUB Annotations 1.0 specification. RDF versions of the vocabulary, in Turtle [turtle] and JSON-LD [json-ld11], as well as a JSON-LD @context, are also available.

The following are class definitions in the ea namespace.

Information about the EPUB publication

See the formal definition of the term.

Dublin Core terms are used with this class, retaining the prefixes (to be in line with the EPUB Package Document).

Range of:: about

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

EPUB Annotation Object

See the formal definition of the term.

A subclass of the Web Annotation object with some restrictions with regards of various properties.

Subclass of:: oa:Annotation

Range of:: items
Domain of:: body, motivation, target

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Set of annotations

See the formal definition of the term.

An unordered collection of annotations, used as an interchange format amont EPUB Reading Systems.

Domain of:: about, generator, items, setTitle

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Body of an EPUB Annotation

See the formal definition of the term.

In EPUB, annotations are restricted to have textual content only.

Subclass of:: oa:TextualBody

Range of:: body
Domain of:: color, highlight, tags

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Creator of an EPUB Annotation

See the formal definition of the term.

JSON-LD serializations should use the terms Person, Organization, or Software for typing, as these are the only available creator types.

Subclass of:: foaf:Person ⊔ foaf:Organization ⊔ as:Application

Range of:: creator
In the domain of:: name

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Fragment Selector in EPUB

See the formal definition of the term.

This is restricted version of the Web Annotation Fragment Selector, reducing the list of valid media types.

Subclass of:: oa:FragmentSelector

Domain of:: conformsTo

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Generator

See the formal definition of the term.

Information about the tool generating the annotations.

Range of:: generator
Domain of:: homepage
In the domain of:: name

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Meta

See the formal definition of the term.

this class is currently undefined...

Range of:: meta

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

EPUB Annotation selector

See the formal definition of the term.

A restrictive subset of selectors, usable in EPUB.

Subclass of:: FragmentSelector ⊔ oa:CssSelector ⊔ oa:TextPositionSelector

Range of:: refinedBy, selector
Domain of:: refinedBy

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Target of an EPUB Annotation.

See the formal definition of the term.

Range of:: target
Domain of:: meta, selector, source

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

The following are property definitions in the ea namespace.

Information on the EPUB publication

See the formal definition of the term.

Provide information on the EPUB publication associated with an Annotation Set.

Domain:: AnnotationSet
Range:: About

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Designates the body of an annotation

See the formal definition of the term.

The range of body types is restricted for EPUB.

Subproperty of:: oa:hasBody

Domain:: Annotation
Range:: Body

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Highlight color

See the formal definition of the term.

Domain:: Body

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Designates the fragment format

See the formal definition of the term.

The range of possible media formats in Fragment Selectors is restricted, see the range of this property.

Subproperty of:: dcterms:conformsTo

Domain:: FragmentSelector
Range:: dcterms:Standard

Value may be one of:: https://tools.ietf.org/rfc/rfc3236.html, http://www.w3.org/TR/media-frags/, https://www.w3.org/TR/SVG/, https://wicg.github.io/scroll-to-text-fragment/

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Information on the creator of an annotation

See the formal definition of the term.

The range of Creator types is restricted in EPUB.

Subproperty of:: dcterms:creator

Range:: Creator

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Information on the tool generating the annotations

See the formal definition of the term.

Subproperty of:: as:generator

Domain:: AnnotationSet
Range:: Generator

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Highlight mode

See the formal definition of the term.

Domain:: Body

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Homepage of the tool generating the annotations

See the formal definition of the term.

The property's value should be a URL, i.e., not a literal.

Subproperty of:: foaf:homepage

Domain:: Generator

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Items in a set of annotations

See the formal definition of the term.

Domain:: AnnotationSet
Range:: Annotation
In a JSON-LD representation, values to this property are supposed to be represented in the form of a JSON array, even if there is just a single value.

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Meta

See the formal definition of the term.

To be defined…

Domain:: Target
Range:: Meta

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Provides the motivation for an annotation

See the formal definition of the term.

The set of motivation types is restricted in EPUB, see the range definition. In the JSON-LD serialization those terms should be used without prefix.

Subproperty of:: oa:motivatedBy

Domain:: Annotation
Range:: oa:Motivation

Value may be one of:: oa:bookmarking, oa:commenting, oa:highlighting

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Name

See the formal definition of the term.

This property is available on some classes, see domain definition.

Subproperty of:: foaf:name

Domain:: Creator ⊔ Generator
Range:: xsd:string

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Selector refinement

See the formal definition of the term.

This property restricts the usage of the general oa:refinedBy property to the list of Selector types available in EPUB.

Subproperty of:: oa:refinedBy

Domain:: Selector
Range:: Selector

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Designates the selector(s) for a target

See the formal definition of the term.

This property restricts the possible Selector types in EPUB.

Subproperty of:: oa:hasSelector

Domain:: Target
Range:: Selector

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Designates the source resource for the target

See the formal definition of the term.

The property's value should be a URL, i.e., not a literal.

Subproperty of:: oa:hasSource

Domain:: Target

Relevant @context:: https://www.w3.org/ns/epub-anno.jsonld

Tags

See the formal definition of the term.

Domain:: Body
Range:: xsd:string
In a JSON-LD representation, values to this property are supposed to be represented in the form of a JSON array, even if there is just a single value.