Skip to content

Prez Manifest Model

A Prez Manifest is an RDF file that describes and links to a set of resources that can be loaded into an RDF database for Prez to provide access to.

This page defines the Prez Manifest specification and links to relevant tools.

  1. The model
  2. Manifest Resource Roles Vocabulary
  3. Examples
  4. Tools

Model

graph LR
  Manifest --1:1-N--> Resource;
  Resource --1:1--> artifact;
  Resource --1:1--> role;
  Resource --1:0-1--> name;
  Resource --1:0-1--> decription;
  Resource --1:0-N--> conformsTo;
  artifact --1:0-1--> mainEntity;
  artifact --1:0-1--> contentLocation;
  artifact --1:0-N--> conformsTo;

Rules

  1. An instance of the Manifest class, prez:Manifest, MUST have 1 or more Resource Descriptors, prof:ResourceDescriptor instances, indicated by the prof:hasResource predicate. The Manifest instance can be identified by an IRI or a Blank Node.

  2. Each Resource Descriptor MUST have at least one prof:hasArtifact predicate indicating either an RDF literal resource (a string) containing the location of the artifact or a Blank Node containing the location of the artifacts indicated by the schema:contentLocation predicate and the main artifact IRI within that content location indicated by schema:mainEntity.

  3. Where content location is indicated, it MUST be a file path or path pattern relative to the manifest or a URL.

  4. Each Resource Descriptor MUST also have exactly one prof:hasRole predicate indicating a Concept from the Manifest Resource Roles Vocabulary.

  5. Each Resource Descriptor MAY have a schema:name and/or a schema:description predicate indicating literal resources naming and describing it.

  6. A Resource, or an Artifact, MAY indicate that it (if an Artifact) or the Artifacts within it (if a Resource) conform to any number of defined Standards or Profiles of Standards, using the predicate dcterms:conformsTo.

Validation

The SHACL validator below can be used to test the validity of a manifest.

PREFIX owl: <http://www.w3.org/2002/07/owl#>
PREFIX prez: <https://prez.dev/>
PREFIX prof: <http://www.w3.org/ns/dx/prof/>
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
PREFIX schema: <https://schema.org/>
PREFIX sh: <http://www.w3.org/ns/shacl#>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX val: <https://prez.dev/manifest-validator/>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>

<https://prez.dev/manifest-validator>
    a owl:Ontology ;
    owl:versionIRI val:0.5.0 ;
    owl:versionInfo """0.5.0: Handles artifacts as objects with predicates, not just literals (file paths)

0.4.0: First public version""" ;
    schema:creator <https://orcid.org/0000-0002-8742-7730> ;
    schema:dateCreated "2024-11-29"^^xsd:date ;
    schema:dateModified "2025-01-26"^^xsd:date ;
    schema:definition "The SHACL Shapes Validator for the Prez Ontology Manifest Model"@en ;
    schema:name "Prez Manifest Validator" ;
    schema:publisher <https://kurrawong.ai> ;
.

val:ShapeN01
    a sh:NodeShape ;
    sh:property val:ShapeP01 ;
    sh:targetClass prez:Manifest ;
.

val:ShapeN02
    a sh:NodeShape ;
    sh:property
        val:ShapeP02 ,
        val:ShapeP03 ,
        val:ShapeP04 ,
        val:ShapeP05 ;
    sh:targetObjectsOf prof:hasResource ;
.

val:ShapeP01
    a sh:PropertyShape ;
    sh:nodeKind sh:BlankNodeOrIRI ;
    sh:message "ShapeP01: You must supply at least one value for prof:hasResource for a prez:Manifest and it must be either a Blank Node or an IRI" ;
    sh:minCount 1 ;
    sh:path prof:hasResource ;
.

