Class: RDF::Vocab::IIIF

Inherits:
StrictVocabulary
  • Object
show all
Defined in:
lib/rdf/vocab/iiif.rb

Overview

Vocabulary for <iiif.io/api/presentation/2#>

Version:

  • 2015-12-13 23:00:00Z

Instance Attribute Summary collapse

Instance Attribute Details

#AnnotationList ⇒ RDF::Vocabulary::Term (readonly)

AnnotationLists are an ordered list of Annotation objects. Typically all Annnotations in a list target the same Canvas

Returns:

  • (RDF::Vocabulary::Term) 


7
8
9
 
# File 'lib/rdf/vocab/iiif.rb', line 7

def AnnotationList
  @AnnotationList
end

#attributionLabel ⇒ RDF::Vocabulary::Term (readonly)

A string containing an attribution description that must be displayed when using the resource

Returns:

  • (RDF::Vocabulary::Term) 


45
46
47
 
# File 'lib/rdf/vocab/iiif.rb', line 45

def attributionLabel
  @attributionLabel
end

#bottomToTopDirection ⇒ RDF::Vocabulary::Term (readonly)

Bottom-to-Top Viewing Direction

Returns:

  • (RDF::Vocabulary::Term) 


93
94
95
 
# File 'lib/rdf/vocab/iiif.rb', line 93

def bottomToTopDirection
  @bottomToTopDirection
end

#Canvas ⇒ RDF::Vocabulary::Term (readonly)

The canvas represents an individual page or view and acts as a central point for laying out the different content resources that make up the display.

Returns:

  • (RDF::Vocabulary::Term) 


11
12
13
 
# File 'lib/rdf/vocab/iiif.rb', line 11

def Canvas
  @Canvas
end

#Collection ⇒ RDF::Vocabulary::Term (readonly)

Collections are used to list the manifests available for viewing, and to describe the structures, hierarchies or collections that the physical objects are part of.

Returns:

  • (RDF::Vocabulary::Term) 


15
16
17
 
# File 'lib/rdf/vocab/iiif.rb', line 15

def Collection
  @Collection
end

#continuousHint ⇒ RDF::Vocabulary::Term (readonly)

Each canvas represents a segment of a continuous object such as a long scroll

Returns:

  • (RDF::Vocabulary::Term) 


97
98
99
 
# File 'lib/rdf/vocab/iiif.rb', line 97

def continuousHint
  @continuousHint
end

#facingPagesHint ⇒ RDF::Vocabulary::Term (readonly)

Canvases with this hint depict both parts of an opening.

Returns:

  • (RDF::Vocabulary::Term) 


101
102
103
 
# File 'lib/rdf/vocab/iiif.rb', line 101

def facingPagesHint
  @facingPagesHint
end

#hasAnnotations ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


48
49
50
 
# File 'lib/rdf/vocab/iiif.rb', line 48

def hasAnnotations
  @hasAnnotations
end

#hasCanvases ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


51
52
53
 
# File 'lib/rdf/vocab/iiif.rb', line 51

def hasCanvases
  @hasCanvases
end

#hasCollections ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


54
55
56
 
# File 'lib/rdf/vocab/iiif.rb', line 54

def hasCollections
  @hasCollections
end

#hasContentLayer ⇒ RDF::Vocabulary::Term (readonly)

A link from a Range to a Layer that provides the content resources of that Range

Returns:

  • (RDF::Vocabulary::Term) 


58
59
60
 
# File 'lib/rdf/vocab/iiif.rb', line 58

def hasContentLayer
  @hasContentLayer
end

#hasImageAnnotations ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


61
62
63
 
# File 'lib/rdf/vocab/iiif.rb', line 61

def hasImageAnnotations
  @hasImageAnnotations
end

#hasLists ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


64
65
66
 
# File 'lib/rdf/vocab/iiif.rb', line 64

def hasLists
  @hasLists
end

#hasManifests ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


67
68
69
 
# File 'lib/rdf/vocab/iiif.rb', line 67

def hasManifests
  @hasManifests
end

#hasRanges ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


70
71
72
 
# File 'lib/rdf/vocab/iiif.rb', line 70

def hasRanges
  @hasRanges
end

#hasSequences ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


73
74
75
 
# File 'lib/rdf/vocab/iiif.rb', line 73

def hasSequences
  @hasSequences
end

#hasStartCanvas ⇒ RDF::Vocabulary::Term (readonly)

A link from a Manifest or Sequence to the Canvas that the rendering agent should initialize their view with.

Returns:

  • (RDF::Vocabulary::Term) 


77
78
79
 
# File 'lib/rdf/vocab/iiif.rb', line 77

def hasStartCanvas
  @hasStartCanvas
end

#individualsHint ⇒ RDF::Vocabulary::Term (readonly)

Each canvas represents a separate individual object, and should not have transitions

Returns:

  • (RDF::Vocabulary::Term) 


105
106
107
 
# File 'lib/rdf/vocab/iiif.rb', line 105

def individualsHint
  @individualsHint
end

#Layer ⇒ RDF::Vocabulary::Term (readonly)

Layers are lists of AnnotationLists to group them together, for example to create the set of lists that make up a particular translation/edition of a text

Returns:

  • (RDF::Vocabulary::Term) 


19
20
21
 
# File 'lib/rdf/vocab/iiif.rb', line 19

