Skip to content

Latest commit

 

History

History
340 lines (189 loc) · 11.2 KB

issue.md

File metadata and controls

340 lines (189 loc) · 11.2 KB
Raw

Newspaper Issue Type

object (Newspaper Issue)

Newspaper Issue Properties

Property Type Required Nullable Defined by
id string Required cannot be null Newspaper Issue
cdt string Required cannot be null Newspaper Issue
i array Required cannot be null Newspaper Issue
s array Optional cannot be null Newspaper Issue
pp array Required cannot be null Newspaper Issue
n string Optional cannot be null Newspaper Issue
ar string Required cannot be null Newspaper Issue
iiif_manifest_uri string Optional cannot be null Newspaper Issue

id

Canonical ID of the newspaper issue (e.g. GDL-1900-01-02-a)

id

id Type

string

cdt

Creation date timestamp (of the JSON file).

cdt

cdt Type

string

i

The content items contained in the newspaper issue.

i

i Type

object[] (Details)

s

The text style as defined in the OCR output. Each style consists of:

  • a name (id)
  • a type-face (f)
  • a font-size (fs)
  • a color (rgb).

s

s Type

object[] (Details)

pp

Canonical IDs of pages in the issue, without file extension (e.g. GDL-1900-01-02-a-p0004).

pp

pp Type

string[]

n

Notes.

n

n Type

string

ar

Access rights. Three possible situations are defined:

  1. open public: access without NDA, user could redistribute (as defined per Terms of Use)
  2. open private: access without an NDA, user cannot redistribute (private/academic use only)
  3. closed : accessible only upon signing an NDA, user cannot redistribute

ar

ar Type

string

ar Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"open_public"
"open_private"
"closed"

iiif_manifest_uri

URI for the issue's manifest in the IIIF Presentation API, if the corresponding IIIF server has one.

iiif_manifest_uri

iiif_manifest_uri Type

string

Newspaper Issue Definitions

Definitions group metadata

Reference this group by using

{"$ref":"https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata"}
Property Type Required Nullable Defined by
id string Required cannot be null Newspaper Issue
l string Optional cannot be null Newspaper Issue
pp array Required cannot be null Newspaper Issue
t string Optional cannot be null Newspaper Issue
tp string Required cannot be null Newspaper Issue
iiif_link string Optional cannot be null Newspaper Issue
ro integer Optional cannot be null Newspaper Issue

id

Content item ID (e.g. GDL-1900-01-02-a-i0001).

id

id Type

string

l

Language of the content item.

l

l Type

string

pp

Page numbers over which the content item spans.

pp

pp Type

integer[]

t

Title of the content item.

t

t Type

string

tp

Type of the content item.

tp

tp Type

string

tp Constraints

enum: the value of this property must be equal to one of the following values:

Value Explanation
"article"
"ad"
"image"
"table"
"death_notice"
"weather"
"page"

iiif_link

IIIF image link, depending on content item type (if tp == image). Should follow the format: '{scheme}://{server}/{prefix}/{identifier}/info.json'.

iiif_link

iiif_link Type

string

ro

Reading order index of the content item, for the table of contents view on the interface. If not defined, the CI number (after 'i' in the ID) should be used.

ro

ro Type

integer