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

This document describes the EPUB Annotations Vocabulary, i.e., an RDFS [[rdf-schema]] vocabulary formalizing the terms defined in the [[[epub-ann]]] specification. The vocabulary is a "profile" of the W3C [[[annotation-vocab]]].

Namespaces

This specification makes use of the following namespaces:

ea
http://www.w3.org/ns/ea#
oa
http://www.w3.org/ns/oa#
as
http://www.w3.org/ns/activitystreams#
foaf
http://xmlns.com/foaf/0.1/
dc
http://purl.org/dc/terms/
dcterms
http://purl.org/dc/terms/
owl
http://www.w3.org/2002/07/owl#
rdf
http://www.w3.org/1999/02/22-rdf-syntax-ns#
rdfs
http://www.w3.org/2000/01/rdf-schema#
xsd
http://www.w3.org/2001/XMLSchema#

Term definitions

Class definitions

The following are class definitions in the ea namespace.

About

Information about the EPUB publication

See the formal definition of the term.

(Externally defined) 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

Annotation

EPUB Annotation Object

See the formal definition of the term.

The Annotation object of EPUB Annotation; the list of acceptable properties are restricted compared to the Web Annotation version.
Subclass of:
oa:Annotation
Range of:
items
Domain of:
hasBody, motivatedBy, hasTarget
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

AnnotationSet

Set of annotations

See the formal definition of the term.

Domain of:
about, generator, items, hasTitle
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

Body

Body of an EPUB Annotation

See the formal definition of the term.

In EPUB, annotations are restricted to textual content.
Subclass of:
oa:TextualBody
Range of:
hasBody
Domain of:
color, highlight, tags
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

Creator

Creator of an EPUB Annotation

See the formal definition of the term.

The context file contains aliases for the possible creator values, JSON-LD serializations should use the terms Person, Organization, or Software.
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

Meta

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

Generator

Information about the tools generating the annotations

See the formal definition of the term.

Range of:
generator
In the domain of:
name
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

Selector

A restrictive subset of selectors, usable in EPUB

See the formal definition of the term.

The final list of selectors for EPUB is still to be defined, this is only a placeholder for now.
Subclass of:
oa:FragmentSelector ⊔ oa:CssSelector ⊔ oa:TextQuoteSelector
Range of:
hasSelector
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

Target

Target of an EPUB Annotation

See the formal definition of the term.

Range of:
hasTarget
Domain of:
meta, hasSource
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

Property definitions

The following are property definitions in the ea namespace.

about

Information on the EPUB publication

See the formal definition of the term.

Domain:
AnnotationSet
Range:
About
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

hasBody

The body of an annotation

See the formal definition of the term.

The context file "shadows" the body term in the Web Annotation context file, restricting its range.

In the generated JSON-LD context file this term appears as "body".

Subproperty of:
oa:hasBody
Domain:
Annotation
Range:
Body
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

color

Color

See the formal definition of the term.

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

creator

The creator of an annotation

See the formal definition of the term.

The usage of the Dublin Core's dcterm value is restricted to certain type of values...
Subproperty of:
dcterms:creator
Range:
Creator
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

generator

Generator

See the formal definition of the term.

The context file "shadows" the generator term in the Web Annotation context file, restricting its range; see formal definition for the restrictions.
Domain:
AnnotationSet
Range:
Generator
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

highlight

Highlight

See the formal definition of the term.

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

homepage

foaf:homepage

In the generated JSON-LD context file this term appears as "homepage".

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

This term is formally defined in another vocabulary (as foaf:homepage), but is frequently used with this vocabulary and has been included to aid readability of this document.

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

items

The reference to the 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

Meta

See the formal definition of the term.

Domain:
Target
Range:
Meta
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

motivatedBy

The motivation for an annotation

See the formal definition of the term.

The context file "shadows" the body term in the Web Annotation context file, restricting its range.

In the generated JSON-LD context file this term appears as "motivation".

Subproperty of:
oa:motivatedBy
Domain:
Annotation
Range:
ea:Motivation
Value may be one of:
oa:bookmarking, oa:commenting, oa:highlighting
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

name

Name

See the formal definition of the term.

This property restricts the usage of foaf:name to be used on creators.
Subproperty of:
foaf:name
Domain:
Creator ⊔ Generator
Range:
xsd:string
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

hasSelector

Assign selector(s) to a target

See the formal definition of the term.

The range of this subproperty represents a subset of the Selectors, as defined by the Open Annotation specification.

In the generated JSON-LD context file this term appears as "selector".

Subproperty of:
oa:hasSelector
Range:
Selector
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

hasSource

Has source

See the formal definition of the term.

The context file "shadows" the source term in the Web Annotation context file, restricting its domain and controlling its alias name.

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

In the generated JSON-LD context file this term appears as "source".

Subproperty of:
oa:hasSource
Domain:
Target
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

tags

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.

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

hasTarget

The target of an annotation

See the formal definition of the term.

The context file "shadows" the target term in the Web Annotation context file, restricting its range.

In the generated JSON-LD context file this term appears as "target".

Subproperty of:
oa:hasTarget
Domain:
Annotation
Range:
Target
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

hasTitle

Title of the Annotation Set

See the formal definition of the term.

In the generated JSON-LD context file this term appears as "title".

Domain:
AnnotationSet
Range:
xsd:string
Relevant @context:
https://www.w3.org/ns/epub-anno.jsonld

Definitions for individuals

The following are definitions for individuals in the ea namespace.

pink

Pink selection color

See the formal definition of the term.

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

orange

Orange selection color

See the formal definition of the term.

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

yellow

Yellow selection color

See the formal definition of the term.

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

green

Green selection color

See the formal definition of the term.

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

blue

Blue selection color

See the formal definition of the term.

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

purple

Purple selection color

See the formal definition of the term.

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

solid

Solid selection highlight

See the formal definition of the term.

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

underline

Underline selection highlight

See the formal definition of the term.

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

strikethrough

Strikethrough selection highlight

See the formal definition of the term.

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

outline

Outline selection highlight

See the formal definition of the term.

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