val:ShapeP02
    a sh:PropertyShape ;
    sh:message "ShapeP02: You must supply at least one value for prof:hasArtifact for a prez:Manifest's Resource Descriptors and each must be a string that can be interpreted as a file path, either relative to the manifest file, or an absolute system path or a URL or a Blank Node with a schema:contentLocation and schema:mainEntity predicates" ;
    sh:minCount 1 ;
    sh:or (
        [ sh:nodeKind sh:Literal ]
        [ sh:nodeKind sh:BlankNode ]
    ) ;
    sh:path prof:hasArtifact ;
.

val:ShapeN04
    a sh:NodeShape ;
    sh:message "ShapeN04: If you supplied a prof:hasArtifact for a prez:Manifest's Resource Descriptors that indicated a Blank Node, the Blank Node must contain exactly one schema:contentLocation and exactly one schema:mainEntity predicates" ;
    sh:targetObjectsOf prof:hasArtifact ;
    sh:or (
        [ sh:nodeKind sh:Literal ]
        [
            sh:nodeKind sh:BlankNode ;
            sh:property [
                sh:path schema:contentLocation ;
                sh:nodeKind sh:Literal ;
                sh:minCount 1 ;
                sh:maxCount 1 ;
                sh:message "ShapeN04 P01: You supplied a prof:hasArtifact value as Blank Node, the Blank Node so it must contain exactly exactly one schema:contentLocation predicate" ;
            ] ,
            [
                sh:path schema:mainEntity ;
                sh:nodeKind sh:IRI ;
                sh:minCount 1 ;
                sh:maxCount 1 ;
                sh:message "ShapeN04 P02: You supplied a prof:hasArtifact value as Blank Node, the Blank Node so it must contain exactly exactly one schema:mainEntity predicate" ;
            ] ;
        ]
    ) ;
.

val:ShapeP03
    a sh:PropertyShape ;
    sh:maxCount 1 ;
    sh:message "ShapeP03: You must supply exactly one value for prof:hasRole for a prez:Manifest's Resource Descriptors with the value selected from the Prez Manifest Resource Roles Vocabulary" ;
    sh:minCount 1 ;
    sh:nodeKind sh:IRI ;
    sh:path prof:hasRole ;
.

val:ShapeP04
    a sh:PropertyShape ;
    sh:maxCount 1 ;
    sh:message "ShapeP04: If you supply a schema:description for a prez:Manifest's Resource Descriptors, it must be either a plain string or a langString literal" ;
    sh:or (
        [ sh:datatype xsd:string ]
        [ sh:datatype rdf:langString ]
    ) ;
    sh:path schema:description ;
.

val:ShapeP05
    a sh:PropertyShape ;
    sh:maxCount 1 ;
    sh:message "ShapeP05: If you supply a schema:name for a prez:Manifest's Resource Descriptors, it must be either a plain string or a langString literal" ;
    sh:or (
        [ sh:datatype xsd:string ]
        [ sh:datatype rdf:langString ]
    ) ;
    sh:path schema:name ;
.

val:ShapeN03
    a sh:NodeShape ;
    sh:targetObjectsOf prof:hasRole ;
    sh:property [
        a sh:PropertyShape ;
        sh:minCount 1 ;
        sh:maxCount 1 ;
        sh:path skos:inScheme ;
    ] ;
.

val:0.5.0
    schema:name "0.5.0" ;
.

<https://orcid.org/0000-0002-8742-7730>
    a schema:Person ;
    schema:email "nick@kurrawong.ai"^^xsd:anyURI ;
    schema:identifier "https://orcid.org/0000-0002-8742-7730"^^xsd:anyURI ;
    schema:memberOf <https://kurrawong.ai> ;
    schema:name "Nicholas J. Car" ;
.

<https://kurrawong.ai>
    a schema:Organization ;
    schema:name "KurrawongAI" ;
    schema:url "https://kurrawong.ai"^^xsd:anyURI ;
.

Note

The prezmanifest tool, described below has a simple validate function that tests a manifest with this validator and also checks that all the artifacts indicated in resources actually exist.

Manifest Resource Roles Vocabulary

This roles vocabulary contains the allowed Roles that a Resource can play with respect to a Manifest.

