Skip to content

Commit

Permalink
Merge branch 'master' of github.com:monotasker/specifications into Ia…
Browse files Browse the repository at this point in the history 
…nScott-typoFixes
  • Loading branch information
@monotasker
monotasker committed Aug 8, 2024
2 parents 04f6e28 + c980dbc commit e738cc8
Showing 1 changed file with 14 additions and 17 deletions.
31 changes: 14 additions & 17 deletions versions/unstable/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ Specifications

## Changelogs

- 2004-08-08
- Made `citeType` required for `CiteStructure` objects.
- Removed `maxCiteDepth` everywhere, including in the example.
- 2024-08-06
- Removed `maxCiteDepth` from Collection objects at the Collection endpoint now that we have a `CitationTree` object at the Resource level.
- Harmonized the properties for `Resource` objects between the Collection and Navigation endpoints. This involves adding required `document` and `navigation` properties, as well as allowing additional optional properties. Also removed the `document` and `navigation` properties from the `Navigation` object since these URI templates are now part of the `Resource` object.
- Added `view` properties for paginated responses to the Collection and Navigation endpoints. Added a `Pagination` object type to provide the pagination links.

- 2024-05-24
- Removed `totalItems` from the Collection Endpoints (See https://github.com/distributed-text-services/specifications/issues/248, problem pointed out by @kbrueckmann)
- `passage` property (URI template) moved to `document` for consistency between Collection and Navigation endpoint (See https://github.com/distributed-text-services/specifications/issues/249, problem pointed out by @philippepons)
Expand Down Expand Up @@ -246,7 +248,7 @@ The values of this object's properties **MAY** be:

- a literal that cannot be localized (such as `int` or `float`),
- a URI,
- an array of objects with `@value` and `@lang` properties,
- an array of objects with `value` and `lang` properties (`lang` values **MUST** follow [BCP 47](https://www.rfc-editor.org/info/bcp47)),
- an array of URIs.

#### `Pagination` Structure
Expand Down Expand Up @@ -456,14 +458,13 @@ Although, this is optional, the expansion of `@type:Resource`'s metadata is advi
"contributor": ["Aemilius Baehrens"],
"language": ["la", "en"]
},
"collection": "/api/dts/collection/?id=urn:cts:latinLit:phi1103.phi001.lascivaroma-lat1(&nav}",
"collection": "/api/dts/collection/?id=urn:cts:latinLit:phi1103.phi001.lascivaroma-lat1{&nav}",
"document": "/api/dts/document?resource=urn:cts:latinLit:phi1103.phi001.lascivaroma-lat1{&ref,start,end,tree,mediaType}",
"navigation": "/api/dts/navigation?resource=urn:cts:latinLit:phi1103.phi001.lascivaroma-lat1{&ref,start,end,tree}",
"download": "https://raw.githubusercontent.com/lascivaroma/priapeia/master/data/phi1103/phi001/phi1103.phi001.lascivaroma-lat1.xml",
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth" : 2,
"citeStructure" : [
{
"citeType": "poem",
Expand Down Expand Up @@ -526,7 +527,6 @@ This example is a child Resource, i.e. document composed of passages of readable
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth" : 2,
"citeStructure" : [
{
"citeType": "poem",
Expand Down Expand Up @@ -565,7 +565,6 @@ This example is a child Resource, i.e. document composed of passages of readable
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth" : 2,
"citeStructure" : [
{
"citeType": "front_matter"
Expand Down Expand Up @@ -660,7 +659,6 @@ The example comes from Papyri.info and concerns a document that has been publish
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth" : 2,
"citeStructure" : [
{
"citeType": "column",
Expand Down Expand Up @@ -784,15 +782,14 @@ Values in the `mediaTypes` array must correspond to content types that the imple
| `identifier` | string | N | The string identifier of the `CitationTree`. |
| `@type` | string | Y | The object's RDF class which must be "CitationTree". |
| `citeStructure` | array | N | An array of `CiteStructure` objects. |
| `maxCiteDepth` | int | Y | An integer defining the maximum depth of the Resource's citation tree. |
| `description` | string | N | A human readable description of the citation tree. |

#### CiteStructure

| Name | Type | Required | Description |
| ---- | ------ | --------- | -----------------------------|
| `citeStructure` | array | N | An array of `CiteStructure` objects. |
| `citeType` | string | N | A type of textual unit that appears at a given level in the citation tree. (E.g., "chapter", "verse") |
| `citeType` | string | y | A type of textual unit that appears at a given level in the citation tree. (E.g., "chapter", "verse") |

#### CitableUnit

Expand Down Expand Up @@ -939,6 +936,7 @@ The client wants to retrieve an array of `CitableUnit`s that are part of the `Re
{
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@type": "Navigation",
"@id": "https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula&down=1",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
Expand All @@ -949,7 +947,6 @@ The client wants to retrieve an array of `CitableUnit`s that are part of the `Re
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth": 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down Expand Up @@ -1039,6 +1036,7 @@ The client wants to retrieve an array of all `CitableUnit`s in the `Resource` id
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@id":"https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula&down=2",
"@type": "Navigation",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
"@type": "Resource",
Expand All @@ -1048,7 +1046,6 @@ The client wants to retrieve an array of all `CitableUnit`s in the `Resource` id
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth" : 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down Expand Up @@ -1191,6 +1188,7 @@ The client wants to retrieve an array of all `CitableUnit`s in the `Resource` id
{
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@type": "Navigation",
"@id": "https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula&ref=C1&down=-1",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
Expand All @@ -1201,7 +1199,6 @@ The client wants to retrieve an array of all `CitableUnit`s in the `Resource` id
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth": 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down Expand Up @@ -1328,6 +1325,7 @@ The client wants to retrieve the citation subtree below `CitableUnit` "C1" but i
{
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@type": "Navigation",
"@id": "https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula?ref=C1&down=2",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
Expand All @@ -1338,7 +1336,6 @@ The client wants to retrieve the citation subtree below `CitableUnit` "C1" but i
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth": 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down Expand Up @@ -1463,6 +1460,7 @@ The client wants to retrieve `CitableUnit` "C1.E1" of the `Resource` "https://en
{
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@type": "Navigation",
"@id": "https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula&ref=C1.E1&down=1",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
Expand All @@ -1473,7 +1471,6 @@ The client wants to retrieve `CitableUnit` "C1.E1" of the `Resource` "https://en
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth": 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down Expand Up @@ -1564,6 +1561,7 @@ The client wants to retrieve an array of `CitableUnit`s in a specified range, in
{
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@type": "Navigation",
"@id": "https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula&down=1&start=C1&end=C3",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
Expand All @@ -1574,7 +1572,6 @@ The client wants to retrieve an array of `CitableUnit`s in a specified range, in
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth": 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down Expand Up @@ -1747,6 +1744,7 @@ Alternately, the same typology of `CitableUnits` and `CiteStructure` may be retr
{
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@type": "Navigation",
"@id": "https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula&ref=C1",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
Expand All @@ -1757,7 +1755,6 @@ Alternately, the same typology of `CitableUnits` and `CiteStructure` may be retr
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth": 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down Expand Up @@ -1832,6 +1829,7 @@ It is up to the implementer to decide what optional metadata to provide using th
{
"@context": "https://distributed-text-services.github.io/specifications/context/1-alpha1.json",
"dtsVersion": "1-alpha",
"@type": "Navigation",
"@id": "https://example.org/api/dts/navigation/?resource=https://en.wikisource.org/wiki/Dracula&ref=C2.E2",
"resource": {
"@id": "https://en.wikisource.org/wiki/Dracula",
Expand All @@ -1842,7 +1840,6 @@ It is up to the implementer to decide what optional metadata to provide using th
"citationTrees": [
{
"@type": "CitationTree",
"maxCiteDepth" : 3,
"citeStructure": [
{
"@type": "CiteStructure",
Expand Down

0 comments on commit e738cc8

Please sign in to comment.