PSDI Metadata Checking Guidelines

Summary

• After editing PSDI metadata certain checks should be made - these steps are outlined here:
  1. Ensure that required fields for top-level of metadata have been filled in
  2. Ensure that versioning attributes have been updated to capture changes - see "Versioning" below
  3. Validate files - see "Validation" below.

Versioning

• Version numbers e.g. [dc:Version] use semantic versioning

Validation

Note that the this is general validation that all metadata profiles undergo, and validation specific to a particular profile (e.g. SHACL validation) is also performed, as described in the guidelines for those profiles.

Automated validation:

• Does the jsonld convert to ttl without errors with rdflib
• If the jsonld file is read with utf-8 encoding and saved with utf-8 encoding is it identical to the original file?

Other validation:

• JSON-LD Playground and check that it parses and when clicking on the tabs lower down the page for its reinterpretation that they're all sensible.
• https://jsonlint.com/
• https://validator.schema.org/
• Mentor extension for Visual Studio Code

About this page

• Creator: Aileen Day
• Last modified date: 2025-05-02
• License: CC-BY-4.0
• Citation: Please cite: Aileen Day, PSDI Metadata Checking Guidelines, https://guidance.psdi.ac.uk/docusaurus-pages/docs/guidance/metadata/psdi-metadata/psdi-checking-guidelines/, PSDI (modified 2025-05-02)

If you would like to contribute content to the PSDI Knowledge Base or have feedback you would like to give on this guidance, please contact us.