The IRI of this vocabulary is:

  • https://prez.dev/ManifestResourceRoles
    • the vocab namespace is https://prez.dev/ManifestResourceRoles/
    • recommended namespace prefix is mrr

Human-readable form:

Concept IRI Label Definition Parent
mrr:CatalogueData Catalogue Data Data for the catalogue, usually a Catalogue, including the identity of it and each item fo resource -
mrr:ResourceData Resource Data Data for the resource of the catalogue -
mrr:CatalogueAndResourceModel Catalogue & Resource Model The default model for the catalogue and the resource. Must be a set of SHACL Shapes -
mrr:CatalogueModel Catalogue Model The default model for the catalogue. Must be a set of SHACL Shapes mrr:CatalogueAndResourceModel
mrr:ResourceModel Resource Model The default model for the resource. Must be a set of SHACL Shapes mrr:CatalogueAndResourceModel
mrr:CompleteCatalogueAndResourceLabels Complete Resource & Catalogue Labels All the labels - possibly including names, descriptions & seeAlso links - for the Catalogue and Resource objects -
mrr:IncompleteCatalogueAndResourceLabels Incomplete Resource & Catalogue Labels Some of the labels - possibly including names, descriptions & seeAlso links - for the Catalogue and Resource objects -

Machine-readable form:

PREFIX cs: <https://prez.dev/ManifestResourceRoles>
PREFIX : <https://prez.dev/ManifestResourceRoles/>
PREFIX owl: <http://www.w3.org/2002/07/owl#>
PREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>
PREFIX schema: <https://schema.org/>
PREFIX skos: <http://www.w3.org/2004/02/skos/core#>
PREFIX xsd: <http://www.w3.org/2001/XMLSchema#>


:CompleteCatalogueAndResourceLabels
    a skos:Concept ;
    skos:definition "All the labels - possibly including names, descriptions & seeAlso links - for the Catalogue and Resource objects" ;
    skos:inScheme cs: ;
    skos:prefLabel "Complete Catalogue and Resource Labels" ;
.

:CatalogueAndResourceModel
    a skos:Concept ;
    skos:definition "The default model for the container and the content. Must be a set of SHACL Shapes" ;
    skos:inScheme cs: ;
    skos:prefLabel "Catalogue & Resource Model" ;
.

:CatalogueData
    a skos:Concept ;
    skos:definition "Data for the container, usually a Catalogue, including the identity of it and each item fo content" ;
    skos:inScheme cs: ;
    skos:prefLabel "Catalogue Data" ;
.

:CatalogueModel
    a skos:Concept ;
    skos:definition "The default model for the container. Must be a set of SHACL Shapes" ;
    skos:inScheme cs: ;
    skos:prefLabel "Catalogue Model" ;
.

:ResourceData
    a skos:Concept ;
    skos:definition "Data for the content of the container" ;
    skos:inScheme cs: ;
    skos:prefLabel "Resource Data" ;
.

:ResourceModel
    a skos:Concept ;
    skos:definition "The default model for the content. Must be a set of SHACL Shapes" ;
    skos:inScheme cs: ;
    skos:prefLabel "Resource Model" ;
.

:IncompleteCatalogueAndResourceLabels
    a skos:Concept ;
    skos:definition "Some of the labels - possibly including names, descriptions & seeAlso links - for the Catalogue and Resource objects" ;
    skos:inScheme cs: ;
    skos:prefLabel "Incomplete Catalogue and Resource Labels" ;
.

<https://kurrawong.ai>
    a schema:Organization ;
    schema:name "KurrawongAI" ;
    schema:url "https://kurrawong.ai"^^xsd:anyURI ;
.

:1.0.0
    rdfs:label "1.0.0" ;
.

