README.md

SHARE Notification Service Metadata JSON-LD context and sample

This gist was automatically created by the JSON-LD Playground. You can see it loaded there by visiting:

http://json-ld.org/playground#/gist/<gist igd>

notify-context.json

{
	"@context": {
		"share": "https://gist.github.com/anarchivist/804bc06586a78f88611a/raw/notify-context.json#",
		"xsd": "http://www.w3.org/2001/XMLSchema#",
		"ali": "http://www.niso.org/schemas/ali/1.0/jsonld.json#",
		"rioxx": "http://rioxx.net/schema/v2.0/rioxxterms/#",
		"edm": "http://www.europeana.eu/schemas/edm/#",
		"schema": "https://schema.org/",
		"dcterms": "http://purl.org/dc/terms/",
		"collectionTime": {
			"@id": "share:collectionTime",
			"@type": "xsd:dateTime"
		},
		"contributor": {
			"@id": "schema:contributor",
			"@type": "@id"
		},
		"name": {
			"@id": "schema:name",
			"@type": "xsd:string"
		},
		"familyName": {
			"@id": "schema:familyName",
			"@type": "xsd:string"
		},
		"givenName": {
			"@id": "schema:givenName",
			"@type": "xsd:string"
		},
		"additionalName": {
			"@id": "schema:additionalName",
			"@type": "xsd:string"
		},
		"sameAs": {
			"@id": "schema:sameAs",
			"@type": "@id"
		},
		"email": {
			"@id": "schema:email",
			"@type": "xsd:string"
		},
		"affiliation": {
			"@id": "schema:affiliation",
			"@type": "xsd:string"
		},
		"creationDate": {
			"@id": "rioxx:publication_date",
			"@type": "xsd:date"
		},
		"description": {
			"@id": "dcterms:description",
			"@type": "xsd:string"
		},
		"directLink": {
			"@id": "edm:isShownBy",
			"@type": "@id"
		},
		"freeToRead": {
			"@id": "ali:free_to_read",
			"@type": "@id"
		},
		"licenseRef": {
			"@id": "ali:license_ref",
			"@type": "@id" 
		},
		"uri": {
			"@id": "ali:uri",
			"@type": "@id" 
		},
		"startDate": {
			"@id": "ali:start_date",
			"@type": "xsd:date"
		},
		"endDate": {
			"@id": "ali:end_date",
			"@type": "xsd:date"
		},
		"notificationLink": {
			"@id": "share:notificationLink",
			"@type": "@id"
		},
		"publisher": {
			"@id": "dcterms:publisher",
			"@type": "xsd:string"
		},
		"raw": {
			"@id": "share:raw",
			"@type": "@id"
		},
		"relation": {
			"@id": "dcterms:relation",
			"@type": "@id"
		},
		"resourceIdentifier": {
			"@id": "schema:sameAs",
			"@type": "@id"
		},
		"revisionTime": {
			"@id": "share:revisionTime",
			"@type": "xsd:dateTime"
		},
		"shareProperties": {
			"@id": "share:shareProperties",
			"@type": "@id"
		},
		"source": {
			"@id": "share:source",
			"@type": "xsd:string"
		},
		"sourceProperties": {
			"@id": "share:sourceProperties",
			"@type": "@id"
		},
		"sponsorship": {
			"@id": "share:sponsorship",
			"@type": "@id"
		},
		"award": {
			"@id": "share:award",
			"@type": "@id"
		},
		"awardName": {
			"@id": "share:awardName",
			"@type": "xsd:string"
		},
		"awardIdentifier": {
			"@id": "schema:sameAs",
			"@type": "@id"
		},
		"sponsor": {
			"@id": "schema:Organization",
			"@type": "@id"
		},
		"sponsorName": {
			"@id": "schema:name",
			"@type": "xsd:string"
		},
		"sponsorIdentifier": {
			"@id": "schema:sameAs",
			"@type": "@id"
		},
		"title": {
			"@id": "dcterms:title",
			"@type": "xsd:string"
		},
		"version": {
			"@id": "rioxx:version",
			"@type": "xsd:string"
		},
		"versionOfRecord": {
			"@id": "rioxx:version_of_record",
			"@type": "@id"
		}
	}
}

