Skip to content

Commit

Permalink
#6 First updates after testing shapes with ontologies
Browse files Browse the repository at this point in the history
  • Loading branch information
SArndt-TIB committed Nov 26, 2024
1 parent 1558deb commit 8d6bcce
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 11 deletions.
18 changes: 13 additions & 5 deletions MetadataGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ <h1 id="ontology-metadata-recommendations-by-tib">Ontology metadata recommendati
<li><a href="https://orcid.org/0000-0002-1595-3213">Strömert, Philip (Technische Informationsbibliothek)</a></li>
<li><a href="https://orcid.org/0000-0002-8280-0487">Vogt, Lars (Technische Informationsbibliothek)</a></li>
</ul>
<p>License: <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0 Deed Attribution 4.0 International </a></p>
<p>License: <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0 Deed Attribution 4.0 International</a></p>
<p>Zenodo archive: <a href="https://www.doi.org/10.5281/zenodo.11103071">https://www.doi.org/10.5281/zenodo.11103071</a></p>
<div style="page-break-after: always;"></div>
<h2 id="table-of-contents">Table of contents</h2>
Expand Down Expand Up @@ -453,7 +453,7 @@ <h2 id="table-of-contents">Table of contents</h2>
<li><a href="#512-example-ontology-class">5.12 Example ontology class</a></li>
<li><a href="#513-ontology-mailing-list">5.13 Ontology mailing list</a></li>
<li><a href="#514-ontology-logo-depiction-related-visualizations">5.14 Ontology logo/ depictions/ related visualization</a></li>
<li><a href="#515-related-identifiers">5.15 Related identifiers</a></li>
<li><a href="#515-alternative-identifiers-of-the-ontology">5.15 Alternative identifiers of the ontology</a></li>
<li><a href="#516-development-environment">5.16 Development environment</a></li>
<li><a href="#517-alignments-mappings">5.17 Alignments/ mappings</a>
<ul>
Expand Down Expand Up @@ -691,6 +691,7 @@ <h3 id="33-ontology-license">3.3 Ontology license</h3>
<li><a href="https://schema.org/license">https://schema.org/license</a></li>
<li><a href="http://creativecommons.org/ns#license">http://creativecommons.org/ns#license</a></li>
<li><a href="http://dbpedia.org/ontology/license">http://dbpedia.org/ontology/license</a></li>
<li><a href="http://purl.org/dc/terms/licence">http://purl.org/dc/terms/licence</a> (is a mis-spelled variant of <a href="http://purl.org/dc/terms/license">http://purl.org/dc/terms/license</a>)</li>
</ul>
<p>SHACL validation rules:</p>
<ul>
Expand Down Expand Up @@ -1371,8 +1372,8 @@ <h3 id="514-ontology-logo-depiction-related-visualizations">5.14 Ontology logo/
<ul>
<li><code>sh:nodeKind sh:IRI</code></li>
</ul>
<h3 id="515-related-identifiers">5.15 Related identifiers</h3>
<p>If your ontology has been published at an archive, you may want to declare these related identifiers in the ontology metadata.</p>
<h3 id="515-alternative-identifiers-of-the-ontology">5.15 Alternative identifiers of the ontology</h3>
<p>If your ontology has been published at an archive, you may want to declare these related identifiers in the ontology metadata. You should list here alternative URIs that may be used to identify your ontology. The identifier used as the base URI of the ontology should be provided with <a href="http://purl.org/vocab/vann/preferredNamespaceUri">http://purl.org/vocab/vann/preferredNamespaceUri</a> instead (cf. <a href="#520-preferred-ontology-namespace">5.20 Preferred ontology namespace</a>).</p>
<p>Recommended property: <a href="http://purl.org/dc/terms/identifier">http://purl.org/dc/terms/identifier</a></p>
<p>Example (text/turtle):</p>
<pre class="hljs"><code><div>&lt;https://www.purl.org/SomeOntology&gt; rdf:type owl:Ontology ;
Expand All @@ -1382,6 +1383,7 @@ <h3 id="515-related-identifiers">5.15 Related identifiers</h3>
<ul>
<li><a href="http://purl.org/ontology/bibo/doi">http://purl.org/ontology/bibo/doi</a></li>
<li><a href="https://schema.org/identifier">https://schema.org/identifier</a></li>
<li><a href="http://purl.org/dc/elements/1.1/identifier">http://purl.org/dc/elements/1.1/identifier</a>&gt;</li>
</ul>
<p>SHACL validation rules:</p>
<ul>
Expand Down Expand Up @@ -1502,6 +1504,7 @@ <h3 id="522-modification-date">5.22 Modification date</h3>
</ul>
<h3 id="523-textual-version-information">5.23 Textual version information</h3>
<p>Some ontologies make use of semantic versioning and employ strings like 1.0.0 as a tag to distinguish one version of their ontology from a successor. Others employ the modification date, e.g. 2022-12-21. If you use such textual version information but do not use/have a Version URI, then we strongly recommend to also mint a version URI in which you use the textual version information as variable.</p>
<p>If you need to add a larger comment in natural language, you should provide the info as an rdf:langString, i.e. with a language tag. We do not encourage this, since such statements can most likely be expressed in more granular fashion with formal statements. Alternatively, you could add the info to the version notes (cf. <a href="#524-version-notes">5.24 Version notes</a>).</p>
<p>Recommended property: <a href="http://www.w3.org/2002/07/owl#versionInfo">http://www.w3.org/2002/07/owl#versionInfo</a></p>
<p>Example 1 (text/turtle):</p>
<pre class="hljs"><code><div>&lt;https://www.purl.org/SomeOntology&gt; rdf:type owl:Ontology ;
Expand All @@ -1511,13 +1514,18 @@ <h3 id="523-textual-version-information">5.23 Textual version information</h3>
<pre class="hljs"><code><div>&lt;https://www.purl.org/SomeOntology&gt; rdf:type owl:Ontology ;
owl:versionInfo &quot;1.0.0&quot;^^xsd:string .
</div></code></pre>
<p>Example 3 (text/turtle)
:</p>
<pre class="hljs"><code><div>&lt;https://www.purl.org/SomeOntology&gt; rdf:type owl:Ontology ;
owl:versionInfo &quot;Ontology version 1.0.0 of the subject classification in tabular format from Nov 2024.&quot;@en.
</div></code></pre>
<p>Alternative properties:</p>
<ul>
<li><a href="http://purl.org/pav/version">http://purl.org/pav/version</a></li>
</ul>
<p>SHACL validation rules:</p>
<ul>
<li><code>sh:datatype xsd:string</code></li>
<li><code>sh:xone ([sh:datatype xsd:string ;] [sh:datatype rdf:langString ;])</code></li>
<li><code>sh:maxCount 1</code></li>
</ul>
<h3 id="524-version-notes">5.24 Version notes</h3>
Expand Down
22 changes: 17 additions & 5 deletions MetadataGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Creators and contributors:
* [Strömert, Philip (Technische Informationsbibliothek)](https://orcid.org/0000-0002-1595-3213)
* [Vogt, Lars (Technische Informationsbibliothek)](https://orcid.org/0000-0002-8280-0487)

License: [CC BY 4.0 Deed Attribution 4.0 International ](https://creativecommons.org/licenses/by/4.0/)
License: [CC BY 4.0 Deed Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/)

Zenodo archive: <https://www.doi.org/10.5281/zenodo.11103071>

Expand Down Expand Up @@ -76,7 +76,7 @@ Zenodo archive: <https://www.doi.org/10.5281/zenodo.11103071>
* [5.12 Example ontology class](#512-example-ontology-class)
* [5.13 Ontology mailing list](#513-ontology-mailing-list)
* [5.14 Ontology logo/ depictions/ related visualization](#514-ontology-logo-depiction-related-visualizations)
* [5.15 Related identifiers](#515-related-identifiers)
* [5.15 Alternative identifiers of the ontology](#515-alternative-identifiers-of-the-ontology)
* [5.16 Development environment](#516-development-environment)
* [5.17 Alignments/ mappings](#517-alignments-mappings)
* [5.17.1 Aligned resources](#5171-aligned-resources)
Expand Down Expand Up @@ -268,6 +268,7 @@ Alternative properties:
* <https://schema.org/license>
* <http://creativecommons.org/ns#license>
* <http://dbpedia.org/ontology/license>
* <http://purl.org/dc/terms/licence> (is a mis-spelled variant of <http://purl.org/dc/terms/license>)

SHACL validation rules:

Expand Down Expand Up @@ -1235,9 +1236,9 @@ SHACL validation rules:

* `sh:nodeKind sh:IRI`

### 5.15 Related identifiers
### 5.15 Alternative identifiers of the ontology

If your ontology has been published at an archive, you may want to declare these related identifiers in the ontology metadata.
If your ontology has been published at an archive, you may want to declare these related identifiers in the ontology metadata. You should list here alternative URIs that may be used to identify your ontology. The identifier used as the base URI of the ontology should be provided with <http://purl.org/vocab/vann/preferredNamespaceUri> instead (cf. [5.20 Preferred ontology namespace](#520-preferred-ontology-namespace)).

Recommended property: <http://purl.org/dc/terms/identifier>

Expand All @@ -1252,6 +1253,7 @@ Alternative properties:

* <http://purl.org/ontology/bibo/doi>
* <https://schema.org/identifier>
* <http://purl.org/dc/elements/1.1/identifier>>

SHACL validation rules:

Expand Down Expand Up @@ -1432,6 +1434,8 @@ SHACL validation rules:

Some ontologies make use of semantic versioning and employ strings like 1.0.0 as a tag to distinguish one version of their ontology from a successor. Others employ the modification date, e.g. 2022-12-21. If you use such textual version information but do not use/have a Version URI, then we strongly recommend to also mint a version URI in which you use the textual version information as variable.

If you need to add a larger comment in natural language, you should provide the info as an rdf:langString, i.e. with a language tag. We do not encourage this, since such statements can most likely be expressed in more granular fashion with formal statements. Alternatively, you could add the info to the version notes (cf. [5.24 Version notes](#524-version-notes)).

Recommended property: <http://www.w3.org/2002/07/owl#versionInfo>

Example 1 (text/turtle):
Expand All @@ -1448,13 +1452,21 @@ Example 2 (text/turtle):
owl:versionInfo "1.0.0"^^xsd:string .
```

Example 3 (text/turtle)
:

```Turtle
<https://www.purl.org/SomeOntology> rdf:type owl:Ontology ;
owl:versionInfo "Ontology version 1.0.0 of the subject classification in tabular format from Nov 2024."@en.
```

Alternative properties:

* <http://purl.org/pav/version>

SHACL validation rules:

* `sh:datatype xsd:string`
* `sh:xone ([sh:datatype xsd:string ;] [sh:datatype rdf:langString ;])`
* `sh:maxCount 1`

### 5.24 Version notes
Expand Down
Binary file modified MetadataGuide.pdf
Binary file not shown.
2 changes: 1 addition & 1 deletion OntoMetadataShape.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ ontometa:OntologyMetadataShape a sh:NodeShape ;
] ;

sh:property [
sh:path [sh:alternativePath (dcterms:license dcterms:rights schema:license cc:license dbo:license)] ;
sh:path [sh:alternativePath (dcterms:license dcterms:rights schema:license cc:license dbo:license <http://purl.org/dc/terms/licence>)] ;
sh:severity sh:Warning ;
# tbd/todo: add further licenses to the list of unaccepted licenses?
# tbd/todo: discuss > redundant test?
Expand Down

0 comments on commit 8d6bcce

Please sign in to comment.