1 | {
|
2 | "title": "CreativeWork",
|
3 | "@id": "schema:CreativeWork",
|
4 | "extends": "Thing",
|
5 | "role": "base",
|
6 | "status": "stable",
|
7 | "category": "metadata",
|
8 | "description": "A creative work, including books, movies, photographs, software programs, etc.\n",
|
9 | "properties": {
|
10 | "type": {
|
11 | "@id": "schema:type",
|
12 | "description": "The name of the type.",
|
13 | "type": "string",
|
14 | "enum": [
|
15 | "CreativeWork",
|
16 | "Article",
|
17 | "AudioObject",
|
18 | "Collection",
|
19 | "Comment",
|
20 | "Datatable",
|
21 | "Figure",
|
22 | "ImageObject",
|
23 | "MediaObject",
|
24 | "Periodical",
|
25 | "PublicationIssue",
|
26 | "PublicationVolume",
|
27 | "Review",
|
28 | "SoftwareApplication",
|
29 | "SoftwareSourceCode",
|
30 | "Table",
|
31 | "VideoObject"
|
32 | ],
|
33 | "default": "CreativeWork",
|
34 | "from": "Entity"
|
35 | },
|
36 | "id": {
|
37 | "@id": "schema:id",
|
38 | "description": "The identifier for this item.",
|
39 | "type": "string",
|
40 | "from": "Entity"
|
41 | },
|
42 | "meta": {
|
43 | "@id": "stencila:meta",
|
44 | "description": "Metadata associated with this item.",
|
45 | "type": "object",
|
46 | "from": "Entity"
|
47 | },
|
48 | "alternateNames": {
|
49 | "@id": "schema:alternateName",
|
50 | "description": "Alternate names (aliases) for the item.",
|
51 | "type": "array",
|
52 | "items": {
|
53 | "type": "string"
|
54 | },
|
55 | "from": "Thing",
|
56 | "isArray": true,
|
57 | "isPlural": true,
|
58 | "aliases": [
|
59 | "alternateName"
|
60 | ]
|
61 | },
|
62 | "description": {
|
63 | "@id": "schema:description",
|
64 | "description": "A description of the item.",
|
65 | "$comment": "Allows for the description to be an array of nodes (e.g. an array of inline content,\nor a couple of paragraphs), or a string. The `minItems` restriction avoids a string\nbeing coerced into an array with a single string item.\n",
|
66 | "anyOf": [
|
67 | {
|
68 | "type": "array",
|
69 | "items": {
|
70 | "$ref": "BlockContent.schema.json"
|
71 | }
|
72 | },
|
73 | {
|
74 | "type": "array",
|
75 | "items": {
|
76 | "$ref": "InlineContent.schema.json"
|
77 | },
|
78 | "minItems": 2
|
79 | },
|
80 | {
|
81 | "type": "string"
|
82 | }
|
83 | ],
|
84 | "from": "Thing"
|
85 | },
|
86 | "identifiers": {
|
87 | "@id": "schema:identifier",
|
88 | "description": "Any kind of identifier for any kind of Thing.",
|
89 | "$comment": "Some identifiers have specific properties e.g the `issn` property for\nthe `Periodical` type. These should be used in preference to this\nproperty which is intended for identifiers that do not yet have a\nspecific property. Identifiers can be represented as strings, but\nusing a `PropertyValue` will usually be better because it allows\nfor `propertyID` (i.e. the type of identifier).\n",
|
90 | "type": "array",
|
91 | "items": {
|
92 | "anyOf": [
|
93 | {
|
94 | "$ref": "PropertyValue.schema.json"
|
95 | },
|
96 | {
|
97 | "type": "string"
|
98 | }
|
99 | ]
|
100 | },
|
101 | "from": "Thing",
|
102 | "isArray": true,
|
103 | "isPlural": true,
|
104 | "aliases": [
|
105 | "identifier"
|
106 | ]
|
107 | },
|
108 | "images": {
|
109 | "@id": "schema:image",
|
110 | "description": "Images of the item.",
|
111 | "type": "array",
|
112 | "items": {
|
113 | "anyOf": [
|
114 | {
|
115 | "$ref": "ImageObject.schema.json"
|
116 | },
|
117 | {
|
118 | "type": "string",
|
119 | "format": "uri"
|
120 | }
|
121 | ]
|
122 | },
|
123 | "from": "Thing",
|
124 | "isArray": true,
|
125 | "isPlural": true,
|
126 | "aliases": [
|
127 | "image"
|
128 | ]
|
129 | },
|
130 | "name": {
|
131 | "@id": "schema:name",
|
132 | "description": "The name of the item.",
|
133 | "type": "string",
|
134 | "from": "Thing"
|
135 | },
|
136 | "url": {
|
137 | "@id": "schema:url",
|
138 | "description": "The URL of the item.",
|
139 | "type": "string",
|
140 | "format": "uri",
|
141 | "from": "Thing"
|
142 | },
|
143 | "about": {
|
144 | "@id": "schema:about",
|
145 | "description": "The subject matter of the content.",
|
146 | "$comment": "Consistent with https://schema.org/about, this property allows for\nlinking to one of more `Thing` nodes. This could for example include\na `Person` (e.g for a bibliography) or a `DefinedTerm` (e.g. for\nsubject areas the creative work relates to).\n",
|
147 | "type": "array",
|
148 | "items": {
|
149 | "$ref": "Thing.schema.json"
|
150 | },
|
151 | "from": "CreativeWork",
|
152 | "isArray": true
|
153 | },
|
154 | "authors": {
|
155 | "@id": "schema:author",
|
156 | "description": "The authors of this creative work.",
|
157 | "type": "array",
|
158 | "allOf": [
|
159 | {
|
160 | "parser": "csi"
|
161 | },
|
162 | {
|
163 | "type": "array",
|
164 | "items": {
|
165 | "anyOf": [
|
166 | {
|
167 | "$ref": "Person.schema.json"
|
168 | },
|
169 | {
|
170 | "$ref": "Organization.schema.json"
|
171 | }
|
172 | ]
|
173 | }
|
174 | }
|
175 | ],
|
176 | "from": "CreativeWork",
|
177 | "isArray": true,
|
178 | "isPlural": true,
|
179 | "aliases": [
|
180 | "author"
|
181 | ]
|
182 | },
|
183 | "comments": {
|
184 | "@id": "schema:comment",
|
185 | "description": "Comments about this creative work.",
|
186 | "type": "array",
|
187 | "items": {
|
188 | "$ref": "Comment.schema.json"
|
189 | },
|
190 | "from": "CreativeWork",
|
191 | "isArray": true,
|
192 | "isPlural": true,
|
193 | "aliases": [
|
194 | "comment"
|
195 | ]
|
196 | },
|
197 | "content": {
|
198 | "@id": "stencila:content",
|
199 | "description": "The structured content of this creative work c.f. property `text`.",
|
200 | "type": "array",
|
201 | "items": {
|
202 | "$ref": "Node.schema.json"
|
203 | },
|
204 | "from": "CreativeWork",
|
205 | "isArray": true
|
206 | },
|
207 | "dateCreated": {
|
208 | "@id": "schema:dateCreated",
|
209 | "description": "Date/time of creation.",
|
210 | "allOf": [
|
211 | {
|
212 | "$ref": "#/definitions/dateProperty"
|
213 | }
|
214 | ],
|
215 | "from": "CreativeWork"
|
216 | },
|
217 | "dateReceived": {
|
218 | "@id": "schema:dateReceived",
|
219 | "description": "Date/time that work was received.",
|
220 | "allOf": [
|
221 | {
|
222 | "$ref": "#/definitions/dateProperty"
|
223 | }
|
224 | ],
|
225 | "from": "CreativeWork"
|
226 | },
|
227 | "dateAccepted": {
|
228 | "@id": "stencila:dateAccepted",
|
229 | "description": "Date/time of acceptance.",
|
230 | "$comment": "This is not yet a schema.org property but the term is used\n[in Dublin Core](http://purl.org/dc/terms/dateAccepted).\n",
|
231 | "allOf": [
|
232 | {
|
233 | "$ref": "#/definitions/dateProperty"
|
234 | }
|
235 | ],
|
236 | "from": "CreativeWork"
|
237 | },
|
238 | "dateModified": {
|
239 | "@id": "schema:dateModified",
|
240 | "description": "Date/time of most recent modification.",
|
241 | "allOf": [
|
242 | {
|
243 | "$ref": "#/definitions/dateProperty"
|
244 | }
|
245 | ],
|
246 | "from": "CreativeWork"
|
247 | },
|
248 | "datePublished": {
|
249 | "@id": "schema:datePublished",
|
250 | "aliases": [
|
251 | "date"
|
252 | ],
|
253 | "description": "Date of first publication.",
|
254 | "allOf": [
|
255 | {
|
256 | "$ref": "#/definitions/dateProperty"
|
257 | }
|
258 | ],
|
259 | "from": "CreativeWork"
|
260 | },
|
261 | "editors": {
|
262 | "@id": "schema:editor",
|
263 | "description": "People who edited the `CreativeWork`.",
|
264 | "type": "array",
|
265 | "items": {
|
266 | "$ref": "Person.schema.json"
|
267 | },
|
268 | "from": "CreativeWork",
|
269 | "isArray": true,
|
270 | "isPlural": true,
|
271 | "aliases": [
|
272 | "editor"
|
273 | ]
|
274 | },
|
275 | "funders": {
|
276 | "@id": "schema:funder",
|
277 | "description": "People or organizations that funded the `CreativeWork`.",
|
278 | "type": "array",
|
279 | "items": {
|
280 | "anyOf": [
|
281 | {
|
282 | "$ref": "Person.schema.json"
|
283 | },
|
284 | {
|
285 | "$ref": "Organization.schema.json"
|
286 | }
|
287 | ]
|
288 | },
|
289 | "from": "CreativeWork",
|
290 | "isArray": true,
|
291 | "isPlural": true,
|
292 | "aliases": [
|
293 | "funder"
|
294 | ]
|
295 | },
|
296 | "fundedBy": {
|
297 | "@id": "stencila:fundedBy",
|
298 | "description": "Grants that funded the `CreativeWork`; reverse of `fundedItems`.",
|
299 | "$comment": "This follows the proposal [here](https://github.com/schemaorg/schemaorg/issues/2258)\nfor a property that is the reverse of `fundedItems`.\nIt is an any because a `CreativeWork` may have been funded through more than\none `Grant`.\n",
|
300 | "type": "array",
|
301 | "items": {
|
302 | "anyOf": [
|
303 | {
|
304 | "$ref": "Grant.schema.json"
|
305 | },
|
306 | {
|
307 | "$ref": "MonetaryGrant.schema.json"
|
308 | }
|
309 | ]
|
310 | },
|
311 | "from": "CreativeWork",
|
312 | "isArray": true
|
313 | },
|
314 | "genre": {
|
315 | "@id": "schema:genre",
|
316 | "description": "Genre of the creative work, broadcast channel or group.",
|
317 | "type": "array",
|
318 | "items": {
|
319 | "type": "string"
|
320 | },
|
321 | "from": "CreativeWork",
|
322 | "isArray": true
|
323 | },
|
324 | "keywords": {
|
325 | "@id": "schema:keywords",
|
326 | "description": "Keywords or tags used to describe this content.\nMultiple entries in a keywords list are typically delimited by commas.\n",
|
327 | "allOf": [
|
328 | {
|
329 | "parser": "csi"
|
330 | },
|
331 | {
|
332 | "type": "array",
|
333 | "items": {
|
334 | "type": "string"
|
335 | }
|
336 | }
|
337 | ],
|
338 | "from": "CreativeWork",
|
339 | "isArray": true,
|
340 | "isPlural": true,
|
341 | "aliases": [
|
342 | "keyword"
|
343 | ]
|
344 | },
|
345 | "isPartOf": {
|
346 | "@id": "schema:isPartOf",
|
347 | "description": "An item or other CreativeWork that this CreativeWork is a part of.\n",
|
348 | "allOf": [
|
349 | {
|
350 | "$ref": "CreativeWorkTypes.schema.json"
|
351 | }
|
352 | ],
|
353 | "from": "CreativeWork"
|
354 | },
|
355 | "licenses": {
|
356 | "@id": "schema:license",
|
357 | "description": "License documents that applies to this content, typically indicated by URL.\n",
|
358 | "type": "array",
|
359 | "items": {
|
360 | "anyOf": [
|
361 | {
|
362 | "$ref": "CreativeWorkTypes.schema.json"
|
363 | },
|
364 | {
|
365 | "type": "string",
|
366 | "format": "uri"
|
367 | }
|
368 | ]
|
369 | },
|
370 | "from": "CreativeWork",
|
371 | "isArray": true,
|
372 | "isPlural": true,
|
373 | "aliases": [
|
374 | "license"
|
375 | ]
|
376 | },
|
377 | "maintainers": {
|
378 | "@id": "schema:maintainer",
|
379 | "description": "The people or organizations who maintain this CreativeWork.",
|
380 | "$comment": "A maintainer of a Dataset, SoftwareApplication, or other CreativeWork.\nA maintainer is a Person or Organization that manages contributions to,\nand/or publication of, some (typically complex) artifact. It is common for\ndistributions of software and data to be based on \"upstream\" sources.\nWhen maintainer is applied to a specific version of something e.g. a particular\nversion or packaging of a Dataset, it is always possible that the upstream\nsource has a different maintainer. The isBasedOn property can be used to\nindicate such relationships between datasets to make the different maintenance\nroles clear. Similarly in the case of software, a package may have dedicated\nmaintainers working on integration into software distributions such as Ubuntu,\nas well as upstream maintainers of the underlying work.\n",
|
381 | "type": "array",
|
382 | "items": [
|
383 | {
|
384 | "$ref": "Organization.schema.json"
|
385 | },
|
386 | {
|
387 | "$ref": "Person.schema.json"
|
388 | }
|
389 | ],
|
390 | "from": "CreativeWork",
|
391 | "isArray": true,
|
392 | "isPlural": true,
|
393 | "aliases": [
|
394 | "maintainer"
|
395 | ]
|
396 | },
|
397 | "parts": {
|
398 | "@id": "schema:hasParts",
|
399 | "aliases": [
|
400 | "hasParts",
|
401 | "part"
|
402 | ],
|
403 | "description": "Elements of the collection which can be a variety of different elements,\nsuch as Articles, Datatables, Tables and more.\n",
|
404 | "type": "array",
|
405 | "items": {
|
406 | "$ref": "CreativeWorkTypes.schema.json"
|
407 | },
|
408 | "from": "CreativeWork",
|
409 | "isArray": true,
|
410 | "isPlural": true
|
411 | },
|
412 | "publisher": {
|
413 | "@id": "schema:publisher",
|
414 | "description": "A publisher of the CreativeWork.\n",
|
415 | "anyOf": [
|
416 | {
|
417 | "$ref": "Person.schema.json"
|
418 | },
|
419 | {
|
420 | "$ref": "Organization.schema.json"
|
421 | }
|
422 | ],
|
423 | "from": "CreativeWork"
|
424 | },
|
425 | "references": {
|
426 | "@id": "schema:citation",
|
427 | "aliases": [
|
428 | "citations",
|
429 | "reference"
|
430 | ],
|
431 | "description": "References to other creative works, such as another publication,\nweb page, scholarly article, etc.\n",
|
432 | "type": "array",
|
433 | "items": {
|
434 | "anyOf": [
|
435 | {
|
436 | "$ref": "CreativeWorkTypes.schema.json"
|
437 | },
|
438 | {
|
439 | "type": "string"
|
440 | }
|
441 | ]
|
442 | },
|
443 | "from": "CreativeWork",
|
444 | "isArray": true,
|
445 | "isPlural": true
|
446 | },
|
447 | "text": {
|
448 | "@id": "schema:text",
|
449 | "description": "The textual content of this creative work.",
|
450 | "type": "string",
|
451 | "from": "CreativeWork"
|
452 | },
|
453 | "title": {
|
454 | "@id": "schema:headline",
|
455 | "description": "The title of the creative work.",
|
456 | "aliases": [
|
457 | "headline"
|
458 | ],
|
459 | "$comment": "Allows for the title to include inline content (e.g `Strong`, `Math`)\nor a string. The title can not be block content e.g `Paragraph`.\nThe `minItems` restriction avoids a string being coerced into an array\nwith a single string item.\n",
|
460 | "anyOf": [
|
461 | {
|
462 | "type": "array",
|
463 | "items": {
|
464 | "$ref": "InlineContent.schema.json"
|
465 | },
|
466 | "minItems": 2
|
467 | },
|
468 | {
|
469 | "type": "string"
|
470 | }
|
471 | ],
|
472 | "from": "CreativeWork"
|
473 | },
|
474 | "version": {
|
475 | "@id": "schema:version",
|
476 | "description": "The version of the creative work.",
|
477 | "$comment": "In this case `string` is listed as an alternative before `number` to\navoid semantic version numbers e.g. `1.0` being parsed, and subsequently\nencoded, as `1` thereby resulting in loss of information.\n",
|
478 | "anyOf": [
|
479 | {
|
480 | "type": "string"
|
481 | },
|
482 | {
|
483 | "type": "number"
|
484 | }
|
485 | ],
|
486 | "from": "CreativeWork"
|
487 | }
|
488 | },
|
489 | "definitions": {
|
490 | "dateProperty": {
|
491 | "anyOf": [
|
492 | {
|
493 | "$ref": "Date.schema.json"
|
494 | },
|
495 | {
|
496 | "type": "string",
|
497 | "format": "date-time"
|
498 | },
|
499 | {
|
500 | "type": "string",
|
501 | "format": "date"
|
502 | }
|
503 | ]
|
504 | }
|
505 | },
|
506 | "file": "CreativeWork.schema.yaml",
|
507 | "children": [
|
508 | "Article",
|
509 | "Collection",
|
510 | "Comment",
|
511 | "Datatable",
|
512 | "Figure",
|
513 | "MediaObject",
|
514 | "Periodical",
|
515 | "PublicationIssue",
|
516 | "PublicationVolume",
|
517 | "Review",
|
518 | "SoftwareApplication",
|
519 | "SoftwareSourceCode",
|
520 | "Table"
|
521 | ],
|
522 | "descendants": [
|
523 | "Article",
|
524 | "AudioObject",
|
525 | "Collection",
|
526 | "Comment",
|
527 | "Datatable",
|
528 | "Figure",
|
529 | "ImageObject",
|
530 | "MediaObject",
|
531 | "Periodical",
|
532 | "PublicationIssue",
|
533 | "PublicationVolume",
|
534 | "Review",
|
535 | "SoftwareApplication",
|
536 | "SoftwareSourceCode",
|
537 | "Table",
|
538 | "VideoObject"
|
539 | ],
|
540 | "$schema": "http://json-schema.org/draft-07/schema#",
|
541 | "$id": "https://schema.stenci.la/v0/CreativeWork.schema.json",
|
542 | "source": "https://github.com/stencila/schema/blob/master/CreativeWork.schema.yaml",
|
543 | "type": "object",
|
544 | "propertyAliases": {
|
545 | "alternateName": "alternateNames",
|
546 | "identifier": "identifiers",
|
547 | "image": "images",
|
548 | "author": "authors",
|
549 | "comment": "comments",
|
550 | "date": "datePublished",
|
551 | "editor": "editors",
|
552 | "funder": "funders",
|
553 | "keyword": "keywords",
|
554 | "license": "licenses",
|
555 | "maintainer": "maintainers",
|
556 | "hasParts": "parts",
|
557 | "part": "parts",
|
558 | "citations": "references",
|
559 | "reference": "references",
|
560 | "headline": "title"
|
561 | },
|
562 | "additionalProperties": false,
|
563 | "required": [
|
564 | "type"
|
565 | ]
|
566 | }
|