From c43b79b365fa8df015cd6438316b7955762aa73d Mon Sep 17 00:00:00 2001 From: Matteo Romanello Date: Thu, 7 Oct 2021 11:41:26 +0200 Subject: [PATCH] started extension of schemas for classical commentary documents (as per issue #24) --- Makefile | 1 + docs/commentary-properties-cc.md | 3 + docs/commentary-properties-cdt.md | 3 + docs/commentary-properties-id.md | 3 + docs/commentary-properties-iiif.md | 3 + ...y-properties-r-items-properties-c-items.md | 3 + ...mentary-properties-r-items-properties-c.md | 7 + ...s-properties-l-items-properties-c-items.md | 3 + ...p-items-properties-l-items-properties-c.md | 7 + ...s-properties-t-items-properties-c-items.md | 3 + ...l-items-properties-t-items-properties-c.md | 7 + ...-items-properties-t-items-properties-gn.md | 3 + ...-items-properties-t-items-properties-hy.md | 3 + ...-items-properties-t-items-properties-nf.md | 3 + ...l-items-properties-t-items-properties-s.md | 3 + ...-items-properties-t-items-properties-tx.md | 3 + ...s-properties-l-items-properties-t-items.md | 126 ++++++++ ...p-items-properties-l-items-properties-t.md | 3 + ...s-properties-p-items-properties-l-items.md | 50 +++ ...r-items-properties-p-items-properties-l.md | 3 + ...y-properties-r-items-properties-p-items.md | 27 ++ ...mentary-properties-r-items-properties-p.md | 3 + ...ntary-properties-r-items-properties-pof.md | 3 + docs/commentary-properties-r-items.md | 69 +++++ docs/commentary-properties-r.md | 3 + docs/commentary.md | 103 +++++++ ...operties-ppreb-items-properties-t-items.md | 48 +-- docs/contentitem-properties-ppreb-items.md | 48 +-- docs/contentitem.md | 200 ++++++------ ...ssue-definitions-metadata-properties-tp.md | 2 +- docs/issue-definitions-metadata.md | 92 +++--- docs/issue-properties-ar.md | 2 +- docs/issue-properties-i-items.md | 20 +- docs/issue-properties-s-items.md | 62 ++-- docs/issue.md | 209 +++++++------ ...uage_identification-definitions-lidtype.md | 32 +- ...n-definitions-versiontype-properties-ts.md | 2 +- ..._identification-definitions-versiontype.md | 34 ++- docs/language_identification-properties-lg.md | 5 +- ...e_identification-properties-lg_decision.md | 2 +- ...guage_identification-properties-orig_lg.md | 5 +- ...identification-properties-versiontype-1.md | 36 ++- ...e_identification-properties-versiontype.md | 36 ++- ...identification-properties-votes-items-0.md | 34 ++- docs/language_identification.md | 286 ++++++++++-------- ...s-properties-l-items-properties-t-items.md | 90 +++--- ...s-properties-p-items-properties-l-items.md | 34 ++- ...e-properties-r-items-properties-p-items.md | 20 +- docs/page-properties-r-items.md | 48 +-- docs/page.md | 74 +++-- docs/topic_assignment-definitions-topic.md | 36 ++- docs/topic_assignment.md | 110 ++++--- ...topic_description-definitions-word_prob.md | 34 ++- docs/topic_description.md | 122 ++++---- json/commentary/commentary.schema.json | 115 +++++++ 55 files changed, 1535 insertions(+), 751 deletions(-) create mode 100644 docs/commentary-properties-cc.md create mode 100644 docs/commentary-properties-cdt.md create mode 100644 docs/commentary-properties-id.md create mode 100644 docs/commentary-properties-iiif.md create mode 100644 docs/commentary-properties-r-items-properties-c-items.md create mode 100644 docs/commentary-properties-r-items-properties-c.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c-items.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c-items.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-gn.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-hy.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-nf.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-s.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-tx.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l-items.md create mode 100644 docs/commentary-properties-r-items-properties-p-items-properties-l.md create mode 100644 docs/commentary-properties-r-items-properties-p-items.md create mode 100644 docs/commentary-properties-r-items-properties-p.md create mode 100644 docs/commentary-properties-r-items-properties-pof.md create mode 100644 docs/commentary-properties-r-items.md create mode 100644 docs/commentary-properties-r.md create mode 100644 docs/commentary.md create mode 100644 json/commentary/commentary.schema.json diff --git a/Makefile b/Makefile index 2d5a641..f71c6c9 100644 --- a/Makefile +++ b/Makefile @@ -24,6 +24,7 @@ documentation: # make sure to install the correct jsonschema2md tool: # npm install -g @adobe/jsonschema2md jsonschema2md -d json/newspaper/ --header false -n -v 06 -o docs -x - -s propTable + jsonschema2md -d json/commentary/ --header false -n -v 06 -o docs -x - -s propTable jsonschema2md -d json/topic_model/ --header false -n -v 06 -o docs -x - -s propTable jsonschema2md -d json/language_identification/ --header false -n -v 06 -o docs -x - -s propTable #jsonschema2md -d json/linguistic_annotation/ -n -v 06 -o docs diff --git a/docs/commentary-properties-cc.md b/docs/commentary-properties-cc.md new file mode 100644 index 0000000..b3a7975 --- /dev/null +++ b/docs/commentary-properties-cc.md @@ -0,0 +1,3 @@ +## cc Type + +`boolean` diff --git a/docs/commentary-properties-cdt.md b/docs/commentary-properties-cdt.md new file mode 100644 index 0000000..84132d8 --- /dev/null +++ b/docs/commentary-properties-cdt.md @@ -0,0 +1,3 @@ +## cdt Type + +`string` diff --git a/docs/commentary-properties-id.md b/docs/commentary-properties-id.md new file mode 100644 index 0000000..6917deb --- /dev/null +++ b/docs/commentary-properties-id.md @@ -0,0 +1,3 @@ +## id Type + +`string` diff --git a/docs/commentary-properties-iiif.md b/docs/commentary-properties-iiif.md new file mode 100644 index 0000000..8b87cb7 --- /dev/null +++ b/docs/commentary-properties-iiif.md @@ -0,0 +1,3 @@ +## iiif Type + +`string` diff --git a/docs/commentary-properties-r-items-properties-c-items.md b/docs/commentary-properties-r-items-properties-c-items.md new file mode 100644 index 0000000..fb6d93c --- /dev/null +++ b/docs/commentary-properties-r-items-properties-c-items.md @@ -0,0 +1,3 @@ +## items Type + +`integer` diff --git a/docs/commentary-properties-r-items-properties-c.md b/docs/commentary-properties-r-items-properties-c.md new file mode 100644 index 0000000..19472ed --- /dev/null +++ b/docs/commentary-properties-r-items-properties-c.md @@ -0,0 +1,7 @@ +## c Type + +`integer[]` + +## c Constraints + +**minimum number of items**: the minimum number of items for this array is: `4` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c-items.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c-items.md new file mode 100644 index 0000000..fb6d93c --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c-items.md @@ -0,0 +1,3 @@ +## items Type + +`integer` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c.md new file mode 100644 index 0000000..19472ed --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c.md @@ -0,0 +1,7 @@ +## c Type + +`integer[]` + +## c Constraints + +**minimum number of items**: the minimum number of items for this array is: `4` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c-items.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c-items.md new file mode 100644 index 0000000..fb6d93c --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c-items.md @@ -0,0 +1,3 @@ +## items Type + +`integer` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c.md new file mode 100644 index 0000000..19472ed --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c.md @@ -0,0 +1,7 @@ +## c Type + +`integer[]` + +## c Constraints + +**minimum number of items**: the minimum number of items for this array is: `4` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-gn.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-gn.md new file mode 100644 index 0000000..b9839fa --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-gn.md @@ -0,0 +1,3 @@ +## gn Type + +`boolean` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-hy.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-hy.md new file mode 100644 index 0000000..9120fbf --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-hy.md @@ -0,0 +1,3 @@ +## hy Type + +`boolean` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-nf.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-nf.md new file mode 100644 index 0000000..0d2ea7c --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-nf.md @@ -0,0 +1,3 @@ +## nf Type + +`string` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-s.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-s.md new file mode 100644 index 0000000..b6232b6 --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-s.md @@ -0,0 +1,3 @@ +## s Type + +`integer` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-tx.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-tx.md new file mode 100644 index 0000000..14d93a6 --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-tx.md @@ -0,0 +1,3 @@ +## tx Type + +`string` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md new file mode 100644 index 0000000..dc2492a --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md @@ -0,0 +1,126 @@ +## items Type + +`object` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md)) + +# items Properties + +| Property | Type | Required | Nullable | Defined by | +| :-------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [c](#c) | `array` | Required | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/c") | +| [tx](#tx) | `string` | Required | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-tx.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/tx") | +| [s](#s) | `integer` | Optional | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/s") | +| [gn](#gn) | `boolean` | Optional | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-gn.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/gn") | +| [hy](#hy) | `boolean` | Optional | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-hy.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/hy") | +| [nf](#nf) | `string` | Optional | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-nf.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/nf") | + +## c + +Coordinates of image-region. + +`c` + +* is required + +* Type: `integer[]` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/c") + +### c Type + +`integer[]` + +### c Constraints + +**minimum number of items**: the minimum number of items for this array is: `4` + +## tx + +Token surface form. + +`tx` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-tx.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/tx") + +### tx Type + +`string` + +## s + +A style ID as defined in issue.schema.json/s + +`s` + +* is optional + +* Type: `integer` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/s") + +### s Type + +`integer` + +## gn + +Indicates whether the token is/should be followed by a whitespace. `gn==true` means no white space is required (`gn` stands for 'glue next'). When not specified it is assumed to be `false`. + +`gn` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-gn.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/gn") + +### gn Type + +`boolean` + +## hy + +Indicates whether the token constitutes the former part of a hyphenated word (including hyphen). When not specified it is assumed to be `false`. + +`hy` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-hy.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/hy") + +### hy Type + +`boolean` + +## nf + +It is specified on the latter part(s) of a hyphenated word, and contains its normalized (dehyphenated) form. + +`nf` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-nf.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t/items/properties/nf") + +### nf Type + +`string` diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t.md new file mode 100644 index 0000000..b453b95 --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t.md @@ -0,0 +1,3 @@ +## t Type + +`object[]` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md)) diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l-items.md b/docs/commentary-properties-r-items-properties-p-items-properties-l-items.md new file mode 100644 index 0000000..e11b588 --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l-items.md @@ -0,0 +1,50 @@ +## items Type + +`object` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items.md)) + +# items Properties + +| Property | Type | Required | Nullable | Defined by | +| :------- | :------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [c](#c) | `array` | Required | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/c") | +| [t](#t) | `array` | Required | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t") | + +## c + +Coordinates of image-region. + +`c` + +* is required + +* Type: `integer[]` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/c") + +### c Type + +`integer[]` + +### c Constraints + +**minimum number of items**: the minimum number of items for this array is: `4` + +## t + +Tokens (as detected by the OCR engine). + +`t` + +* is required + +* Type: `object[]` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md)) + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l/items/properties/t") + +### t Type + +`object[]` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items.md)) diff --git a/docs/commentary-properties-r-items-properties-p-items-properties-l.md b/docs/commentary-properties-r-items-properties-p-items-properties-l.md new file mode 100644 index 0000000..1ad0a8d --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items-properties-l.md @@ -0,0 +1,3 @@ +## l Type + +`object[]` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items.md)) diff --git a/docs/commentary-properties-r-items-properties-p-items.md b/docs/commentary-properties-r-items-properties-p-items.md new file mode 100644 index 0000000..bdcb7e1 --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p-items.md @@ -0,0 +1,27 @@ +## items Type + +`object` ([Details](commentary-properties-r-items-properties-p-items.md)) + +# items Properties + +| Property | Type | Required | Nullable | Defined by | +| :------- | :------ | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [l](#l) | `array` | Required | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l") | + +## l + +Lines of text (belonging to a given paragraph) + +`l` + +* is required + +* Type: `object[]` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items.md)) + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p/items/properties/l") + +### l Type + +`object[]` ([Details](commentary-properties-r-items-properties-p-items-properties-l-items.md)) diff --git a/docs/commentary-properties-r-items-properties-p.md b/docs/commentary-properties-r-items-properties-p.md new file mode 100644 index 0000000..b5950b8 --- /dev/null +++ b/docs/commentary-properties-r-items-properties-p.md @@ -0,0 +1,3 @@ +## p Type + +`object[]` ([Details](commentary-properties-r-items-properties-p-items.md)) diff --git a/docs/commentary-properties-r-items-properties-pof.md b/docs/commentary-properties-r-items-properties-pof.md new file mode 100644 index 0000000..ea42666 --- /dev/null +++ b/docs/commentary-properties-r-items-properties-pof.md @@ -0,0 +1,3 @@ +## pOf Type + +`string` diff --git a/docs/commentary-properties-r-items.md b/docs/commentary-properties-r-items.md new file mode 100644 index 0000000..621531d --- /dev/null +++ b/docs/commentary-properties-r-items.md @@ -0,0 +1,69 @@ +## items Type + +`object` ([Details](commentary-properties-r-items.md)) + +# items Properties + +| Property | Type | Required | Nullable | Defined by | +| :---------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [c](#c) | `array` | Required | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/c") | +| [p](#p) | `array` | Required | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-p.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p") | +| [pOf](#pof) | `string` | Optional | cannot be null | [Commmentary Page](commentary-properties-r-items-properties-pof.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/pOf") | + +## c + +Coordinates of image-region, following IIIF regions schema (x, y, width, height). + +`c` + +* is required + +* Type: `integer[]` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/c") + +### c Type + +`integer[]` + +### c Constraints + +**minimum number of items**: the minimum number of items for this array is: `4` + +## p + +Text paragraphs. + +`p` + +* is required + +* Type: `object[]` ([Details](commentary-properties-r-items-properties-p-items.md)) + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-p.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/p") + +### p Type + +`object[]` ([Details](commentary-properties-r-items-properties-p-items.md)) + +## pOf + +The canonical ID of the content item to which the page region belongs. + +`pOf` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r-items-properties-pof.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r/items/properties/pOf") + +### pOf Type + +`string` diff --git a/docs/commentary-properties-r.md b/docs/commentary-properties-r.md new file mode 100644 index 0000000..57fa689 --- /dev/null +++ b/docs/commentary-properties-r.md @@ -0,0 +1,3 @@ +## r Type + +`object[]` ([Details](commentary-properties-r-items.md)) diff --git a/docs/commentary.md b/docs/commentary.md new file mode 100644 index 0000000..2d999ea --- /dev/null +++ b/docs/commentary.md @@ -0,0 +1,103 @@ +## Commmentary Page Type + +`object` ([Commmentary Page](commentary.md)) + +# Commmentary Page Properties + +| Property | Type | Required | Nullable | Defined by | +| :------------ | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| [id](#id) | `string` | Required | cannot be null | [Commmentary Page](commentary-properties-id.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/id") | +| [iiif](#iiif) | `string` | Optional | cannot be null | [Commmentary Page](commentary-properties-iiif.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/iiif") | +| [cc](#cc) | `boolean` | Optional | cannot be null | [Commmentary Page](commentary-properties-cc.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/cc") | +| [cdt](#cdt) | `string` | Required | cannot be null | [Commmentary Page](commentary-properties-cdt.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/cdt") | +| [r](#r) | `array` | Required | cannot be null | [Commmentary Page](commentary-properties-r.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r") | + +## id + +Canonical ID of the commentary page. + +`id` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-id.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/id") + +### id Type + +`string` + +## iiif + +URI of the IIIF Manifest of the commentary page image. + +`iiif` + +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-iiif.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/iiif") + +### iiif Type + +`string` + +## cc + +Flag indicating whether the legacy coordinates have been converted into IIIF-compliant ones. + +`cc` + +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-cc.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/cc") + +### cc Type + +`boolean` + +## cdt + +Creation date timestamp (of the JSON file). + +`cdt` + +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-cdt.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/cdt") + +### cdt Type + +`string` + +## r + +Page regions. + +`r` + +* is required + +* Type: `object[]` ([Details](commentary-properties-r-items.md)) + +* cannot be null + +* defined in: [Commmentary Page](commentary-properties-r.md "https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json#/properties/r") + +### r Type + +`object[]` ([Details](commentary-properties-r-items.md)) diff --git a/docs/contentitem-properties-ppreb-items-properties-t-items.md b/docs/contentitem-properties-ppreb-items-properties-t-items.md index 360ad52..f0e8947 100644 --- a/docs/contentitem-properties-ppreb-items-properties-t-items.md +++ b/docs/contentitem-properties-ppreb-items-properties-t-items.md @@ -2,25 +2,27 @@ `object` ([Details](contentitem-properties-ppreb-items-properties-t-items.md)) -# undefined Properties +# items Properties -| Property | Type | Required | Nullable | Defined by | -| :------- | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [c](#c) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c") | -| [s](#s) | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s") | -| [l](#l) | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l") | +| Property | Type | Required | Nullable | Defined by | +| :------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [c](#c) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c") | +| [s](#s) | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s") | +| [l](#l) | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l") | ## c page coordinates of token - `c` -- is optional -- Type: `array` -- cannot be null -- defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c") +* is optional + +* Type: `array` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-c.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/c") ### c Type @@ -36,13 +38,15 @@ page coordinates of token offset start (relative to ft field) - `s` -- is optional -- Type: `number` -- cannot be null -- defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s") +* is optional + +* Type: `number` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/s") ### s Type @@ -52,13 +56,15 @@ offset start (relative to ft field) token length - `l` -- is optional -- Type: `number` -- cannot be null -- defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l") +* is optional + +* Type: `number` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ppreb-items-properties-t-items-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t/items/properties/l") ### l Type diff --git a/docs/contentitem-properties-ppreb-items.md b/docs/contentitem-properties-ppreb-items.md index e51471e..752893a 100644 --- a/docs/contentitem-properties-ppreb-items.md +++ b/docs/contentitem-properties-ppreb-items.md @@ -2,25 +2,27 @@ `object` ([Details](contentitem-properties-ppreb-items.md)) -# undefined Properties +# items Properties -| Property | Type | Required | Nullable | Defined by | -| :-------- | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [id](#id) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id") | -| [n](#n) | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n") | -| [t](#t) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t") | +| Property | Type | Required | Nullable | Defined by | +| :-------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [id](#id) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id") | +| [n](#n) | `number` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n") | +| [t](#t) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t") | ## id canonical ID - `id` -- is optional -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-ppreb-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ppreb-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/id") ### id Type @@ -30,13 +32,15 @@ canonical ID page number - `n` -- is optional -- Type: `number` -- cannot be null -- defined in: [Content Item](contentitem-properties-ppreb-items-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n") +* is optional + +* Type: `number` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ppreb-items-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/n") ### n Type @@ -46,13 +50,15 @@ page number a list of tokens - `t` -- is optional -- Type: `object[]` ([Details](contentitem-properties-ppreb-items-properties-t-items.md)) -- cannot be null -- defined in: [Content Item](contentitem-properties-ppreb-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t") +* is optional + +* Type: `object[]` ([Details](contentitem-properties-ppreb-items-properties-t-items.md)) + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ppreb-items-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb/items/properties/t") ### t Type diff --git a/docs/contentitem.md b/docs/contentitem.md index e268dac..302f3dd 100644 --- a/docs/contentitem.md +++ b/docs/contentitem.md @@ -4,34 +4,36 @@ # Content Item Properties -| Property | Type | Required | Nullable | Defined by | -| :-------------- | --------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [id](#id) | `string` | Required | cannot be null | [Content Item](contentitem-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/id") | -| [s3v](#s3v) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-s3v.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/s3v") | -| [tp](#tp) | `string` | Required | cannot be null | [Content Item](contentitem-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/tp") | -| [cc](#cc) | `boolean` | Optional | cannot be null | [Content Item](contentitem-properties-cc.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/cc") | -| [olr](#olr) | `boolean` | Required | cannot be null | [Content Item](contentitem-properties-olr.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/olr") | -| [pp](#pp) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pp") | -| [d](#d) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-d.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/d") | -| [ts](#ts) | `string` | Required | cannot be null | [Content Item](contentitem-properties-ts.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ts") | -| [lg](#lg) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-lg.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lg") | -| [ft](#ft) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-ft.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ft") | -| [lb](#lb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-lb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lb") | -| [pb](#pb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-pb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pb") | -| [rb](#rb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-rb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/rb") | -| [ppreb](#ppreb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb") | +| Property | Type | Required | Nullable | Defined by | +| :-------------- | :-------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------- | +| [id](#id) | `string` | Required | cannot be null | [Content Item](contentitem-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/id") | +| [s3v](#s3v) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-s3v.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/s3v") | +| [tp](#tp) | `string` | Required | cannot be null | [Content Item](contentitem-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/tp") | +| [cc](#cc) | `boolean` | Optional | cannot be null | [Content Item](contentitem-properties-cc.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/cc") | +| [olr](#olr) | `boolean` | Required | cannot be null | [Content Item](contentitem-properties-olr.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/olr") | +| [pp](#pp) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pp") | +| [d](#d) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-d.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/d") | +| [ts](#ts) | `string` | Required | cannot be null | [Content Item](contentitem-properties-ts.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ts") | +| [lg](#lg) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-lg.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lg") | +| [ft](#ft) | `string` | Optional | cannot be null | [Content Item](contentitem-properties-ft.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ft") | +| [lb](#lb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-lb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lb") | +| [pb](#pb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-pb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pb") | +| [rb](#rb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-rb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/rb") | +| [ppreb](#ppreb) | `array` | Optional | cannot be null | [Content Item](contentitem-properties-ppreb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb") | ## id The unique identifier for a content item (CI) - `id` -- is required -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/id") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/id") ### id Type @@ -41,13 +43,15 @@ The unique identifier for a content item (CI) S3 version ID of the corresponding issue.json file - `s3v` -- is optional -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-s3v.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/s3v") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-s3v.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/s3v") ### s3v Type @@ -57,13 +61,15 @@ S3 version ID of the corresponding issue.json file content item type (e.g. 'ar' for article, 'ad' for advertisement) - `tp` -- is required -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/tp") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/tp") ### tp Type @@ -73,13 +79,15 @@ content item type (e.g. 'ar' for article, 'ad' for advertisement) True if image box coordinates are known to be correct, False otherwise - `cc` -- is optional -- Type: `boolean` -- cannot be null -- defined in: [Content Item](contentitem-properties-cc.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/cc") +* is optional + +* Type: `boolean` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-cc.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/cc") ### cc Type @@ -89,13 +97,15 @@ True if image box coordinates are known to be correct, False otherwise True if optical layout recognition was applied to the issue this content item originates from. - `olr` -- is required -- Type: `boolean` -- cannot be null -- defined in: [Content Item](contentitem-properties-olr.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/olr") +* is required + +* Type: `boolean` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-olr.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/olr") ### olr Type @@ -105,13 +115,15 @@ True if optical layout recognition was applied to the issue this content item or array of page numbers over which the CI spans; it's the physical page number issue-based, as we get it from the OCR. - `pp` -- is optional -- Type: `number[]` -- cannot be null -- defined in: [Content Item](contentitem-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pp") +* is optional + +* Type: `number[]` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pp") ### pp Type @@ -125,13 +137,15 @@ array of page numbers over which the CI spans; it's the physical page number iss issue date (yyyy-mm-dd) - `d` -- is optional -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-d.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/d") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-d.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/d") ### d Type @@ -151,13 +165,15 @@ issue date (yyyy-mm-dd) timestamp of creation of the JSON file (e.g. '2018-09-18T08:00:08Z') - `ts` -- is required -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-ts.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ts") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ts.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ts") ### ts Type @@ -177,13 +193,15 @@ timestamp of creation of the JSON file (e.g. '2018-09-18T08:00:08Z') two letter language code - `lg` -- is optional -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-lg.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lg") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-lg.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lg") ### lg Type @@ -203,13 +221,15 @@ two letter language code the rebuilt fulltext - `ft` -- is optional -- Type: `string` -- cannot be null -- defined in: [Content Item](contentitem-properties-ft.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ft") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ft.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ft") ### ft Type @@ -219,13 +239,15 @@ the rebuilt fulltext text offsets of physical line breaks (relative to 'ft' field) - `lb` -- is optional -- Type: `number[]` -- cannot be null -- defined in: [Content Item](contentitem-properties-lb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lb") +* is optional + +* Type: `number[]` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-lb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/lb") ### lb Type @@ -235,13 +257,15 @@ text offsets of physical line breaks (relative to 'ft' field) text offsets of physical paragraph breaks (relative to 'ft' field) - `pb` -- is optional -- Type: `number[]` -- cannot be null -- defined in: [Content Item](contentitem-properties-pb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pb") +* is optional + +* Type: `number[]` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-pb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/pb") ### pb Type @@ -251,13 +275,15 @@ text offsets of physical paragraph breaks (relative to 'ft' field) text offsets of page regions (relative to 'ft' field) - `rb` -- is optional -- Type: `number[]` -- cannot be null -- defined in: [Content Item](contentitem-properties-rb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/rb") +* is optional + +* Type: `number[]` + +* cannot be null + +* defined in: [Content Item](contentitem-properties-rb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/rb") ### rb Type @@ -267,13 +293,15 @@ text offsets of page regions (relative to 'ft' field) a list of rebuilt pages - `ppreb` -- is optional -- Type: `object[]` ([Details](contentitem-properties-ppreb-items.md)) -- cannot be null -- defined in: [Content Item](contentitem-properties-ppreb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb") +* is optional + +* Type: `object[]` ([Details](contentitem-properties-ppreb-items.md)) + +* cannot be null + +* defined in: [Content Item](contentitem-properties-ppreb.md "https://impresso.github.io/impresso-schemas/json/newspaper/contentitem.schema.json#/properties/ppreb") ### ppreb Type diff --git a/docs/issue-definitions-metadata-properties-tp.md b/docs/issue-definitions-metadata-properties-tp.md index 546c182..e0a6ffe 100644 --- a/docs/issue-definitions-metadata-properties-tp.md +++ b/docs/issue-definitions-metadata-properties-tp.md @@ -7,7 +7,7 @@ **enum**: the value of this property must be equal to one of the following values: | Value | Explanation | -| :--------------- | ----------- | +| :--------------- | :---------- | | `"article"` | | | `"ad"` | | | `"image"` | | diff --git a/docs/issue-definitions-metadata.md b/docs/issue-definitions-metadata.md index 5ceb7b2..e98d945 100644 --- a/docs/issue-definitions-metadata.md +++ b/docs/issue-definitions-metadata.md @@ -2,28 +2,30 @@ `object` ([Details](issue-definitions-metadata.md)) -# undefined Properties +# metadata Properties -| Property | Type | Required | Nullable | Defined by | -| :---------------------- | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [id](#id) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") | -| [l](#l) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") | -| [pp](#pp) | `array` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") | -| [t](#t) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") | -| [tp](#tp) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") | -| [iiif_link](#iiif_link) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") | +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [id](#id) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") | +| [l](#l) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") | +| [pp](#pp) | `array` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") | +| [t](#t) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") | +| [tp](#tp) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") | +| [iiif_link](#iiif_link) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") | ## id Content item ID (e.g. `GDL-1900-01-02-a-i0001`). - `id` -- is required -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") ### id Type @@ -33,13 +35,15 @@ Content item ID (e.g. `GDL-1900-01-02-a-i0001`). Language of the content item. - `l` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") ### l Type @@ -49,13 +53,15 @@ Language of the content item. Page numbers over which the content item spans. - `pp` -- is required -- Type: `integer[]` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") +* is required + +* Type: `integer[]` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") ### pp Type @@ -65,13 +71,15 @@ Page numbers over which the content item spans. Title of the content item. - `t` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") ### t Type @@ -81,13 +89,15 @@ Title of the content item. Type of the content item. - `tp` -- is required -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") ### tp Type @@ -98,7 +108,7 @@ Type of the content item. **enum**: the value of this property must be equal to one of the following values: | Value | Explanation | -| :--------------- | ----------- | +| :--------------- | :---------- | | `"article"` | | | `"ad"` | | | `"image"` | | @@ -111,13 +121,15 @@ Type of the content item. IIIF image link, depending on content item type (if `tp == image`) - `iiif_link` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") ### iiif_link Type diff --git a/docs/issue-properties-ar.md b/docs/issue-properties-ar.md index 31f9b07..31746a2 100644 --- a/docs/issue-properties-ar.md +++ b/docs/issue-properties-ar.md @@ -7,7 +7,7 @@ **enum**: the value of this property must be equal to one of the following values: | Value | Explanation | -| :--------------- | ----------- | +| :--------------- | :---------- | | `"open_public"` | | | `"open_private"` | | | `"closed"` | | diff --git a/docs/issue-properties-i-items.md b/docs/issue-properties-i-items.md index a41547a..64f5719 100644 --- a/docs/issue-properties-i-items.md +++ b/docs/issue-properties-i-items.md @@ -2,23 +2,25 @@ `object` ([Details](issue-properties-i-items.md)) -# undefined Properties +# items Properties -| Property | Type | Required | Nullable | Defined by | -| :------- | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [m](#m) | `object` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i/items/properties/m") | +| Property | Type | Required | Nullable | Defined by | +| :------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [m](#m) | `object` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i/items/properties/m") | ## m Metadata about the content item. - `m` -- is required -- Type: `object` ([Details](issue-definitions-metadata.md)) -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i/items/properties/m") +* is required + +* Type: `object` ([Details](issue-definitions-metadata.md)) + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i/items/properties/m") ### m Type diff --git a/docs/issue-properties-s-items.md b/docs/issue-properties-s-items.md index d180d05..8c5f3a9 100644 --- a/docs/issue-properties-s-items.md +++ b/docs/issue-properties-s-items.md @@ -2,26 +2,28 @@ `object` ([Details](issue-properties-s-items.md)) -# undefined Properties +# items Properties -| Property | Type | Required | Nullable | Defined by | -| :---------- | --------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [rgb](#rgb) | `array` | Optional | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-rgb.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/rgb") | -| [f](#f) | `string` | Optional | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-f.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/f") | -| [fs](#fs) | `number` | Optional | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-fs.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/fs") | -| [id](#id) | `integer` | Required | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/id") | +| Property | Type | Required | Nullable | Defined by | +| :---------- | :-------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [rgb](#rgb) | `array` | Optional | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-rgb.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/rgb") | +| [f](#f) | `string` | Optional | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-f.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/f") | +| [fs](#fs) | `number` | Optional | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-fs.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/fs") | +| [id](#id) | `integer` | Required | cannot be null | [Newspaper Issue](issue-properties-s-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/id") | ## rgb Color of the text (in RGB). - `rgb` -- is optional -- Type: `integer[]` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-s-items-properties-rgb.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/rgb") +* is optional + +* Type: `integer[]` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-s-items-properties-rgb.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/rgb") ### rgb Type @@ -35,13 +37,15 @@ Color of the text (in RGB). Font name - `f` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-s-items-properties-f.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/f") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-s-items-properties-f.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/f") ### f Type @@ -51,13 +55,15 @@ Font name Font size - `fs` -- is optional -- Type: `number` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-s-items-properties-fs.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/fs") +* is optional + +* Type: `number` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-s-items-properties-fs.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/fs") ### fs Type @@ -67,13 +73,15 @@ Font size Local ID of the style - `id` -- is required -- Type: `integer` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-s-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/id") +* is required + +* Type: `integer` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-s-items-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s/items/properties/id") ### id Type diff --git a/docs/issue.md b/docs/issue.md index a56dfc1..6418630 100644 --- a/docs/issue.md +++ b/docs/issue.md @@ -4,27 +4,29 @@ # Newspaper Issue Properties -| Property | Type | Required | Nullable | Defined by | -| :---------- | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------- | -| [id](#id) | `string` | Required | cannot be null | [Newspaper Issue](issue-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/id") | -| [cdt](#cdt) | `string` | Required | cannot be null | [Newspaper Issue](issue-properties-cdt.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/cdt") | -| [i](#i) | `array` | Required | cannot be null | [Newspaper Issue](issue-properties-i.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i") | -| [s](#s) | `array` | Optional | cannot be null | [Newspaper Issue](issue-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s") | -| [pp](#pp) | `array` | Required | cannot be null | [Newspaper Issue](issue-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/pp") | -| [n](#n) | `string` | Optional | cannot be null | [Newspaper Issue](issue-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/n") | -| [ar](#ar) | `string` | Required | cannot be null | [Newspaper Issue](issue-properties-ar.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/ar") | +| Property | Type | Required | Nullable | Defined by | +| :---------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------- | +| [id](#id) | `string` | Required | cannot be null | [Newspaper Issue](issue-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/id") | +| [cdt](#cdt) | `string` | Required | cannot be null | [Newspaper Issue](issue-properties-cdt.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/cdt") | +| [i](#i) | `array` | Required | cannot be null | [Newspaper Issue](issue-properties-i.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i") | +| [s](#s) | `array` | Optional | cannot be null | [Newspaper Issue](issue-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s") | +| [pp](#pp) | `array` | Required | cannot be null | [Newspaper Issue](issue-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/pp") | +| [n](#n) | `string` | Optional | cannot be null | [Newspaper Issue](issue-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/n") | +| [ar](#ar) | `string` | Required | cannot be null | [Newspaper Issue](issue-properties-ar.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/ar") | ## id Canonical ID of the newspaper issue (e.g. GDL-1900-01-02-a) - `id` -- is required -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/id") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/id") ### id Type @@ -34,13 +36,15 @@ Canonical ID of the newspaper issue (e.g. GDL-1900-01-02-a) Creation date timestamp (of the JSON file). - `cdt` -- is required -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-cdt.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/cdt") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-cdt.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/cdt") ### cdt Type @@ -50,13 +54,15 @@ Creation date timestamp (of the JSON file). The content items contained in the newspaper issue. - `i` -- is required -- Type: `object[]` ([Details](issue-properties-i-items.md)) -- cannot be null -- defined in: [Newspaper Issue](issue-properties-i.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i") +* is required + +* Type: `object[]` ([Details](issue-properties-i-items.md)) + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-i.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/i") ### i Type @@ -64,21 +70,23 @@ The content items contained in the newspaper issue. ## s -The text style as defined in the OCR output. +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`). - +* a name (`id`) +* a type-face (`f`) +* a font-size (`fs`) +* a color (`rgb`). `s` -- is optional -- Type: `object[]` ([Details](issue-properties-s-items.md)) -- cannot be null -- defined in: [Newspaper Issue](issue-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s") +* is optional + +* Type: `object[]` ([Details](issue-properties-s-items.md)) + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-s.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/s") ### s Type @@ -88,13 +96,15 @@ Each style consists of: Canonical IDs of pages in the issue, without file extension (e.g. GDL-1900-01-02-a-p0004). - `pp` -- is required -- Type: `string[]` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/pp") +* is required + +* Type: `string[]` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/pp") ### pp Type @@ -104,13 +114,15 @@ Canonical IDs of pages in the issue, without file extension (e.g. GDL-1900-01-02 Notes. - `n` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/n") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-n.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/n") ### n Type @@ -119,17 +131,20 @@ Notes. ## 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 +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` -- is required -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-properties-ar.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/ar") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-properties-ar.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/properties/ar") ### ar Type @@ -140,7 +155,7 @@ Access rights. Three possible situations are defined: **enum**: the value of this property must be equal to one of the following values: | Value | Explanation | -| :--------------- | ----------- | +| :--------------- | :---------- | | `"open_public"` | | | `"open_private"` | | | `"closed"` | | @@ -155,26 +170,28 @@ 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](#id-1) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") | -| [l](#l) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") | -| [pp](#pp-1) | `array` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") | -| [t](#t) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") | -| [tp](#tp) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") | -| [iiif_link](#iiif_link) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") | +| Property | Type | Required | Nullable | Defined by | +| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [id](#id-1) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") | +| [l](#l) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") | +| [pp](#pp-1) | `array` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") | +| [t](#t) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") | +| [tp](#tp) | `string` | Required | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") | +| [iiif_link](#iiif_link) | `string` | Optional | cannot be null | [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") | ### id Content item ID (e.g. `GDL-1900-01-02-a-i0001`). - `id` -- is required -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-id.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/id") #### id Type @@ -184,13 +201,15 @@ Content item ID (e.g. `GDL-1900-01-02-a-i0001`). Language of the content item. - `l` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-l.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/l") #### l Type @@ -200,13 +219,15 @@ Language of the content item. Page numbers over which the content item spans. - `pp` -- is required -- Type: `integer[]` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") +* is required + +* Type: `integer[]` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-pp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/pp") #### pp Type @@ -216,13 +237,15 @@ Page numbers over which the content item spans. Title of the content item. - `t` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-t.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/t") #### t Type @@ -232,13 +255,15 @@ Title of the content item. Type of the content item. - `tp` -- is required -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-tp.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/tp") #### tp Type @@ -249,7 +274,7 @@ Type of the content item. **enum**: the value of this property must be equal to one of the following values: | Value | Explanation | -| :--------------- | ----------- | +| :--------------- | :---------- | | `"article"` | | | `"ad"` | | | `"image"` | | @@ -262,13 +287,15 @@ Type of the content item. IIIF image link, depending on content item type (if `tp == image`) - `iiif_link` -- is optional -- Type: `string` -- cannot be null -- defined in: [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Newspaper Issue](issue-definitions-metadata-properties-iiif_link.md "https://impresso.github.io/impresso-schemas/json/newspaper/issue.schema.json#/definitions/metadata/properties/iiif_link") #### iiif_link Type diff --git a/docs/language_identification-definitions-lidtype.md b/docs/language_identification-definitions-lidtype.md index c6d77bf..6a8c209 100644 --- a/docs/language_identification-definitions-lidtype.md +++ b/docs/language_identification-definitions-lidtype.md @@ -4,22 +4,24 @@ # lidType Properties -| Property | Type | Required | Nullable | Defined by | -| :------------ | -------- | -------- | -------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [lang](#lang) | `string` | Required | cannot be null | [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/lang") | -| [prob](#prob) | `number` | Required | cannot be null | [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-probtype.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/prob") | +| Property | Type | Required | Nullable | Defined by | +| :------------ | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [lang](#lang) | `string` | Required | cannot be null | [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/lang") | +| [prob](#prob) | `number` | Required | cannot be null | [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-probtype.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/prob") | ## lang Two- or three-letter ISO language abbreviation, cf. or - `lang` -- is required -- Type: `string` ([langISO639Type](language_identification-definitions-lidtype-properties-langiso639type.md)) -- cannot be null -- defined in: [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/lang") +* is required + +* Type: `string` ([langISO639Type](language_identification-definitions-lidtype-properties-langiso639type.md)) + +* cannot be null + +* defined in: [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/lang") ### lang Type @@ -39,13 +41,15 @@ Two- or three-letter ISO language abbreviation, cf. or - `lang` -- is required -- Type: `string` ([langISO639Type](language_identification-properties-votes-items-0-properties-langiso639type.md)) -- cannot be null -- defined in: [Impresso Language Identification Information](language_identification-properties-votes-items-0-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/votes/items/0/properties/lang") +* is required + +* Type: `string` ([langISO639Type](language_identification-properties-votes-items-0-properties-langiso639type.md)) + +* cannot be null + +* defined in: [Impresso Language Identification Information](language_identification-properties-votes-items-0-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/votes/items/0/properties/lang") ### lang Type @@ -39,13 +41,15 @@ Two- or three-letter ISO language abbreviation, cf. - `id` -- is required -- Type: `string` -- cannot be null -- defined in: [Impresso Language Identification Information](language_identification-properties-id.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/id") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Impresso Language Identification Information](language_identification-properties-id.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/id") ### id Type @@ -41,13 +43,15 @@ The unique identifier for a content item, cf. - `orig_lg` -- is required -- Type: `string` ([Details](language_identification-properties-orig_lg.md)) -- can be null -- defined in: [Impresso Language Identification Information](language_identification-properties-orig_lg.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/orig_lg") +* is required + +* Type: `string` ([Details](language_identification-properties-orig_lg.md)) + +* can be null + +* defined in: [Impresso Language Identification Information](language_identification-properties-orig_lg.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/orig_lg") ### orig_lg Type @@ -55,20 +59,23 @@ Original language of the content item as provided by the metadata, cf. - `lg` -- is required -- Type: `string` ([Details](language_identification-properties-lg.md)) -- can be null -- defined in: [Impresso Language Identification Information](language_identification-properties-lg.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/lg") +* is required + +* Type: `string` ([Details](language_identification-properties-lg.md)) + +* can be null + +* defined in: [Impresso Language Identification Information](language_identification-properties-lg.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/lg") ### lg Type @@ -76,20 +83,23 @@ Computed language of the content item, cf. - `tp` -- is required -- Type: `string` -- cannot be null -- defined in: [Impresso Language Identification Information](language_identification-properties-tp.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/tp") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Impresso Language Identification Information](language_identification-properties-tp.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/properties/tp") ### tp Type @@ -127,13 +139,15 @@ Type of the content item, cf. or - `lang` -- is required -- Type: `string` ([langISO639Type](language_identification-definitions-lidtype-properties-langiso639type.md)) -- cannot be null -- defined in: [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/lang") +* is required + +* Type: `string` ([langISO639Type](language_identification-definitions-lidtype-properties-langiso639type.md)) + +* cannot be null + +* defined in: [Impresso Language Identification Information](language_identification-definitions-lidtype-properties-langiso639type.md "https://impresso.github.io/impresso-schemas/json/language_identification/language_identification.schema.json#/definitions/lidType/properties/lang") #### lang Type @@ -326,13 +358,15 @@ Two- or three-letter ISO language abbreviation, cf. - `lang` -- is required -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_assignment-properties-lang.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/lang") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_assignment-properties-lang.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/lang") ### lang Type @@ -48,13 +52,15 @@ Reference to canonical content item id, typically an article internal symbolic name of the model, starts with tm - `topic_model` -- is required -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_assignment-properties-topic_model.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/topic_model") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_assignment-properties-topic_model.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/topic_model") ### topic_model Type @@ -64,13 +70,15 @@ internal symbolic name of the model, starts with tm The number of topics in the topic model - `topic_count` -- is required -- Type: `integer` -- cannot be null -- defined in: [Untitled schema](topic_assignment-properties-topic_count.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/topic_count") +* is required + +* Type: `integer` + +* cannot be null + +* defined in: [Untitled schema](topic_assignment-properties-topic_count.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/topic_count") ### topic_count Type @@ -80,13 +88,15 @@ The number of topics in the topic model Sparse representation of topics - `topics` -- is required -- Type: `object[]` ([Details](topic_assignment-properties-topics-items.md)) -- cannot be null -- defined in: [Untitled schema](topic_assignment-properties-topics.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/topics") +* is required + +* Type: `object[]` ([Details](topic_assignment-properties-topics-items.md)) + +* cannot be null + +* defined in: [Untitled schema](topic_assignment-properties-topics.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/properties/topics") ### topics Type @@ -102,22 +112,24 @@ Reference this group by using {"$ref":"https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic"} ``` -| Property | Type | Required | Nullable | Defined by | -| :------- | -------- | -------- | -------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [p](#p) | `number` | Required | cannot be null | [Untitled schema](topic_assignment-definitions-topic-properties-p.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/p") | -| [t](#t) | Multiple | Required | cannot be null | [Untitled schema](topic_assignment-definitions-topic-properties-t.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/t") | +| Property | Type | Required | Nullable | Defined by | +| :------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| [p](#p) | `number` | Required | cannot be null | [Untitled schema](topic_assignment-definitions-topic-properties-p.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/p") | +| [t](#t) | Multiple | Required | cannot be null | [Untitled schema](topic_assignment-definitions-topic-properties-t.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/t") | ### p Probability or proportion of topic - `p` -- is required -- Type: `number` -- cannot be null -- defined in: [Untitled schema](topic_assignment-definitions-topic-properties-p.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/p") +* is required + +* Type: `number` + +* cannot be null + +* defined in: [Untitled schema](topic_assignment-definitions-topic-properties-p.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/p") #### p Type @@ -131,15 +143,17 @@ Probability or proportion of topic ### t -Topic id - +Topic id `t` -- is required -- Type: any of the folllowing: `integer` or `string` ([Details](topic_assignment-definitions-topic-properties-t.md)) -- cannot be null -- defined in: [Untitled schema](topic_assignment-definitions-topic-properties-t.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/t") +* is required + +* Type: any of the folllowing: `integer` or `string` ([Details](topic_assignment-definitions-topic-properties-t.md)) + +* cannot be null + +* defined in: [Untitled schema](topic_assignment-definitions-topic-properties-t.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_assignment.schema.json#/definitions/topic/properties/t") #### t Type diff --git a/docs/topic_description-definitions-word_prob.md b/docs/topic_description-definitions-word_prob.md index b7a171a..8f9b567 100644 --- a/docs/topic_description-definitions-word_prob.md +++ b/docs/topic_description-definitions-word_prob.md @@ -2,24 +2,26 @@ `object` ([Details](topic_description-definitions-word_prob.md)) -# undefined Properties +# word_prob Properties -| Property | Type | Required | Nullable | Defined by | -| :------------ | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [word](#word) | `string` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") | -| [prob](#prob) | `number` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") | +| Property | Type | Required | Nullable | Defined by | +| :------------ | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [word](#word) | `string` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") | +| [prob](#prob) | `number` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") | ## word - `word` -- is required -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") ### word Type @@ -29,13 +31,15 @@ - `prob` -- is required -- Type: `number` -- cannot be null -- defined in: [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") +* is required + +* Type: `number` + +* cannot be null + +* defined in: [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") ### prob Type diff --git a/docs/topic_description.md b/docs/topic_description.md index 94f86a6..eab28da 100644 --- a/docs/topic_description.md +++ b/docs/topic_description.md @@ -2,28 +2,30 @@ `object` ([Details](topic_description.md)) -# undefined Properties +# Untitled object in undefined Properties -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------------- | --------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [lg](#lg) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-lg.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/lg") | -| [topic](#topic) | `integer` | Required | cannot be null | [Untitled schema](topic_description-properties-topic.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic") | -| [topic_model](#topic_model) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-topic_model.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_model") | -| [topic_description](#topic_description) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-topic_description.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_description") | -| [meta](#meta) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-meta.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/meta") | -| [word_probs](#word_probs) | `array` | Required | cannot be null | [Untitled schema](topic_description-properties-word_probs.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/word_probs") | +| Property | Type | Required | Nullable | Defined by | +| :-------------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [lg](#lg) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-lg.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/lg") | +| [topic](#topic) | `integer` | Required | cannot be null | [Untitled schema](topic_description-properties-topic.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic") | +| [topic_model](#topic_model) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-topic_model.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_model") | +| [topic_description](#topic_description) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-topic_description.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_description") | +| [meta](#meta) | `string` | Optional | cannot be null | [Untitled schema](topic_description-properties-meta.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/meta") | +| [word_probs](#word_probs) | `array` | Required | cannot be null | [Untitled schema](topic_description-properties-word_probs.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/word_probs") | ## lg - `lg` -- is optional -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_description-properties-lg.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/lg") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_description-properties-lg.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/lg") ### lg Type @@ -33,13 +35,15 @@ - `topic` -- is required -- Type: `integer` -- cannot be null -- defined in: [Untitled schema](topic_description-properties-topic.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic") +* is required + +* Type: `integer` + +* cannot be null + +* defined in: [Untitled schema](topic_description-properties-topic.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic") ### topic Type @@ -49,13 +53,15 @@ - `topic_model` -- is optional -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_description-properties-topic_model.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_model") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_description-properties-topic_model.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_model") ### topic_model Type @@ -65,13 +71,15 @@ - `topic_description` -- is optional -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_description-properties-topic_description.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_description") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_description-properties-topic_description.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/topic_description") ### topic_description Type @@ -81,13 +89,15 @@ - `meta` -- is optional -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_description-properties-meta.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/meta") +* is optional + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_description-properties-meta.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/meta") ### meta Type @@ -97,13 +107,15 @@ - `word_probs` -- is required -- Type: `object[]` ([Details](topic_description-properties-word_probs-items.md)) -- cannot be null -- defined in: [Untitled schema](topic_description-properties-word_probs.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/word_probs") +* is required + +* Type: `object[]` ([Details](topic_description-properties-word_probs-items.md)) + +* cannot be null + +* defined in: [Untitled schema](topic_description-properties-word_probs.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/properties/word_probs") ### word_probs Type @@ -119,22 +131,24 @@ Reference this group by using {"$ref":"https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob"} ``` -| Property | Type | Required | Nullable | Defined by | -| :------------ | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [word](#word) | `string` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") | -| [prob](#prob) | `number` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") | +| Property | Type | Required | Nullable | Defined by | +| :------------ | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [word](#word) | `string` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") | +| [prob](#prob) | `number` | Required | cannot be null | [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") | ### word - `word` -- is required -- Type: `string` -- cannot be null -- defined in: [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") +* is required + +* Type: `string` + +* cannot be null + +* defined in: [Untitled schema](topic_description-definitions-word_prob-properties-word.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/word") #### word Type @@ -144,13 +158,15 @@ Reference this group by using - `prob` -- is required -- Type: `number` -- cannot be null -- defined in: [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") +* is required + +* Type: `number` + +* cannot be null + +* defined in: [Untitled schema](topic_description-definitions-word_prob-properties-prob.md "https://impresso.github.io/impresso-schemas/json/topic_model/topic_description.schema.json#/definitions/word_prob/properties/prob") #### prob Type diff --git a/json/commentary/commentary.schema.json b/json/commentary/commentary.schema.json new file mode 100644 index 0000000..06edb02 --- /dev/null +++ b/json/commentary/commentary.schema.json @@ -0,0 +1,115 @@ +{ + "$schema": "http://json-schema.org/draft-06/schema#", + "$id":"https://impresso.github.io/impresso-schemas/json/commentary/page.schema.json", + "title": "Commmentary Page", + "description": "Physical representation of a commentary page as recognized by a given OCR engine.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Canonical ID of the commentary page." + }, + "iiif":{ + "type": "string", + "description": "URI of the IIIF Manifest of the commentary page image." + }, + "cc":{ + "type": "boolean", + "description": "Flag indicating whether the legacy coordinates have been converted into IIIF-compliant ones." + }, + "cdt":{ + "type": "string", + "description": "Creation date timestamp (of the JSON file)." + }, + "r": { + "type": "array", + "description": "Page regions.", + "items": { + "type": "object", + "description":"Page region.", + "properties": { + "c": { + "type": "array", + "description": "Coordinates of image-region, following IIIF regions schema (x, y, width, height).", + "minItems":4, + "items": { + "type": "integer" + } + }, + "p": { + "type": "array", + "description": "Text paragraphs.", + "items": { + "type": "object", + "properties": { + "l": { + "type": "array", + "description": "Lines of text (belonging to a given paragraph)", + "items": { + "type": "object", + "properties": { + "c": { + "type": "array", + "description": "Coordinates of image-region.", + "minItems":4, + "items": { + "type": "integer" + } + }, + "t": { + "type": "array", + "description": "Tokens (as detected by the OCR engine).", + "items": { + "type": "object", + "properties": { + "c": { + "type": "array", + "description": "Coordinates of image-region.", + "minItems":4, + "items": { + "type": "integer" + } + }, + "tx": { + "type": "string", + "description": "Token surface form." + }, + "s": { + "type": "integer", + "description": "A style ID as defined in issue.schema.json/s" + }, + "gn": { + "type": "boolean", + "description": "Indicates whether the token is/should be followed by a whitespace. `gn==true` means no white space is required (`gn` stands for 'glue next'). When not specified it is assumed to be `false`." + }, + "hy":{ + "type": "boolean", + "description": "Indicates whether the token constitutes the former part of a hyphenated word (including hyphen). When not specified it is assumed to be `false`." + }, + "nf":{ + "type": "string", + "description": "It is specified on the latter part(s) of a hyphenated word, and contains its normalized (dehyphenated) form." + } + }, + "required": ["c", "tx"] + } + } + }, + "required": ["c", "t"] + } + } + }, + "required": ["l"] + } + }, + "pOf": { + "type": "string", + "description": "The canonical ID of the content item to which the page region belongs." + } + }, + "required": ["c", "p"] + } + } + }, + "required": ["id", "cdt", "r"] +}