module IiifS3

Module IiifS3 is a tool for generating IIIF resources from a set of files.

It's designed to support the IIIF level 0 profile, and generates entirely static files.

@author David Newbury <david.newbury@gmail.com>

Constants

ANNOTATION_TYPE

@return [String] The IIIF default type for a annotation.

CANVAS_TYPE

@return [String] The IIIF default type for a canvas

DEFAULT_CANVAS_LABEL

@return [String] The default label for a canvas without a specified name.

DEFAULT_SEQUENCE_NAME

@return [String] The default name for a sequence without a specified name.

DEFAULT_VIEWING_DIRECTION

@return [String] The default reading direction for this manifest.

FakeImageVariant
FakeManifest
IMAGE_CONTEXT

@return [String] The URI of the image context for the IIIF V.2

IMAGE_PROTOCOL

@return [String] The URI of the image protocol for IIIF

IMAGE_TYPE

@return [String] The IIIF default type for an image.

LEVEL_0

@return [String] The URI of the Level 0 profile for the IIIF V.2

MIN_CANVAS_SIZE

@return [Number] The size in pixels below which the canvas will be doubled.

MOTIVATION

@return [String] The default label for a canvas without a specified name.

PRESENTATION_CONTEXT

@return [String] The URI of the presentation context for the IIIF V.2

SEQUENCE_TYPE

@return [String] The IIIF default type for a sequence.

VERSION

@return [String] The current library version

Public Class Methods

is_valid_viewing_direction(direction) click to toggle source

Validates a viewing direction string against the IIIF V.2.0 spec.

According to v2 of the IIIF standards, there are only four valid viewing directions: “left-to-right”, “top-to-bottom”, ”bottom-to-top“ , and ”right-to-left“. This

returns true if the provided direction is one of these, and falst for anything else.

@param [String] direction A viewing direction string

@return [boolean] Is the provided string a valid viewing direction?

# File lib/iiif_s3.rb, line 77
def self.is_valid_viewing_direction(direction)
  direction == "left-to-right" ||
  direction == "top-to-bottom" ||
  direction == "bottom-to-top" ||
  direction == "right-to-left" 
end