diff --git a/README.md b/README.md index 663132b..b4058bb 100644 --- a/README.md +++ b/README.md @@ -53,37 +53,6 @@ working directory: - `debug-shapes-processed.ttl`: the parameterized and combined policies - `debug-validation-report.ttl`: the detailed SHACL validation report (`sh:ValidationReport`) -## Conventions - -All examples in this repository use the following namespace prefix bindings: - -```turtle -@prefix codemeta: . -@prefix owl: . -@prefix rdf: . -@prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . -@prefix schema: . -@prefix sh: . -@prefix xsd: . -``` - -For Software CaRD, the prefixes -[`sc:`](https://schema.software-metadata.pub/software-card/2025-01-01/#), -[`scex:`](https://schema.software-metadata.pub/software-card/2025-01-01/examples/#), and -[`scimpl:`](https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#) -were established and are used for the following purposes: - -- `sc:` contains terms exposed to users -- `scex:` contains example uses of `sc:` and `sh:` terms -- `scimpl:` contains internal implementation details - -The associated IRIs currently don't exist. -A [search on prefix.cc](https://prefix.cc/sc) reveals prior usage of the prefix `sc:` by projects which seem to be -defunct. - ## Documentation To build the documentation, install the package including the `docs` extra: diff --git a/docs/specification/conventions.md b/docs/specification/conventions.md index 53798da..58081f7 100644 --- a/docs/specification/conventions.md +++ b/docs/specification/conventions.md @@ -17,28 +17,22 @@ RDF examples use the following namespace prefixes (this declaration is omitted f ```turtle @prefix codemeta: . +@prefix owl: . @prefix rdf: . @prefix rdfs: . @prefix sc: . @prefix scex: . -@prefix scimpl: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . ``` -**Namespace Purposes:** - -- `sc:` - Core Software CaRD vocabulary for features like parameterization -- `scex:` - Example policies and data -- `scimpl:` - Implementations, e.g. SHACL Constraints -- `sh:` - SHACL vocabulary for defining validation shapes -- `schema:` - Schema.org vocabulary for software metadata -- `codemeta:` - CodeMeta extensions to Schema.org -- `xsd:` - XML Schema datatypes -- `rdf:` and `rdfs:` - Core RDF and RDF schema vocabularies - +For Software CaRD, these prefixes were established: +- [`sc:`](https://schema.software-metadata.pub/software-card/2025-01/#) - Core Software CaRD vocabulary exposed to the users +- [`scex:`](https://schema.software-metadata.pub/software-card/2025-01/examples/#) - Example policies and data +- [`scimpl:`](https://schema.software-metadata.pub/software-card/2025-01/implementation/#) - Implementation details ## Glossary diff --git a/examples/components/orcid.ttl b/examples/components/orcid.ttl index 9708986..1eeed63 100644 --- a/examples/components/orcid.ttl +++ b/examples/components/orcid.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/data/hermes.ttl b/examples/data/hermes.ttl index 31900e6..fc6ebab 100644 --- a/examples/data/hermes.ttl +++ b/examples/data/hermes.ttl @@ -11,9 +11,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/_collection.ttl b/examples/policies/_collection.ttl index db7cae6..e001a90 100644 --- a/examples/policies/_collection.ttl +++ b/examples/policies/_collection.ttl @@ -8,9 +8,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/authors-affiliation.ttl b/examples/policies/authors-affiliation.ttl index fb8bad6..1043b50 100644 --- a/examples/policies/authors-affiliation.ttl +++ b/examples/policies/authors-affiliation.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/authors.ttl b/examples/policies/authors.ttl index 3ef8ae5..71ab66d 100644 --- a/examples/policies/authors.ttl +++ b/examples/policies/authors.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/description-parameterizable.ttl b/examples/policies/description-parameterizable.ttl index 6ebf0fc..6225d83 100644 --- a/examples/policies/description-parameterizable.ttl +++ b/examples/policies/description-parameterizable.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/helmholtz-codebase.ttl b/examples/policies/helmholtz-codebase.ttl index e4cf29d..3ad055a 100644 --- a/examples/policies/helmholtz-codebase.ttl +++ b/examples/policies/helmholtz-codebase.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/license.ttl b/examples/policies/license.ttl index d604572..3f413f1 100644 --- a/examples/policies/license.ttl +++ b/examples/policies/license.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/licenses-parameterizable.ttl b/examples/policies/licenses-parameterizable.ttl index 951bbf9..4797be8 100644 --- a/examples/policies/licenses-parameterizable.ttl +++ b/examples/policies/licenses-parameterizable.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/examples/policies/semantic-versioning.ttl b/examples/policies/semantic-versioning.ttl index 2703899..989a95a 100644 --- a/examples/policies/semantic-versioning.ttl +++ b/examples/policies/semantic-versioning.ttl @@ -6,9 +6,9 @@ @prefix owl: . @prefix rdf: . @prefix rdfs: . -@prefix sc: . -@prefix scex: . -@prefix scimpl: . +@prefix sc: . +@prefix scex: . +@prefix scimpl: . @prefix schema: . @prefix sh: . @prefix xsd: . diff --git a/src/software_card_policies/namespaces.py b/src/software_card_policies/namespaces.py index 0665246..3556ec9 100644 --- a/src/software_card_policies/namespaces.py +++ b/src/software_card_policies/namespaces.py @@ -9,7 +9,7 @@ class SC(DefinedNamespace): """The Software CaRD schema.""" - _NS = Namespace("https://schema.software-metadata.pub/software-card/2025-01-01/#") + _NS = Namespace("https://schema.software-metadata.pub/software-card/2025-01/#") #: A "placeholder" parameter to be used in a policy Parameter: URIRef @@ -32,7 +32,7 @@ class SCIMPL(DefinedNamespace): """Software CaRD implementation details.""" _NS = Namespace( - "https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#" + "https://schema.software-metadata.pub/software-card/2025-01/implementation/#" ) @@ -40,7 +40,7 @@ class SCEX(DefinedNamespace): """Software CaRD example components.""" _NS = Namespace( - "https://schema.software-metadata.pub/software-card/2025-01-01/examples/#" + "https://schema.software-metadata.pub/software-card/2025-01/examples/#" )