cs:
    a skos:ConceptScheme ;
    owl:versionIRI :1.0.0 ;
    owl:versionInfo "1.0.0: First public version" ;
    skos:definition "This vocabulary is a test vocabulary showing the use of images within Concept definitions"@en ;
    skos:hasTopConcept
        :CompleteCatalogueAndResourceLabels ,
        :CatalogueAndResourceModel ,
        :CatalogueData ,
        :CatalogueModel ,
        :ResourceData ,
        :IncompleteCatalogueAndResourceLabels ;
    skos:historyNote "Create in 2024 for Prez data loading" ;
    skos:prefLabel "Manifest Resource Roles Vocabulary" ;
    schema:creator <https://kurrawong.ai> ;
    schema:dateCreated "2024-11-29"^^xsd:date ;
    schema:dateModified "2024-12-17"^^xsd:date ;
    schema:publisher <https://kurrawong.ai> ;
.

The IRI for automatic retrieval of this vocabulary file is: https://prez.dev/ManifestResourceRoles.

Examples

Valid

A simple, valid, Manifest.

PREFIX mrr: <https://prez.dev/ManifestResourceRoles/>
PREFIX prez: <https://prez.dev/>
PREFIX prof: <http://www.w3.org/ns/dx/prof/>
PREFIX schema: <https://schema.org/>

[]
    a prez:Manifest ;
    prof:hasResource
        [
            prof:hasArtifact "catalogue.ttl" ;
            prof:hasRole mrr:CatalogueData ;
            schema:description "The definition of, and medata for, the container which here is a dcat:Catalog object" ;
            schema:name "Catalogue Definition"
        ] ,
        [
            prof:hasArtifact "vocabs/*.ttl" ;
            prof:hasRole mrr:ResourceData ;
            schema:description "skos:ConceptsScheme objects in RDF (Turtle) files in the vocabs/ folder" ;
            schema:name "Resource Data"
        ] ,
        [
            prof:hasArtifact "https://github.com/RDFLib/prez/blob/main/prez/reference_data/profiles/ogc_records_profile.ttl" ;
            prof:hasRole mrr:CatalogueAndResourceModel ;
            schema:description "The default Prez profile for Records API" ;
            schema:name "Profile Definition"
        ] ,
        [
            prof:hasArtifact "_background/labels.ttl" ;
            prof:hasRole mrr:CompleteCatalogueAndResourceLabels ;
            schema:description "An RDF file containing all the labels for the container content" ;
            schema:name "Labels" ;
        ] ;
.

Invalid - no role

The second Resource Descriptor does not indicate a role as it is commented out.

PREFIX mrr: <https://prez.dev/ManifestResourceRoles/>
PREFIX prez: <https://prez.dev/>
PREFIX prof: <http://www.w3.org/ns/dx/prof/>
PREFIX schema: <https://schema.org/>

[]
    a prez:Manifest ;
    prof:hasResource
        [
            prof:hasArtifact "catalogue.ttl" ;
            prof:hasRole mrr:CatalogueData ;
            schema:description "The definition of, and medata for, the container which here is a dcat:Catalog object" ;
            schema:name "Catalogue Definition"
        ] ,
        [
            prof:hasArtifact "vocabs/*.ttl" ;
            # prof:hasRole mrr:ResourceData ;
            schema:description "skos:ConceptsScheme objects in RDF (Turtle) files in the vocabs/ folder" ;
            schema:name "Content Data"
        ] ,
        [
            prof:hasArtifact "https://github.com/RDFLib/prez/blob/main/prez/reference_data/profiles/ogc_records_profile.ttl" ;
            prof:hasRole mrr:CatalogueAndResourceModel ;
            schema:description "The default Prez profile for Records API" ;
            schema:name "Profile Definition"
        ] ,
        [
            prof:hasArtifact "_background/labels.ttl" ;
            prof:hasRole mrr:CompleteCatalogueAndResourceLabels ;
            schema:description "An RDF file containing all the labels for the container content" ;
            schema:name "Labels" ;
        ] ;
.

Invalid - bad location

The third resource specifies an invalid location, the non-existent web address of https://github.com/RDFLib/prez/blob/main/prez/reference_data/profiles/ogc_records_profile.ttlx which has had an extra 'x' added at the end.

