Skip to content

Align namespaces; remove conventions from README #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zyzzyxdonta merged 1 commit into from
Jan 20, 2026
Merged

Align namespaces; remove conventions from README #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <https://doi.org/10.5063/schema/codemeta-2.0#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
```

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:
Expand Down
18 changes: 6 additions & 12 deletions docs/specification/conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,28 +17,22 @@ RDF examples use the following namespace prefixes (this declaration is omitted f

```turtle
@prefix codemeta: <https://doi.org/10.5063/schema/codemeta-2.0#> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementations/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
```

**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

Expand Down
6 changes: 3 additions & 3 deletions examples/components/orcid.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/data/hermes.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/_collection.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/authors-affiliation.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/authors.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/description-parameterizable.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/helmholtz-codebase.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/license.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/licenses-parameterizable.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions examples/policies/semantic-versioning.ttl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01-01/implementation/#> .
@prefix sc: <https://schema.software-metadata.pub/software-card/2025-01/#> .
@prefix scex: <https://schema.software-metadata.pub/software-card/2025-01/examples/#> .
@prefix scimpl: <https://schema.software-metadata.pub/software-card/2025-01/implementation/#> .
@prefix schema: <https://schema.org/> .
@prefix sh: <http://www.w3.org/ns/shacl#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
Expand Down
6 changes: 3 additions & 3 deletions src/software_card_policies/namespaces.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -32,15 +32,15 @@ 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/#"
)


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/#"
)


Expand Down
Loading
⚡