Skip to content
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.

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

Draft: Update OntoMetadataShape.ttl #7

Draft
wants to merge 88 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
1558deb
Update OntoMetadataShape.ttl
SArndt-TIB Nov 26, 2024
8d6bcce
#6 First updates after testing shapes with ontologies
SArndt-TIB Nov 26, 2024
ccdfc2f
#6 add version optimized for ULB form generator
SArndt-TIB Nov 28, 2024
cdf5326
#6 update base uri and version uri
SArndt-TIB Nov 28, 2024
07ed050
#6 Update messages (blank spaces, line breaks)
SArndt-TIB Nov 28, 2024
302138b
#6 update readme
SArndt-TIB Nov 28, 2024
4a48d62
#6 switch from omv:hasOntologySyntax to mod:hasSyntax\nadd variant of…
SArndt-TIB Nov 29, 2024
d11ea48
#6 Update versionIRI and dates for new version
SArndt-TIB Nov 29, 2024
44edeea
#6 update sh:message for title tests
SArndt-TIB Nov 29, 2024
ddf6bc4
#6 check consistency of list elements and sh:messages
SArndt-TIB Nov 29, 2024
8d48b7c
#6 add shape version for TS
SArndt-TIB Nov 29, 2024
9bf9045
#6 add recommended property back to sh:message for title
SArndt-TIB Dec 2, 2024
fa99ea0
#6 remove linebreak
SArndt-TIB Dec 2, 2024
cedb1d0
#6 add linebreak
SArndt-TIB Dec 2, 2024
02a17ed
#6 remove line break
SArndt-TIB Dec 2, 2024
b23e3f0
#6 Update
SArndt-TIB Dec 2, 2024
288c472
#6 Update
SArndt-TIB Dec 2, 2024
e92478a
#6 Update
SArndt-TIB Dec 2, 2024
8a3ed01
#6 Update
SArndt-TIB Dec 2, 2024
4cf0ff5
#6 Update
SArndt-TIB Dec 2, 2024
070709d
#6 Update
SArndt-TIB Dec 2, 2024
d7cac94
#6 Update
SArndt-TIB Dec 2, 2024
bd52649
#6 Update
SArndt-TIB Dec 2, 2024
f66958b
#6 Update
SArndt-TIB Dec 2, 2024
d482363
#6 Update
SArndt-TIB Dec 2, 2024
71a1305
#6 Update
SArndt-TIB Dec 2, 2024
bf83f2e
#6 Corrections
SArndt-TIB Dec 2, 2024
b622a8f
#6 update README with info about use cases, add screencasts
SArndt-TIB Dec 5, 2024
5b47083
#6 test
SArndt-TIB Dec 5, 2024
e5ab81b
#6 update
SArndt-TIB Dec 5, 2024
ea8ebe6
#6 resolve conflict
SArndt-TIB Dec 5, 2024
79212a7
#6 test
SArndt-TIB Dec 5, 2024
c013ef9
#6 update
SArndt-TIB Dec 5, 2024
1bcddcc
#6 update
SArndt-TIB Dec 5, 2024
4575ea0
#6 update
SArndt-TIB Dec 5, 2024
285fde3
#6 update
SArndt-TIB Dec 5, 2024
c5c2cd9
#6 update
SArndt-TIB Dec 5, 2024
78af684
#6 update
SArndt-TIB Dec 5, 2024
7dd0740
#6 Corrections
SArndt-TIB Dec 5, 2024
242e514
#6 update
SArndt-TIB Dec 5, 2024
436026d
#6 update
SArndt-TIB Dec 5, 2024
b120d56
#6 update
SArndt-TIB Dec 5, 2024
b3c0709
#6 update
SArndt-TIB Dec 5, 2024
1a97865
#6
SArndt-TIB Dec 6, 2024
8a899c2
#6
SArndt-TIB Dec 6, 2024
4a4289a
#6
SArndt-TIB Dec 6, 2024
adfb572
Update README.md
SArndt-TIB Dec 6, 2024
5567f1c
#6
SArndt-TIB Dec 6, 2024
e968d76
Merge branch '6-update-version-2024-05-02' of https://github.com/TIBH…
SArndt-TIB Dec 6, 2024
86969b2
#6
SArndt-TIB Dec 6, 2024
9219461
#6 update ts shape
SArndt-TIB Dec 10, 2024
cd4e255
#6 update
SArndt-TIB Dec 10, 2024
e1c0aca
#6 update
SArndt-TIB Dec 10, 2024
9b0d644
#6 update
SArndt-TIB Dec 10, 2024
99b327a
#6 update
SArndt-TIB Dec 10, 2024
30c39b3
#6 update
SArndt-TIB Dec 10, 2024
2e51988
#6 update
SArndt-TIB Dec 10, 2024
3849f74
#6 update
SArndt-TIB Dec 10, 2024
75a1aaf
#6 update
SArndt-TIB Dec 10, 2024
334125e
#6 update
SArndt-TIB Dec 10, 2024
baacba0
#6 update
SArndt-TIB Dec 10, 2024
3b50a7f
#6 update
SArndt-TIB Dec 10, 2024
eacc808
#6 update
SArndt-TIB Dec 10, 2024
15dcaf6
#6 update
SArndt-TIB Dec 10, 2024
9f062fd
#6 update
SArndt-TIB Dec 10, 2024
5f327c1
#6 update
SArndt-TIB Dec 10, 2024
e4be5a3
#6 update
SArndt-TIB Dec 10, 2024
09033f2
#6 update
SArndt-TIB Dec 10, 2024
aa72506
#6 update
SArndt-TIB Dec 10, 2024
b0f0bf2
#6 Corrections
SArndt-TIB Dec 10, 2024
a23863e
#6 formatting for ts
SArndt-TIB Dec 10, 2024
7d06aec
#6 formatting for ts
SArndt-TIB Dec 10, 2024
4a212f8
#6 formatting for ts
SArndt-TIB Dec 10, 2024
b77ec1d
#6 formatting for ts
SArndt-TIB Dec 10, 2024
4ab069f
#6 formatting for ts
SArndt-TIB Dec 10, 2024
eab9f0f
#6 formatting for ts
SArndt-TIB Dec 10, 2024
2440ef8
#6 formatting for ts
SArndt-TIB Dec 11, 2024
85e42b1
#6 formatting for ts
SArndt-TIB Dec 11, 2024
488dca7
#6 formatting for ts
SArndt-TIB Dec 11, 2024
45353c6
#6 formatting for ts
SArndt-TIB Dec 11, 2024
29e70df
#6 formatting for ts
SArndt-TIB Dec 11, 2024
e0b9405
#6 formatting for ts
SArndt-TIB Dec 11, 2024
3e5fce6
#6 formatting for ts
SArndt-TIB Dec 11, 2024
94d84c6
Update README.md
SArndt-TIB Dec 11, 2024
389783c
#6 add screencast form generator
SArndt-TIB Dec 11, 2024
4b9e62a
#6 corrections (vann namespace), removal of redundant lines, update o…
SArndt-TIB Dec 12, 2024
fa5bc30
#6 update version iri
SArndt-TIB Dec 12, 2024
e468a9e
Update README.md
SArndt-TIB Jan 2, 2025
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
Binary file added .github/images/form_generator-low-qual.mp4
Binary file not shown.
Binary file added .github/images/terminology_metadata-00001.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/images/validate-metadata-low-qual.mp4
Binary file not shown.
Binary file added .github/images/validate-metadata.mov
Binary file not shown.
Binary file added .github/images/validate-metadata.mp4
Binary file not shown.
3 changes: 2 additions & 1 deletion DummyOntoFAILS.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@