PREFIX mrr: <https://prez.dev/ManifestResourceRoles/>
PREFIX prez: <https://prez.dev/>
PREFIX prof: <http://www.w3.org/ns/dx/prof/>
PREFIX schema: <https://schema.org/>

[]
    a prez:Manifest ;
    prof:hasResource
        [
            prof:hasArtifact "catalogue.ttl" ;
            prof:hasRole mrr:CatalogueData ;
            schema:description "The definition of, and medata for, the container which here is a dcat:Catalog object" ;
            schema:name "Catalogue Definition"
        ] ,
        [
            prof:hasArtifact "vocabs/*.ttl" ;
            prof:hasRole mrr:ResourceData ;
            schema:description "skos:ConceptsScheme objects in RDF (Turtle) files in the vocabs/ folder" ;
            schema:name "Content Data"
        ] ,
        [
            prof:hasArtifact "https://github.com/RDFLib/prez/blob/main/prez/reference_data/profiles/ogc_records_profile.ttlx" ;
            prof:hasRole mrr:CatalogueAndResourceModel ;
            schema:description "The default Prez profile for Records API" ;
            schema:name "Profile Definition"
        ] ,
        [
            prof:hasArtifact "_background/labels.ttl" ;
            prof:hasRole mrr:CompleteCatalogueAndResourceLabels ;
            schema:description "An RDF file containing all the labels for the container content" ;
            schema:name "Labels" ;
        ] ;
.

mainEntity use

A snippet of a Manifest - just one value for hasResource - showing use of mainEntity and contentLocation instead of just a literal file path.

    [
        prof:hasArtifact
            [
                schema:contentLocation "vocabs/image-test.ttl" ;
                schema:mainEntity <https://example.com/demo-vocabs/image-test> ;
            ] ,
            "vocabs/language-test.ttl" ;
        prof:hasRole mrr:ResourceData ;
        schema:description "skos:ConceptScheme objects in RDF (Turtle) files in the vocabs/ folder" ;
        schema:name "Resource Data"
    ] ,

conformance claim - single

A single artifact claiming conformance to the VocPub Profile of SKOS.

    prof:hasArtifact
        [
            schema:contentLocation "vocabs/image-test.ttl" ;
            schema:mainEntity <https://example.com/demo-vocabs/image-test> ;
            dcterms:conformsTo <https://w3id.org/profile/vocpub> ;
        ] ,

conformance claim - all

A single Resource in a Manifest claiming conformance to the VocPub Profile of SKOS for all artifacts (there are 3 given).

    [
        prof:hasArtifact
            [
                schema:contentLocation "vocabs/image-test.ttl" ;
                schema:mainEntity <https://example.com/demo-vocabs/image-test> ;
            ] ,
            "vocabs/language-test.ttl" ;
            "vocabs/other-vocab.ttl" ;
        prof:hasRole mrr:ResourceData ;
        # ...
        dcterms:conformsTo <https://w3id.org/profile/vocpub> ;
    ] ,

Tools

prezmanifest

The prezmanifest command line tool and Python package, available at https://github.com/Kurrawong/prez-manifest and on PyPI, provides a number of functions to work with Prez Manifests. The functions provided are:

  • validate
    • performs SHACL validation on the Manifest, followed by existence checking for each resource - are they reachable by this script on the file system or over the Internet? Will also check any Conformance Claimsgiven in the Manifest)
  • label
    • lists all the IRIs for elements with a Manifest's Resources that don't have labels. Given a source of additional labels, such as the KurrawongAI Semantic Background, it can try to extract any missing labels and insert them into a Manifest as an additional labelling resource
  • document
    • table: can create a Markdown or ASCCIIDOC table of Resources from a Prez Manifest file for use in README files in repositories
    • catalogue: add the IRIs of resources within a Manifest's 'Resource Data' object to a catalogue RDF file
  • load
    • extract all the content of all Resources listed in a Prez Manifest and load it into either a single RDF multi-graph ('quads') file or into an RDF DB instance by using the Graph Store Protocol

See the package's repository for installation and use details.