nfdi4cat / voc4cat

A SKOS vocabulary for catalysis maintained by NFDI4Cat & friends
https://nfdi4cat.github.io/voc4cat/
Creative Commons Zero v1.0 Universal
10 stars 8 forks source link

IRI-design #9

Closed dalito closed 1 year ago

dalito commented 1 year ago

This information about our ID/IRI-policy has still to be integrated in the documentation.:

IRIs of the vocabulary

The general IRI of the vocabulary (the SKOS-file) will have the following form:

https://w3id.org/nfdi4cat/[IDSPACE]/releases/YYYY-MM-DD/[IDSPACE].ttl
or
https://w3id.org/nfdi4cat/[IDSPACE].ttl

The latest released version will be accessible at the root level https://w3id.org/nfdi4cat/. All that is also older releases are accessible under https://w3id.org/nfdi4cat/[IDSPACE]/releases/. Releases use the release date in iso-format as version specifier.

The [IDSPACE]-key for this vocabulary is "voc4cat". The IDSPACE-key is what distinguishes it from other vocabularies. The term IDSPACE is taken from obofoundry.

IRIs of elements in the vocabulary

The general IRI for a concrete element is

https://w3id.org/nfdi4cat/[IDSPACE]/releases/YYYY-MM-DD/[IDSPACE]_[ID]
or
https://w3id.org/nfdi4cat/[IDSPACE]_[ID]

[ID] stands for the ID of the concept/collection in the vocabulary. In voc4cat it is an integer that is left-padded with zeros to a total length of seven digits. For example, the IRI for a concept with the ID of 123 is

https://w3id.org/nfdi4cat/voc4cat_0000123

Compact IRI notation (CURIE)

The preferred CURIE notation is to use the IDRANGE as prefix. For example, the IRI

https://w3id.org/nfdi4cat/voc4cat_0000123

would be written in CURIE-form as

voc4cat:0000123.

Here the prefix voc4cat stands for https://w3id.org/nfdi4cat/voc4cat_.

This style matches OBOs, where for example http://purl.obolibrary.org/obo/RO_0002202 is typically written as CURIE "RO:0002202", see https://obofoundry.org/id-policy.html

dalito commented 1 year ago

Documentation about the general IRI design in voc4cat-template based vocabularies has been added in https://github.com/nfdi4cat/voc4cat-template/pull/31