TIBHannover · SArndt-TIB · Jan 31, 2025 · Nov 26, 2024 · Nov 26, 2024 · Nov 28, 2024
diff --git a/.github/images/form_generator-low-qual.mp4 b/.github/images/form_generator-low-qual.mp4
diff --git a/.github/images/ontology_suggestion.mp4 b/.github/images/ontology_suggestion.mp4
diff --git a/.github/images/terminology_metadata-00001.jpg b/.github/images/terminology_metadata-00001.jpg
diff --git a/.github/images/validate-metadata-low-qual.mp4 b/.github/images/validate-metadata-low-qual.mp4
diff --git a/.github/images/validate-metadata.mov b/.github/images/validate-metadata.mov
diff --git a/.github/images/validate-metadata.mp4 b/.github/images/validate-metadata.mp4
diff --git a/DummyOntoFAILS.ttl b/DummyOntoFAILS.ttl
@@ -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 .
diff --git a/DummyOntoPASSES.ttl b/DummyOntoPASSES.ttl
@@ -38,16 +38,18 @@
     dcterms:contributor <0000-0000-0000-0000> ;
     #contact data missing - won't add
     schema:funder <https://ror.org/018mejw64> ;
+    schema:funding <http://example.com/a-grant-id> ;
     doap:audience "DummyOntoPASSES has been developed for ontology engineers to demonstrate ontology metadata recommendations by TIB Terminology Service. It can be used with the TIB Terminology Service Ontology Metadata Shape in SHACL validators and should trigger no violations or warnings."@en ;
     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:references <https://example.com/some-paper-referenced-by-the-ontology> ;
     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> ;
     <http://purl.obolibrary.org/obo/IAO_0000700> <https://www.purl.org/ontologymetadata/DummyOntoPASSES#1> ;
@@ -65,7 +67,6 @@
     dcterms:type <http://w3id.org/nkos/nkostype#ontology> ;
     <http://identifiers.org/exampleIdentifier> <https://www.purl.org/ontologymetadata/DummyOntoPASSES#1> ;
     <http://identifiers.org/idot/identifierPattern> "[0-9]+" ;
-    dcterms:format <https://www.iana.org/assignments/media-types/application/rdf+xml> ;
     <http://xmlns.com/foaf/0.1/homepage> <https://purl.org/OntoMeta/home> ;
     dcterms:publisher <https://isni.org/isni/0000000121746694>, <https://d-nb.info/gnd/1080328793> ;
     rdfs:comment "Some remark about the ontology."@en ;

diff --git a/MetadataGuide.html b/MetadataGuide.html
diff --git a/MetadataGuide.md b/MetadataGuide.md
diff --git a/MetadataGuide.pdf b/MetadataGuide.pdf
diff --git a/OntoMetadataShape.ttl b/OntoMetadataShape.ttl
diff --git a/OntoMetadataShape4Forms.ttl b/OntoMetadataShape4Forms.ttl
diff --git a/OntoMetadataShape4TS.ttl b/OntoMetadataShape4TS.ttl
diff --git a/README.md b/README.md
@@ -1,24 +1,53 @@
 # Terminology Metadata Recommendations by TIB
 