def Layer
  @Layer
end

#leftToRightDirection ⇒ RDF::Vocabulary::Term (readonly)

Left-to-Right Viewing Direction

Returns:

  • (RDF::Vocabulary::Term) 


109
110
111
 
# File 'lib/rdf/vocab/iiif.rb', line 109

def leftToRightDirection
  @leftToRightDirection
end

#Manifest ⇒ RDF::Vocabulary::Term (readonly)

The manifest resource represents a single object and any intellectual work or works embodied within that object

Returns:

  • (RDF::Vocabulary::Term) 


23
24
25
 
# File 'lib/rdf/vocab/iiif.rb', line 23

def Manifest
  @Manifest
end

#metadataLabels ⇒ RDF::Vocabulary::Term (readonly)

An rdf:List of label/value pairs providing descriptive metadata about the resource, intended for human audience

Returns:

  • (RDF::Vocabulary::Term) 


81
82
83
 
# File 'lib/rdf/vocab/iiif.rb', line 81

def metadataLabels
  @metadataLabels
end

#multiPartHint ⇒ RDF::Vocabulary::Term (readonly)

Collections with this hint consist of multiple manifests that each form part of a logical whole.

Returns:

  • (RDF::Vocabulary::Term) 


113
114
115
 
# File 'lib/rdf/vocab/iiif.rb', line 113

def multiPartHint
  @multiPartHint
end

#nonPagedHint ⇒ RDF::Vocabulary::Term (readonly)

Viewing Hint that the Canvas MUST NOT be presented in a page turner

Returns:

  • (RDF::Vocabulary::Term) 


117
118
119
 
# File 'lib/rdf/vocab/iiif.rb', line 117

def nonPagedHint
  @nonPagedHint
end

#pagedHint ⇒ RDF::Vocabulary::Term (readonly)

Viewing Hint that object has canvases that represent pages that can be turned

Returns:

  • (RDF::Vocabulary::Term) 


121
122
123
 
# File 'lib/rdf/vocab/iiif.rb', line 121

def pagedHint
  @pagedHint
end

#painting ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


124
125
126
 
# File 'lib/rdf/vocab/iiif.rb', line 124

def painting
  @painting
end

#Range ⇒ RDF::Vocabulary::Term (readonly)

Ranges describe additional structure within an object, such as newspaper articles that span pages, the range of non-content-bearing pages at the beginning of a work, or chapters within a book

Returns:

  • (RDF::Vocabulary::Term) 


27
28
29
 
# File 'lib/rdf/vocab/iiif.rb', line 27

def Range
  @Range
end

#rightToLeftDirection ⇒ RDF::Vocabulary::Term (readonly)

Right-to-Left Viewing Direction

Returns:

  • (RDF::Vocabulary::Term) 


128
129
130
 
# File 'lib/rdf/vocab/iiif.rb', line 128

def rightToLeftDirection
  @rightToLeftDirection
end

#Sequence ⇒ RDF::Vocabulary::Term (readonly)

The sequence conveys the ordering of the views of the object.

Returns:

  • (RDF::Vocabulary::Term) 


31
32
33
 
# File 'lib/rdf/vocab/iiif.rb', line 31

def Sequence
  @Sequence
end

#topHint ⇒ RDF::Vocabulary::Term (readonly)

The topmost range in a nested hierarchy, such as a table of contents

Returns:

  • (RDF::Vocabulary::Term) 


132
133
134
 
# File 'lib/rdf/vocab/iiif.rb', line 132

def topHint
  @topHint
end

#topToBottomDirection ⇒ RDF::Vocabulary::Term (readonly)

Top-to-Bottom Viewing Direction

Returns:

  • (RDF::Vocabulary::Term) 


136
137
138
 
# File 'lib/rdf/vocab/iiif.rb', line 136

def topToBottomDirection
  @topToBottomDirection
end

#viewingDirection ⇒ RDF::Vocabulary::Term (readonly)

References the sc:ViewingDirection that defines the direction that the resource should be viewed in

Returns:

  • (RDF::Vocabulary::Term) 


85
86
87
 
# File 'lib/rdf/vocab/iiif.rb', line 85

def viewingDirection
  @viewingDirection
end

#ViewingDirection ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


34
35
36
 
# File 'lib/rdf/vocab/iiif.rb', line 34

def ViewingDirection
  @ViewingDirection
end

#viewingHint ⇒ RDF::Vocabulary::Term (readonly)

A hint to a user agent as to how to render the resource

Returns:

  • (RDF::Vocabulary::Term) 


89
90
91
 
# File 'lib/rdf/vocab/iiif.rb', line 89

def viewingHint
  @viewingHint
end

#ViewingHint ⇒ RDF::Vocabulary::Term (readonly)

Returns:

  • (RDF::Vocabulary::Term) 


37
38
39
 
# File 'lib/rdf/vocab/iiif.rb', line 37

def ViewingHint
  @ViewingHint
end

#Zone ⇒ RDF::Vocabulary::Term (readonly)

Used to group annotations together in an area of a Canvas, for example to model columns, foldouts or palimpsests; Note that Zones are not currently used in the IIIF Presentation API.

Returns:

  • (RDF::Vocabulary::Term) 


41
42
43
 
# File 'lib/rdf/vocab/iiif.rb', line 41

def Zone
  @Zone
end