Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revert new date object format #400

Merged
merged 6 commits into from
Oct 16, 2021
Merged

Revert new date object format #400

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7b68030
revert new date object format
cormacrelf Oct 15, 2021
3de70eb
re-add title/description to literal property
cormacrelf Oct 16, 2021
18bce00
make date-variable an anyOf because literal is valid against two
cormacrelf Oct 16, 2021
7c5e471
turn date literal into a oneOf
cormacrelf Oct 16, 2021
48c2bab
add example for date-variable
cormacrelf Oct 16, 2021
cf0ef70
fix typo
bdarcus Oct 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 55 additions & 91 deletions schemas/input/csl-data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,125 +84,89 @@
"type": "string",
"pattern": "^[0-9-%~X?./]{4,}$"
},
"date-object": {
"title": "Date Object",
"description": "An EDTF date represented as an object. Seasons can be represented using the 21-24 month values of EDTF, decades and centuries using the X notation, and the qualifiers with the included boolean properties",
"date-object-v2": {
"title": "Date Object (v2)",
"description": "Supports literal only, for now",
"oneOf": [
{
"type": "object",
"title": "Literal Date",
"description": "A date that should be passed through to the processor as is; for dates that cannot be represented in EDTF.",
"examples": [{ "literal": "Han Dynasty" }],
"properties": {
"literal": {
"type": "string"
}
},
"required": ["literal"]
}
]
},
"date-object-v1": {
"title": "Date Object (v1)",
"description": "Legacy date format from CSL JSON 1.0.",
"deprecated": true,
"examples": [
{
"id": "one",
"type": "book",
"title": "The Title",
"issued": {
"year": 2000,
"month": 3,
"day": 10
},
"approximate": "true"
"date-parts": [[2000, 3, 10]],
"circa": "true"
}
}
],
"type": "object",
"properties": {
"year": {
"title": "year",
"description": "A year; can be negative.",
"examples": ["2012", "-32"],
"type": "integer"
},
"month": {
"title": "month",
"description": "A month; can also represent seasons using the EDTF 21-24 values.",
"examples": ["2", "22"],
"type": "integer"
},
"day": {
"title": "day",
"type": "integer"
"date-parts": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": ["string", "number"]
},
"minItems": 1,
"maxItems": 3
},
"minItems": 1,
"maxItems": 2
},
"literal": {
"title": "Literal date",
"description": "A date that should be passed through to the processor as is; for dates that cannot be represented in EDTF.",
"examples": ["Han Dynasty"],
"type": "string"
"season": {
"type": ["string", "number"]
},
"approximate": {
"title": "Approximate",
"description": "Indicates an approximate or circa date, which may be presented as `circa May 23, 1972`.",
"type": "boolean"
"circa": {
"type": ["string", "number", "boolean"]
},
"uncertain": {
"title": "Uncertain",
"description": "Indicates uncertainty about a date representation, which may be presented as `May 23, 1972?`",
"type": "boolean"
"literal": {
"type": "string"
},
"undefined": {
"title": "Undefined",
"description": "Use to represent an open end of a range.",
"type": "boolean"
"raw": {
"type": "string"
}
},
"oneOf": [
{
"required": ["year"]
},
{
"required": ["undefined"]
}
]
"additionalProperties": false
},
"date-range": {
"title": "Date Range",
"description": "An EDTF range is an object with begin and end properties. An open end or beginning of a range can be represented with an undefined property on the data object.",
"type": "array",
"date-variable": {
"title": "Date content model",
"description": "The CSL input model supports three date representations: an EDTF string (preferred), a literal format using `{ \"literal\": \"string\" }`, and a legacy format (deprecated).",
"examples": [
{
"id": "range-1",
"type": "book",
"title": "The Title",
"issued": {
"begin": { "year": 2000 },
"end": { "year": 2001 }
}
},
{
"id": "range-2",
"id": "one",
"type": "book",
"title": "The Title",
"issued": [
{ "begin": { "year": 2000 } },
{ "end": { "undefined": true } }
]
"issued": "2019-07-16?"
}
],
"properties": {
"begin": {
"$ref": "#/definitions/date-object"
},
"end": {
"$ref": "#/definitions/date-object"
}
}
},
"date-structured": {
"title": "Structured Date",
"description": "Can either be an object, or a two-item array.",
"oneOf": [
"anyOf": [
{
"$ref": "#/definitions/date-object"
"$ref": "#/definitions/edtf-string"
},
{
"$ref": "#/definitions/date-range"
}
]
},
"date-variable": {
"title": "Date content model.",
"description": "The CSL input model supports two different date representations: an EDTF string (preferred), and a more structured alternative.",
"oneOf": [
{
"$ref": "#/definitions/edtf-string"
"$ref": "#/definitions/date-object-v2"
},
{
"$ref": "#/definitions/date-structured"
"$ref": "#/definitions/date-object-v1"
}
]
},
Expand Down