started extension of schemas for classical commentary documents (as p…

…er issue #24)

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

docs/commentary-properties-cc.md

@@ -0,0 +1,3 @@
+## cc Type
+
+`boolean`

docs/commentary-properties-cdt.md

@@ -0,0 +1,3 @@
+## cdt Type
+
+`string`

docs/commentary-properties-id.md

@@ -0,0 +1,3 @@
+## id Type
+
+`string`

docs/commentary-properties-iiif.md

@@ -0,0 +1,3 @@
+## iiif Type
+
+`string`

docs/commentary-properties-r-items-properties-c-items.md

@@ -0,0 +1,3 @@
+## items Type
+
+`integer`

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`

docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-c-items.md

@@ -0,0 +1,3 @@
+## items Type
+
+`integer`

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`

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`

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`

docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-gn.md

@@ -0,0 +1,3 @@
+## gn Type
+
+`boolean`

docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-hy.md

@@ -0,0 +1,3 @@
+## hy Type
+
+`boolean`

docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-nf.md

@@ -0,0 +1,3 @@
+## nf Type
+
+`string`

docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-s.md

@@ -0,0 +1,3 @@
+## s Type
+
+`integer`

docs/commentary-properties-r-items-properties-p-items-properties-l-items-properties-t-items-properties-tx.md

@@ -0,0 +1,3 @@
+## tx Type
+
+`string`

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`

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))

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))

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))

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))

docs/commentary-properties-r-items-properties-p.md

@@ -0,0 +1,3 @@
+## p Type
+
+`object[]` ([Details](commentary-properties-r-items-properties-p-items.md))

docs/commentary-properties-r-items-properties-pof.md

@@ -0,0 +1,3 @@
+## pOf Type
+
+`string`

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`

docs/commentary-properties-r.md

@@ -0,0 +1,3 @@
+## r Type
+
+`object[]` ([Details](commentary-properties-r-items.md))