notify-example.json

{
	"@context": "https://gist.githubusercontent.com/anarchivist/804bc06586a78f88611a/raw/notify-context.json",
	"@id": "http://share.clst.org/id/0",
	"collectionTime": "2015-02-12T12:31:42Z",
	"contributor": [
		{
			"@type": "schema:Person",
			"name": "Eric Celeste",
			"familyName": "Celeste",
			"givenName": "Eric",
			"email": "efc@clst.org",
			"affiliation": "SHARE",
			"sameAs": [
				"http://eric.clst.org",
				"http://orcid.org/0000-0001-7678-7477"
			]
		},
		{
			"@type": "schema:Organization",
			"name": "SHARE",
			"sameAs": "http://share-research.org"
		}
	],
	"creationDate": "2015-02-10",
	"description": "An imaginary resource created as an example for SHARE.",
	"directLink": "http://share.clst.org/examples/imaginary-resource.pdf",
	"freeToRead": {
		"startDate": "2015-02-10"
	},
	"licenseRef": [
		{
			"uri": "https://creativecommons.org/licenses/by/4.0/",
			"startDate": "2015-02-10"
		}
	],
	"notificationLink": "http://share.clst.org/id/0",
	"publisher": "SHARE Example Press",
	"raw": "http://share.clst.org/examples/notify-example.json",
	"relation": [
		"http://share.clst.org/examples/something-else.html"
	],
	"resourceIdentifier": "http://share.clst.org/examples/imaginary-landing.html",
	"revisionTime": "2015-02-09T06:55:20Z",
	"shareProperties": {
		"consumeFinished": "2015-02-12T12:31:50Z"
	},
	"source": "efc",
	"sourceProperties": {
		"subject": [
			"imaginary",
			"example"
		],
		"size": "invisible",
		"name": "not a name"
	},
	"sponsorship": [ 
		{
			"award": {
				"awardName": "2014-1234"
			},
			"sponsor": {
				"sponsorName": "EFC",
				"sponsorIdentifier": "http://eric.clst.org"
			}
		},
		{
			"award": {
				"awardName": "Award 2014 25B"
			},
			"sponsor": {
				"sponsorName": "Nifty Agents"
			}
		}
	],
	"title": "An Imaginary Resource for SHARE.",
	"version": "NA"
}

playground.jsonld

{
  "@context": {
    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
    "playground": "http://json-ld.org/playground#",
    "description": "rdfs:label",
    "startTab": "playground:startTab",
    "copyContext": "playground:copyContext",
    "markup": {
      "@id": "playground:markup",
      "@type": "@id"
    },
    "context": {
      "@id": "playground:context",
      "@type": "@id"
    },
    "frame": {
      "@id": "playground:frame",
      "@type": "@id"
    }
  },
  "description": "SHARE Notification Service Metadata JSON-LD context and sample",
  "startTab": "tab-compacted",
  "copyContext": false,
  "markup": "https://gist.githubusercontent.com/anarchivist/804bc06586a78f88611a/raw/notify-example.json",
  "context": "https://gist.githubusercontent.com/anarchivist/804bc06586a78f88611a/raw/notify-context.json"
}

• @type for contributor, freeToRead, shareProperties, and sourceProperties should not be @id
  • contributor: I wouldn't specify a type in the context at all.
  • shareProperties and sourceProperties should just be mapped in the @context to null.
• Strings in JSON-LD are automatically interpreted as xsd:string-typed values; this can simplify the context for, say, name to be {"name": "schema:name"}.

Thanks for these suggestions!

Mapping to null is an excellent idea. Done.

I didn't realize the default @type was xsd:string. I've implemented this across the board.

I am not sure of the impact of the lack of type on contributor. I've removed it just to see, and no harm done. Would the same be true of sponsorship, sponsor, and award though? I thought these needed to be @id to provide an indication that an embedded node would be here, but then I thought that of contributor as well.