-<!-- PURLs are registered, but repo is still private -->
-
 With this repository, *TIB - Leibniz Information Centre for Science and Technology University Library* provides a practical guide for metadata management of ontologies. It gives recommendations on required, recommended and optional metadata for ontologies.
 
 In particular, it addresses ontology engineers who would like to publish their ontologies on the [TIB Terminology Service](https://terminology.tib.eu/ts), the [NFDI4INg Terminology Service](https://terminology.nfdi4ing.de/ts/) or the [NFDI4Chem Terminology Service](https://terminology.nfdi4chem.de/ts/).
 
 An introduction and overview is given in the [Metadata Guide](/MetadataGuide.md).
 
-In addition, we provide SHACL shapes based on these recommendations in [OntoMetadataShape.ttl](/OntoMetadataShape.ttl) which can also be reached via <https://www.purl.org/ontologymetadata/shape>. These shapes can be used in SHACL validators and to check whether an ontology meets the recommendations. For example, the following onlin e SHACL validators are available:
+In addition, we provide SHACL shapes based on these recommendations for three different applications as documented below. The target class of these shapes is owl:Ontology, so that they can only be used to validate entities that declare themselves as an instance of owl:Ontology, and also code generated with these shapes, will declare entities as instances of owl:Ontology.
+
+This repository is archived at Zenodo: <https://www.doi.org/10.5281/zenodo.11103071>
+
+> INFO: This recommendation is still a draft. Approval and discussion by a broader communiuty are required.
+
+## Metadata recommendations in SHACL
+
+### For ontology validation by ontology engineers
+
+In addition to the [MetadataGuide.md](/MetadataGuide.md), we provide SHACL shapes based on these recommendations in [OntoMetadataShape.ttl](/OntoMetadataShape.ttl) which can also be reached via <https://www.purl.org/ontologymetadata/shape>. These shapes can be used in SHACL validators to check whether an ontology meets the recommendations.
+They are very fine-grained - each sh:PropertyShape tests a specific set of properties that may occur in an ontology. For each violated constraint, a detailed message adresses how the constraint violation may be fixed. The messages provide examples in Turtle, so that ontology engineers can easily adapt their own code to the recommendation.
+
+For example, the following online SHACL validators are available and have been tested with [OntoMetadataShape.ttl](/OntoMetadataShape.ttl):
 
 * [SHACL Playground](https://shacl.org/playground/)
 * [SHACL Playground by Zazuko](https://shacl-playground.zazuko.com/)
-* [SHACL Play!](https://shacl-play.sparna.fr/play/)
+* [SHACL Play!](https://shacl-play.sparna.fr/play/validate) (if you are new to SHACL, we recommend this online validator!)
 
-> INFO: This recommendation is still a draft. Approval and discussion by a broader communiuty are required.
+PLEASE NOTE that browser extensions (e.g. Citavi) may interfer when using such validators - they may parse the Turtle code and insert text snippets that make the code unparsable due to syntactic errors. You should switch such extensions off, if you encounter such problems!
 
-This repository is archived at Zenodo: <https://www.doi.org/10.5281/zenodo.11103071>
+See how you can use online validators with our shape:
+
+<https://github.com/user-attachments/assets/c5d6be07-3bfb-44ab-ae65-e3f75b8e883a>
+
+### For ontology validation at TIB Terminology Service
+
+In [OntoMetadataShape4TS.ttl](/OntoMetadataShape4TS.ttl) (also <https://www.purl.org/ontologymetadata/shape4ts>) we provide a version of the recommendations that is adapted to the Ontology Suggestion Feature at [TIB Terminology Service](https://terminology.tib.eu). The messages are adapted to the context of use and the particular use case: The person suggesting an ontology is not necessarily involved in its development. On TIB Terminology Service, they will be asked to provide metadata of the ontology if these are not present in the ontology, and if known to the user. These users are not required to provide the meatdata as code.
+
+See how the shape is used in the suggestion feature:
+
+<https://github.com/user-attachments/assets/847cfd39-0823-4a83-9c8a-0cf3d23d38a7>
+
+### For metadata form generators
+
+In [OntoMetadataShape4Forms.ttl](/OntoMetadataShape4Forms.ttl) (also <https://www.purl.org/ontologymetadata/shape4forms>) you find a version of the shape that is optimized for the [form generator tool by ULB Darmstadt](https://github.com/ULB-Darmstadt/shacl-form). You can try it out on their [live demo instance](https://ulb-darmstadt.github.io/shacl-form/#try-your-own).
+
+The shapes are not as granular as the ones for validation: All constraints are bundled in one shape in order to generate a form, that users can use to enter values. The user input is validated immediately for all criteria and the metadata code is generated. Only the recommended properties will be used to do so: This version of the recommendation does not make use of `sh:alternativePath` constructs, in order to generate valid RDF code with named properties, not anonymous/ blank nodes.
+
+<https://github.com/user-attachments/assets/55cdf44f-5289-4989-9014-5e670fd73418>
 
 ## Further reading and sources
 
 * Arndt, S., Borgelt, H. und Strömert, P. (2023) „FAIR Ontology Metadata - Crucial Information for Understanding, Evaluation, and Application“. 2nd Ontologies4Chem Workshop 2023 (Ontologies4Chem 2023), Zenodo, 12 Oktober. doi: 10.5281/zenodo.10117899.
-* see complete [list of sources](/MetadataGuide.md#8-sources) in the Metadata Guide
+* see complete [list of sources](/MetadataGuide.md#8-sources) in the Metadata Guide
diff --git a/TabularOverview.tsv b/TabularOverview.tsv
@@ -15,11 +15,11 @@ order number	section	metadatum	Preferred property	Mandatory	Recommended	Optional
 14	4.5	Subject(s)	<http://purl.org/dc/terms/subject>		x		0…*	true	true	false	true	false	false	true	false	true	true	true	false	false
 15	4.6	Annotation language(s)	<http://purl.org/dc/terms/language>		x		0…*	true	true	false	false	false	false	true	false	false	false	true	false	false
 16	4.7	Applied logical framework	<https://w3id.org/mod#hasFormalityLevel>		x		0...1	false	true	false	true	false	false	true	false	false	false	false	false	false
-17	4.8	Serialization/ file format	<http://omv.ontoware.org/2005/05/ontology#hasOntologySyntax>		x		0...1	true	true	false	false	false	false	true	false	false	false	true	false	false
+17	4.8	Serialization/ file format	<https://w3id.org/mod#hasSyntax>		x		0...1	true	true	false	false	false	false	true	false	false	false	true	false	false
 18	4.9	Status	<http://purl.org/ontology/bibo/status>		x		0...1	true	false	false	true	true	true	true	true	true	true	true	false	true
 19	4.10	Code repository	<http://usefulinc.com/ns/doap#repository>		x		0...1	false	true	false	true	false	false	true	false	false	true	false	true	false
 20	4.11	Distributions/ products	<http://www.w3.org/ns/dcat#distribution>		x		0…*	true	true	false	false	false	false	true	false	true	false	true	false	false
-21	4.12	Application example	<https://vocab.org/vann/example>		x		0…*	false	true	false	true	false	false	true	false	false	false	false	false	false
+21	4.12	Application example	<http://purl.org/vocab/vann/example>		x		0…*	false	true	false	true	false	false	true	false	false	false	false	false	false
 22	4.13	Related resource(s)	<http://purl.org/dc/terms/references>		x		0…*	true	true	false	false	true	true	true	false	true	true	true	true	false
 23	4.14	Citation suggestion	<http://purl.org/dc/terms/bibliographicCitation>		x		0…*	false	true	false	false	true	true	true	true	false	false	true	false	false
 24	4.15	Ontology sources (derived from)	<http://purl.org/pav/derivedFrom>		x		0…*	true	true	false	true	true	true	true	true	true	false	true	false	false