3. Documents#
Metadata template for Documents, which is a combined category from the schema.org terms: CreativeWork, DigitalDocument, Thesis, Report, Article, …
So this all entries of these types will end up in the ‘Document’ search bucket.
Be aware that this category may contain also entries which are in reality no documents but typed in the metadata by the high level schema.org class ‘CreateWork’.
1{
2 "@context": {
3 "@vocab": "https://schema.org/"
4 },
5 "@id": "URL: Optional. A URL that resolves to *this* JSON-LD document, NOT the URL of the WebAPI that this JSON-LD document describes. To link to the WebAPI itself, please use 'url' and/or 'identifier')",
6 "@type": "CreativeWork",
7
8 "about": "Text or controlled vocabulary/ontology, singly or as an array: The subject matter of this CreativeWork",
9 "abstract": "Text: A descriptive summary of a CreativeWork",
10 "accessMode": [
11 "auditory",
12 "chartOnVisual",
13 "chemOnVisual",
14 "colorDependent",
15 "diagramOnVisual",
16 "mathOnVisual",
17 "musicOnVisual",
18 "tactile",
19 "textOnVisual",
20 "textual",
21 "visual"
22 ],
23 "accessModeSufficient": [
24 "auditory",
25 "chartOnVisual",
26 "chemOnVisual",
27 "colorDependent",
28 "diagramOnVisual",
29 "mathOnVisual",
30 "musicOnVisual",
31 "tactile",
32 "textOnVisual",
33 "textual",
34 "visual"
35 ],
36 "accessibilityHazard": [
37 "flashing",
38 "noFlashingHazard",
39 "motionSimulation",
40 "noMotionSimulationHazard",
41 "sound",
42 "noSoundHazard",
43 "unknown",
44 "none"
45 ],
46 "accessibilitySummary": "Text: A textual summary of how this CreativeWork can be accessed, if there are any hazards associated with access, and related facts",
47 "accountablePerson": {
48 "@type": "Person",
49 "name": "Dr Uta Passow",
50 "givenName": "Uta",
51 "familyName": "Passow",
52 "url": "https://www.sample-data-repository.org/person/51317"
53 },
54 "acquireLicensePage": "https://urlToLicenseAcquisitionPage.org/",
55 "aggregateRating": {
56 "@type": "AggregateRating",
57 "reviewAspect": "Text describing what part of the CreativeWork is subject to the ratings here",
58 "ratingValue": "4",
59 "ratingExplanation": "Text explaining the ratingValue",
60 "reviewCount": "250",
61 "bestRating": "5",
62 "worstRating": "1"
63 },
64 "alternativeHeadline": "Text: A secondary title of the CreativeWork.",
65 "archivedAt": "https://urlToResourceCreativeWorkIsArchivedAt.org/",
66 "assesses": "Text to describe what (if anything) the CreativeWork described by this template assesses.",
67 "associatedMedia": {
68 "@type": "MediaObject",
69 "name": "Name of the media object encoding this CreativeWork",
70 "description": "A schema.org MediaObject, such as an image, video, or audio object embedded in a web page or a downloadable dataset, i.e. DataDownload. See [TODO: Add MediaObject support profile]"
71 },
72 "audience": "Text: Text describing the audience the CreativeWork is intended for.",
73 "audio": {
74 "@type": "AudioObject",
75 "name": "Title Of The AudioFile",
76 "description": "Description of the audio object",
77 "contentUrl": "http://myAudioWebsite.org/TitleOfTheAudioFile.mp4",
78 "encoding": "audio/mp4"
79 },
80 "author": {
81 "@type": "Person",
82 "name": "Dr Uta Passow",
83 "givenName": "Uta",
84 "familyName": "Passow",
85 "url": "https://www.sample-data-repository.org/person/51317"
86 },
87 "award": "Text to describe an award won for this CreativeWork",
88 "character": {
89 "@type": "Person",
90 "name": "Odysseus",
91 "description": "A description of any ficitonal character mentioned in this creative work",
92 "givenName": "Odysseus",
93 "familyName": "",
94 "url": "https://en.wikipedia.org/wiki/Odysseus"
95 },
96 "citation": [
97 "Citation to other work relevant to this software",
98 "Citation to other work relevant to this software",
99 "Citation to other work relevant to this software"
100 ],
101 "comment": "Text comment on the CreativeWork",
102 "commentCount": 1,
103 "conditionsOfAccess": "Text to describe conditions that affect the availability of, or method(s) of access to, an item.",
104 "contentLocation": {
105 "@type": "AdministrativeArea",
106 "name": "Lunenburg",
107 "description": "The location depicted or described in the CreativeWork"
108 },
109 "contentRating": "Text stating the official rating for this CreativeWork",
110 "contentReferenceTime": "DateTime: 2016-03-21T11:30:00-07:00",
111 "contributor": {
112 "@type": "Organization",
113 "@id": "http://www.foo.org/orgID",
114 "legalName": "Some Institute"
115 },
116 "copyrightHolder": {
117 "@type": "Person",
118 "@id": "http://lod.example-data-repository.org/id/person/5112",
119 "name": "Dr Sarah Smith",
120 "url": "https://www.example-data-repository.org/person/5112"
121 },
122 "copyrightNotice": "Text of a notice appropriate for describing the copyright aspects of this Creative Work",
123 "copyrightYear": "Number: 1999",
124 "correction": "Text or CorrectionComment or URL property to indicate a correction to the CreativeWork",
125 "countryOfOrigin": {
126 "@type": "Country",
127 "name": "Fiji"
128 },
129 "creativeWorkStatus": "Text or DefinedTerm property to describe the status of this CreativeWork in terms of its stage in a lifecycle",
130 "creator": [
131 {
132 "@type": "Person",
133 "@id": "http://lod.example-data-repository.org/id/person/51159",
134 "name": "Dr Langdon Quetin",
135 "url": "https://www.example-data-repository.org/person/51159"
136 },
137 {
138 "@type": "Person",
139 "@id": "http://lod.example-data-repository.org/id/person/51160",
140 "name": "Dr Robin Ross",
141 "url": "https://www.example-data-repository.org/person/51160"
142 }
143 ],
144 "creditText": "Text used to credit person(s) and/or organization(s) associated with this CreativeWork",
145 "dateCreated": "2019-03-21",
146 "dateModified": "2019-03-21",
147 "datePublished": "2019-03-21",
148 "discussionUrl": "http://LinkToPage/with/comments/about/this/work",
149 "editEIDR": "Text or URL to state the EIDR (Entertainment Identifier Registry) identifier representing a specific edit / edition for a work of film or television.",
150 "editor": {
151 "@type": "Person",
152 "name": "Person name"
153 },
154 "educationalAlignment": {
155 "@type": "AlignmentObject",
156 "alignmentType": "educationalSubject",
157 "educationalFramework": "Text: The framework to which the resource being described is aligned",
158 "targetName": "Text: name of a node in an established educational framework",
159 "targetUrl": "http://example.org/CFE/subjects/3362"
160 },
161 "educationalLevel": "The level in terms of progression through an educational or training context. Examples of educational levels include 'beginner', 'intermediate' or 'advanced', and formal sets of level indicators.",
162 "educationalUse": "Text or DefinedTerm property to describe the purpose of this CreativeWork in the context of education",
163 "encoding": {
164 "@type": "MediaObject",
165 "description": "A media object that encodes this CreativeWork. Such as video, etc."
166 },
167 "encodingFormat": "application/zip ",
168 "exampleOfWork": {
169 "@type": "CreativeWork",
170 "description": "A creative work that this work is an example/instance/realization/derivation of"
171 },
172 "expires": "2019-03-21",
173 "funder": {
174 "@type": "Person",
175 "name": "Person name"
176 },
177 "funding": {
178 "@type": "Grant",
179 "name": "Name of grant that supports this creativework"
180 },
181 "genre": "Genre of the creative work, broadcast channel or group.",
182 "hasPart": {
183 "@type": "CreativeWork",
184 "description": "Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).Inverse property: isPartOf"
185 },
186 "headline": "Headline of the article",
187 "inLanguage": {
188 "@type": "Language",
189 "name": "Spanish",
190 "alternateName": "es"
191 },
192 "interactionStatistic": {
193 "@type": "InteractionCounter",
194 "interactionType": "https://schema.org/ListenAction",
195 "userInteractionCount": "14300"
196 },
197 "interactivityType": "Text to describe the predominant mode of learning supported by the learning resource",
198 "interpretedAsClaim": {
199 "@type": "Claim",
200 "appearance": {
201 "@type": "CreativeWork",
202 "name": "Julius Caesar"
203 },
204 "claimInterpreter": {
205 "@type": "Person",
206 "@id": "http://lod.example-data-repository.org/id/person/514",
207 "name": "Susan White",
208 "url": "https://www.example-data-repository.org/person/514"
209 }
210 },
211 "isAccessibleForFree": "True",
212 "isBasedOn": {
213 "@type": "CreativeWork",
214 "description": "A resource from which this work is derived or from which it is a modification or adaption"
215 },
216 "isFamilyFriendly": "True",
217 "isPartOf": {
218 "@type": "CreativeWork",
219 "description": "Indicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.Inverse property: hasPart"
220 },
221 "keywords": {
222 "@type": "DefinedTerm",
223 "inDefinedTermSet": {
224 "@type": "DefinedTermSet",
225 "name": "Name of the set",
226 "description": "Description of the set",
227 "url": "url for the set"
228 },
229 "termCode": "A code that identifies this DefinedTerm within a DefinedTermSet"
230 },
231 "learningResourceType": "Text or DefinedTerm property to describe predominant type or kind characterizing the learning resource.",
232 "license": "http://spdx.org/licenses/CC0-1.0",
233 "locationCreated": {
234 "@type": "Place",
235 "geo": {
236 "@type": "GeoCoordinates",
237 "latitude": 39.3280,
238 "longitude": 120.1633
239 }
240 },
241 "mainEntity": "Thing",
242 "maintainer": {
243 "@type": "Person",
244 "name": "Person name"
245 },
246 "material": "Text or Product or URL property to describe the material that the CreativeWork is made from",
247 "materialExtent": "Text or QuantitativeValue to state the quantity of the materials being described or an expression of the physical space they occupy",
248 "mentions": "Thing Indicates that the CreativeWork contains a reference to, but is not necessarily about a concept",
249 "offers": [
250 {
251 "@type": "Offer",
252 "name": "name of offer"
253 },
254 {
255 "@type": "Demand",
256 "name": "name of demand"
257 }
258 ],
259 "pattern": "Text or DefinedTerm property to state the pattern that the CreativeWork has, for example 'polka dot', 'striped', 'Canadian flag'",
260 "position": "Text or Integer to describe the position of the CreativeWork in a series or sequence of items",
261 "producer": {
262 "@type": "Person",
263 "name": "George Martin"
264 },
265 "provider": {
266 "@type": "Organization",
267 "legalName": "Sample Data Repository Office",
268 "name": "SDRO",
269 "sameAs": "http://www.re3data.org/repository/r3dxxxxxxxxx",
270 "url": "https://www.sample-data-repositoryB.org"
271 },
272 "publication": {
273 "@type": "PublicationEvent",
274 "startDate": "1968-11-25",
275 "location": {
276 "@type": "Country",
277 "name": "Ghana"
278 }
279 },
280 "publisher": {
281 "url": "https://www.publishingrus.org",
282 "@type": "Organization",
283 "legalName": "Some Institute"
284 },
285 "publisherImprint": {
286 "@id": "https://www.publishingdiv.org",
287 "@type": "Organization",
288 "legalName": "Some publishing division"
289 },
290 "publishingPrinciples": "https://url.to.document.describing.editorial.principles.of.organization.com",
291 "recordedAt": {
292 "@type": "Event",
293 "location": "Some place",
294 "startDate": "Some start date",
295 "url": "https://url.to.event.com"
296 },
297 "releasedEvent": {
298 "@type": "PublicationEvent",
299 "startDate": "Some date",
300 "location": {
301 "@type": "Country",
302 "name": "Some country"
303 }
304 },
305 "review": {
306 "@type": "Review",
307 "author": "A Reviewer",
308 "datePublished": "Some date",
309 "reviewBody": "Text describing the review of the CreativeWork",
310 "name": "text for name of review",
311 "reviewRating": {
312 "@type": "Rating",
313 "bestRating": "some integer",
314 "ratingValue": "some integer",
315 "worstRating": "some integer"
316 }
317 },
318 "schemaVersion": [
319 "https://schema.org/docs/releases.html#v10.0",
320 "http://dublincore.org/specifications/dublin-core/dces/1999-07-02",
321 "https://github.com/spdx/license-list-XML/releases/tag/v3.20"
322 ],
323 "sdDatePublished": "2022-04-12",
324 "sdLicense": "http://spdx.org/licenses/CC0-1.0",
325 "sdPublisher": [
326 {
327 "@type": "Organization",
328 "legalName": "Example Structured Data Publishing Organisation",
329 "name": "ESDPO",
330 "description": "An organisation which publishes structured data about things.",
331 "url": "https://www.exampleSDPublisher.org/"
332 },
333 {
334 "@type": "Person",
335 "name": "John Doe",
336 "description": "A person who publishes structured data about Things",
337 "url": "https://www.sample-data-repository.org/person/51332"
338 }
339 ],
340 "size": "Text indicating the phyiscal size of the CreativeWork (if appropriate). DefinedTerm or QuantitativeValue or SizeSpecification are also valid Types",
341 "sourceOrganization": {
342 "@type": "Organization",
343 "legalName": "Example Source Organisation",
344 "name": "ESO",
345 "description": "The organisation which the creator of this CreativeWork was working for.",
346 "url": "https://www.exampleSource.org/"
347 },
348 "spatial": {
349 "@type": "Place",
350 "description": "Use the 'spatial' property and the properites under 'Place' for any spatial information you'd like to add, beyond spatialCoverage."
351 },
352 "spatialCoverage": {
353 "@type": "Place",
354 "address": "54 Ocean Drive, 23521 Ocean City, CountryName",
355 "name": "Place name",
356 "description": "Use this Place type to express which spatial region your CreativeWork is about or is focused on. If you don't have precise coordinates, use this description field to describe the place with free text",
357 "geo": {
358 "@type": "GeoShape",
359 "polygon": "-158.8575 23.4375, -158.8575 21.2283, -157.4567 21.2283, -157.4567 23.4375, -158.8575 23.4375"
360 },
361 "additionalProperty": [
362 {
363 "@type": "PropertyValue",
364 "propertyID": "http://dbpedia.org/resource/Spatial_reference_system",
365 "value": "http://www.w3.org/2003/01/geo/wgs84_pos#lat_long"
366 },
367 {
368 "@type": "PropertyValue",
369 "propertyID": "GPS Accuracy / Location error",
370 "value": "18",
371 "unitCode": "http://qudt.org/vocab/unit/M"
372 }
373 ]
374 },
375 "sponsor": [
376 {
377 "@type": "Organization",
378 "legalName": "Example Sponsorship Organisation",
379 "name": "ESO",
380 "description": "An organisation which sponsors things.",
381 "url": "https://www.exampleSponsorship.org/"
382 },
383 {
384 "@type": "Person",
385 "name": "John Doe",
386 "description": "A person who sponsors many Things",
387 "url": "https://www.sample-data-repository.org/person/51332"
388 }
389 ],
390 "teaches": [
391 "ocean exploration",
392 {
393 "@type": "DefinedTerm",
394 "inDefinedTermSet": "http://vocabularies.unesco.org/thesaurus",
395 "name": "ocean exploration",
396 "termCode": "concept10630",
397 "url": "http://vocabularies.unesco.org/thesaurus/concept10630"
398 }
399 ],
400 "temporal": "A more general property for any time-related information about this CreativeWork. This can be expressed as text or using the properties associated with the DateTime Type",
401 "temporalCoverage": "2011/2012",
402 "text": "The entire textual content of this CreativeWork, if relevant",
403 "thumbnailUrl": "https://www.sample-website.org/imageAboutThisThing.jpg",
404 "timeRequired": "PT30M",
405 "translationOfWork": {
406 "@type": "CreativeWork",
407 "description": "The CreativeWork that this CreativeWork was translated from, if any",
408 "inLanguage": "ja",
409 "name": "クリエイティブな作品",
410 "url": "https://www.sample-data-repository.org/creativeWork/1124",
411 "translator": {
412 "@type": "Person",
413 "name": "Dr 山田 太郎",
414 "givenName": "太郎",
415 "familyName": "山田",
416 "url": "https://www.sample-data-repository.org/person/12435"
417 }
418 },
419 "translator": [
420 {
421 "@type": "Organization",
422 "legalName": "Translations Incorporated",
423 "name": "TI",
424 "description": "An organisation which has been tasked with translating this CreativeWork.",
425 "url": "https://www.translationsIncorporated.org/"
426 },
427 {
428 "@type": "Person",
429 "name": "John Doe",
430 "description": "A person who has been tasked with translating this CreativeWork.",
431 "url": "https://www.sample-data-repository.org/person/51332"
432 }
433 ],
434 "typicalAgeRange": "20-60",
435 "usageInfo": {
436 "@type": "CreativeWork",
437 "name": "Guidelines on how to use and how not to use this CreativeWork",
438 "description": "A document or other resources which contains information on how the CreativeWork should and should not be used.",
439 "url": "https://usageGuides.org/usageGuide_2321.pdf"
440 },
441 "version": "3.2",
442 "video": {
443 "@type": "VideoObject",
444 "description": "A video object about this CreativeWork.",
445 "duration": "PT1M33S",
446 "name": "A video about our CreativeWork",
447 "thumbnail": "https://videoImageArchive.org/videoThumbnail.jpg",
448 "contentSize": "500MB"
449 },
450 "workExample": [
451 {
452 "@type": "Dataset",
453 "datePublished": "2012",
454 "description": "A CSV distribution of this CreativeWork",
455 "distribution": "https://repository.org/pid_to_the_downloadable_dataset.",
456 "encodingFormat": "text/csv",
457 "publisher": {
458 "@type": "Organization",
459 "name": "Data R Us Inc."
460 }
461 },
462 {
463 "@type": "Dataset",
464 "datePublished": "2021",
465 "description": "A Geo JSON distribution of this CreativeWork",
466 "distribution": "https://anotherRepository.org/pid_to_the_downloadable_dataset.",
467 "encodingFormat": "application/geo+json",
468 "publisher": {
469 "@type": "Organization",
470 "name": "GeoData 4 All Inc."
471 }
472 }
473 ],
474 "workTranslation": {
475 "@type": "CreativeWork",
476 "description": "A French translation of this CreativeWork",
477 "inLanguage": "fr",
478 "name": "This CreativeWork - A New Translation",
479 "translator": {
480 "@type": "Person",
481 "name": "Dr John Doe",
482 "givenName": "John",
483 "familyName": "Doe",
484 "url": "https://www.sample-data-repository.org/person/51332"
485 }
486 },
487
488
489
490 "additionalType": "https://myPIDs.org/pidToMyAdditionalType/",
491 "alternateName": "Thing 1",
492 "description": "Free text or a URL to a description of this Thing.",
493 "disambiguatingDescription": "A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation",
494 "identifier": {
495 "@type": "PropertyValue",
496 "propertyID": "https://registry.identifiers.org/registry/myIdentifier/",
497 "value": "xyz",
498 "url": "https://myIdentifier.org/xyz",
499 "description": "Text: Optional description of this identifier, see [TODO: ADD URI TO IDENTIFER PATTERN] for more guidance on sharing identifieres."
500 },
501 "image": "https://myPIDs.org/pidToImageOfThisThing/",
502 "mainEntityOfPage": "https://www.urlToPageWhichIsMainlyAboutThisThing.com/",
503 "name": "Thing One",
504 "potentialAction": {
505 "@type": "Action",
506 "description": "Text: Description of Action which this Thing could potentially participate in. See [TODO:ADD LINK TO ACTION PATTERN] for how to add more structured metadata to Action. ",
507 "name": "Text: Name of Action that this Thing could potentially participate in"
508 },
509 "sameAs": [
510 "https://myPIDs.org/pidToAnotherWebResourceAboutThisThing/",
511 "https://myPIDs.org/pidToYetAnotherWebResourceAboutThisThing/"
512 ],
513 "subjectOf": [
514 "https://myPIDs.org/pidToCreativeWorkAboutThisThing/",
515 "https://myPIDs.org/pidToEventAboutThisThing/"
516 ],
517 "url": "https://www.urlToPageAboutThisThing.com/"
518}