<https://www.purl.org/ontologymetadata/DummyOntoFAILS> rdf:type owl:Ontology ;
dcterms:license <https://creativecommons.org/licenses/by-nd/3.0/de/legalcode>.
dcterms:license <https://creativecommons.org/licenses/by-nd/3.0/de/legalcode> ;
dcterms:creator "John Doe" .

<https://www.purl.org/ontologymetadata/DummyOntoFAILS#1> a owl:Class .
4 changes: 2 additions & 2 deletions DummyOntoPASSES.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,11 @@
dcterms:subject <https://purl.org/linsearch/inf> ;
schema:inLanguage <https://id.loc.gov/vocabulary/iso639-2/deu> ;
mod:hasFormalityLevel "The DummyOntoPASSES aplies OWL2 EL (cf. https://www.w3.org/TR/2012/REC-owl2-profiles-20121211/#OWL_2_EL)"@en ;
<http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax> <http://www.w3.org/ns/formats/Turtle> ;
<https://w3id.org/mod#hasSyntax> <http://www.w3.org/ns/formats/Turtle> ;
<http://purl.org/ontology/bibo/status> "active"@en ;
doap:repository <https://github.com/StroemPhi/Ontology-Metadata> ;
<http://www.w3.org/ns/dcat#distribution> <https://www.purl.org/ontologymetadata/DummyOntoPASSES.owl> ;
<https://vocab.org/vann/example> <https://www.purl.org/ontologymetadata/DummyOntoPASSES/docs/descriptionOfUse> ;
<http://purl.org/vocab/vann/example> <https://www.purl.org/ontologymetadata/DummyOntoPASSES/docs/descriptionOfUse> ;
dcterms:isReferencedBy <https://zenodo.org/record/0000000> ;
dcterms:bibliographicCitation "TIB (2023): DummyOntoPASSES. An ontology demonstrating rich ontology metadata. PURL: https://www.purl.org/ontologymetadata/DummyOntoPASSES."@en ;
pav:derivedFrom <http://www.purl.org/SomeOtherOntology/0.0.1> ;
Expand Down
35 changes: 22 additions & 13 deletions MetadataGuide.html
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@
</script>
<h1 id="ontology-metadata-recommendations-by-tib">Ontology metadata recommendations by TIB</h1>
<p>Document status: <strong>DRAFT</strong></p>
<p>Modification date: 2024-05-02</p>
<p>Modification date: 2025-01-01</p>
<p>Creators and contributors:</p>
<!-- * [Last name, First Name (Affiliation)](https://orcid.org/) -->
<ul>
Expand All @@ -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 @@ -962,7 +963,7 @@ <h3 id="47-applied-logical-framework">4.7 Applied logical framework</h3>
</ul>
<h3 id="48-ontology-serialization-file-format">4.8 Ontology serialization/ file format</h3>
<p>You should state the ontology's serialization/ file format. The value should be provided as an IRI from the Media Types list of the Internet Assigned Number Authority (IANA) <a href="#source6">[6]</a> or from the W3C resource Unique URIs for File Formats <a href="#source7">[7]</a>.</p>
<p>Recommended property: <a href="http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax">http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax</a></p>
<p>Recommended property: <a href="https://w3id.org/mod#hasSyntax">https://w3id.org/mod#hasSyntax</a></p>
<p>Recommended controlled vocabularies:</p>
<ul>
<li><a href="https://www.w3.org/ns/formats">https://www.w3.org/ns/formats</a></li>
Expand All @@ -977,13 +978,14 @@ <h3 id="48-ontology-serialization-file-format">4.8 Ontology serialization/ file
<p>Currently, there is no registered media type for obo format.</p>
<p>Example (text/turtle):</p>
<pre class="hljs"><code><div>&lt;https://www.purl.org/SomeOntology&gt; rdf:type owl:Ontology ;
omv:hasOntologySyntax &lt;http://www.w3.org/ns/formats/Turtle&gt; .
&lt;https://w3id.org/mod#hasSyntax&gt; &lt;http://www.w3.org/ns/formats/Turtle&gt; .
</div></code></pre>
<p>Alternative properties:</p>
<ul>
<li><a href="http://purl.org/dc/terms/format">http://purl.org/dc/terms/format</a></li>
<li><a href="http://purl.org/dc/elements/1.1/format">http://purl.org/dc/elements/1.1/format</a></li>
<li><a href="https://schema.org/encodingFormat">https://schema.org/encodingFormat</a></li>
<li><a href="http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax">http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax</a></li>
</ul>
<p>SHACL validation rules:</p>
<ul>
Expand Down Expand Up @@ -1043,7 +1045,7 @@ <h3 id="411-ontology-distributions-products">4.11 Ontology distributions/ produc
</ul>
<h3 id="412-application-example">4.12 Application example</h3>
<p>How to use an ontology is often helpfully demonstrated by application examples and visualizations that give a glimpse about how the ontology can be used to structure actual data. If you have such application examples, these might be better found, if you link to them from the ontology. These application examples could be part of the ontology documentation, formal serializations applying the ontology or even technical applications that make use of the ontology.</p>
<p>Recommended property: <a href="https://vocab.org/vann/example">https://vocab.org/vann/example</a></p>
<p>Recommended property: <a href="http://purl.org/vocab/vann/example">http://purl.org/vocab/vann/example</a></p>
<p>Example (text/turtle):</p>
<pre class="hljs"><code><div>&lt;http://www.w3.org/ns/dcat&gt; rdf:type owl:Ontology ;
vann:example &lt;https://www.w3.org/TR/vocab-dcat-2/#collection-of-examples&gt; .
Expand Down Expand Up @@ -1098,7 +1100,7 @@ <h3 id="415-ontology-sources-derived-from">4.15 Ontology sources (derived from)<
<li><code>sh:nodeKind sh:IRI</code></li>
</ul>
<h3 id="416-ontology-root-classes">4.16 Ontology root classes</h3>
<p>You should explicitly declare the ontology's preferred root classes. Display tools like the <a href="https://terminology.tib.eu/ts" title="TIB Terminology Service. URL: https://terminology.tib.eu/. Last accessed: 22 April 2024.">TIB Terminology Service</a> and other OLS-based services <a href="#source9">[9]</a>, <a href="#source10">[10]</a> can pick specific, user-defined classes for rendering the ontology class hierarchy. This is especially helpful, when an ontology imports a lot of classes from other ontologies. The repsective classes need to be provided via their identifier.</p>
<p>You should explicitly declare the ontology's preferred root classes. Display tools like the <a href="https://terminology.tib.eu/ts" title="TIB Terminology Service. URL: https://terminology.tib.eu/. Last accessed: 22 April 2024.">TIB Terminology Service</a> and other OLS-based services <a href="#source9">[9]</a>, <a href="#source10">[10]</a> can pick specific, user-defined classes for rendering the ontology class hierarchy. This is especially helpful, when an ontology imports a lot of classes from other ontologies. The respective classes need to be provided via their identifier.</p>
<p>Recommended property: <a href="http://purl.obolibrary.org/obo/IAO_0000700">http://purl.obolibrary.org/obo/IAO_0000700</a></p>
<p>Example (text/turtle):</p>
<pre class="hljs"><code><div>&lt;https://www.purl.org/SomeOntology&gt; rdf:type owl:Ontology ;
Expand Down Expand Up @@ -1371,8 +1373,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 +1384,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 +1505,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 +1515,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 All @@ -1530,7 +1539,7 @@ <h3 id="524-version-notes">5.24 Version notes</h3>
</div></code></pre>
<p>Alternative properties:</p>
<ul>
<li><a href="https://vocab.org/vann/changes">https://vocab.org/vann/changes</a></li>
<li><a href="http://purl.org/vocab/vann/changes">http://purl.org/vocab/vann/changes</a></li>
</ul>
<p>SHACL validation rules:</p>
<ul>
Expand Down Expand Up @@ -1699,7 +1708,7 @@ <h2 id="6-tabular-overview">6 Tabular overview</h2>
<tr>
<td>4.8</td>
<td>Serialization/ file format</td>
<td><a href="http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax">http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax</a></td>
<td><a href="https://w3id.org/mod#hasSyntax">https://w3id.org/mod#hasSyntax</a></td>
<td></td>
<td>x</td>
<td></td>
Expand Down Expand Up @@ -1735,7 +1744,7 @@ <h2 id="6-tabular-overview">6 Tabular overview</h2>
<tr>
<td>4.12</td>
<td>Application example</td>
<td><a href="https://vocab.org/vann/example">https://vocab.org/vann/example</a></td>
<td><a href="http://purl.org/vocab/vann/example">http://purl.org/vocab/vann/example</a></td>
<td></td>
<td>x</td>
<td></td>
Expand Down
Loading