Shema.org JSON-LD

Its recomended to include json-ld in the html markup to make it easy for crawlers to find and parse the structured metadata.
There is several ways to encode your metadata using JsonLd the goal of this list is to provide examples and recomendation about how to provide good metadata with a set of recomended properties.

Properties

(M): Mandatory, (R): Recommended, (O): Optional

To describe a dateset using schema.org the json-ld type must be set to Dataset minimal example:

Minimal JsonLD Dataset

example of JsonLd included in landing page html markup

<script type="application/ld+json">
{
    "@context":"https://schema.org/",
    "@type":"Dataset",
    "@id":"https://doi.org/xxxx",
    "name":"Example dataset",
    "description":"Dataset description",
    "keywords":[
        "example tag",
        "another tag"
    ],
    "publisher":{
        "@type":"Organization",
        "@id":"https://ror.org/0093a8w51",
        "name":"Blekinge Institute of Technology"
    }
}
</script>

For the proerty examples only the value will be listed to make the examples a bit shorter.

identifier (M)

Single or multiple values for identifiers for local or global identifiers for the dataset. Can be text, url or a set of PropertyValue

creator (M)

Example

list of creators

[
    {
        "@type": "Person",
        "@id": "https://orcid.org/0000-0002-7365-0691",
        "givenName": "Olof",
        "familyName": "Olsson"
    },
    {
        "@type": "Organization",
        "@id": "https://ror.org/048a87296",
        "name": "Uppsala University"
    }
]

One or multiple Organization and/or Person

Reference

name (M)

Used for the title of the dataset, an alternate title exist use the property alternateName.

publisher (M)

Recomended to use a single organization. The @id and/or indetifier should be ROR-id if availible.

publisher example

{
    "@type": "Organization",
    "@id": "https://ror.org/048a87296",
    "name": "Uppsala University"
}

datePublished (M)

ISO-8601 date, full date or just year.

Examples:
2024-04-01
2024

dateCreated (R)

ISO-8601 date, full date or just year.

Examples:
2024-04-01
2024

keywords (M)

Keywords used to categorize the dataset. Values can be both text and URL:s.

Example:

keyword example

[
    "Health",
    "http://id.nlm.nih.gov/mesh/D014943"
]

contributor (O)

Person(s) and / or organisation(s) with a contributor role to the dataset.

Example

list of contributors

[
    {
        "@type": "Person",
        "@id": "https://orcid.org/0000-0002-7365-0691",
        "givenName": "Kurt",
        "familyName": "Olsson"
    },
    {
        "@type": "Organization",
        "@id": "https://ror.org/05ynxx418",
        "name": "Linköping University"
    }
]

inLanguage (R)

The primary language(s) in of the resource. u Range text literal or schema.org/Language
Use ISO 639-1, ISO 639-2 or ISO 639-3 codes as identifier

Examples:
en
sv

schema.org/Language example

[
    {
        "@type":"Language",
        "identifier": "en",
        "name":"English",
    }
]

additionalType (O)

One or multiple additional types to classify the dataset.
Can be Url:s or plain text.

Examples:
survey
http://publications.europa.eu/resource/authority/dataset-type/STATISTICAL
http://publications.europa.eu/resource/authority/dataset-type/GEOSPATIAL

version (O)

Version number of the dataset if availible.

Examples:
1
1.0

license (R)

URL to the licence for the dataset.

Examples:
https://creativecommons.org/publicdomain/zero/1.0/
https://creativecommons.org/licenses/by/4.0/

description (M)

Plain text description of the dataset. Should contains a short abstract and any general technical information about the dataset.

distribution (R)

Describes and links to the files in the dataset.
If the dataset contains multiple files in a hierarchical structure provide the relative path in name. e.g. images/2024-03-14.jpg.

list of files in the dataset

[
    {
        "@type": "DataDownload",
        "name": "my-data.tsv",
        "contentUrl": "https://www.sample-data-repository.org/dataset/my-data.csv",
        "encodingFormat": "text/csv"
    },
    {
        "@type": "DataDownload",
        "name": "readme.txt",
        "contentUrl": "https://www.sample-data-repository.org/dataset/readme.txt",
        "encodingFormat": "text/plain"
    }
]

Reference

spatialCoverage (O)

Geographical coverage of the dataset, can be a named place or place with cooridnates. For @id use url to the named place on geonames.org

example of some ways to add spatial coverage

[
    {
        "@type": "Place",
        "containedInPlace":{
            "@type": "Country",
            "@id": "https://sws.geonames.org/2661886/",
            "identifier": "SE",
            "name": "Sweden"
        },
        "geo":{
            "@type": "GeoCoordinates",
            "latitude": 64.226154,
            "longitude": 19.770768
        },
        "name": "Åhedbäcken, Catchment 14"
    },
    {
        "@type":"Place",
        "geo":{
            "@type":"GeoShape",
            "polygon":"11.966386321679863 57.68787445177847 11.967288055967629 57.68864040232995 11.96600241500289 57.688969684507015 11.965243529711358 57.688263394424354 11.966386321679863 57.68787445177847"
        },
        "name":"Geovetarcentrum"
    }
]

temporalCoverage (O)

The time period the dataset covers.
Use ISO-datetime for single date/time or timespan.

Examples
2024-03-15 sigle date no timespan
2020/2024 timespan from 2020 until 2024
2020/.. from 2020 open ended
http://n2t.net/ark:/99152/p0qhb66skwk "stenålder 10200 BP (2000) – 3800 BP (2000) | Sweden" by refering to a specified time period from perio.do

funding (O)

Describes the grant(s) for funding the dataset.