Skip to content

Commit

Permalink
Fix #592 Fix #607 Fix part of #614 Fixed part of #544
Browse files Browse the repository at this point in the history
  • Loading branch information
@dgarijo
dgarijo committed Aug 21, 2023
1 parent b558364 commit ace1929
Show file tree
Hide file tree
Showing 31 changed files with 551 additions and 266 deletions.
30 changes: 17 additions & 13 deletions doc/bestPractices/index-en.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,15 @@
<body>
<div class="container"><div class="head">
<h1>A checklist for complete vocabulary metadata</h1>
<h2>25 April 2017</h2>
<h2>19 August 2023</h2>
<dl>
<dt>This version:</dt>
<dd><a href="https://w3id.org/widoco/bestPractices">https://w3id.org/widoco/bestPractices</a></dd>
</dl>
<dt>Revision:</dt>
<dd>1.0.1</dd>
<dd>1.0.2</dd>
<dt>Previous version:</dt>
<dd><a href="https://github.com/dgarijo/Widoco/blob/v1.4.19/doc/bestPractices/index-en.html">Archived at GitHub</a></dd>
<dl><dt>Author:</dt>
<dd><a href="https://w3id.org/people/dgarijo">Daniel Garijo</a>, Ontology Engineering Group, Universidad Politecnica de Madrid</dd>
<dd><a href="http://delicias.dia.fi.upm.es/~mpoveda/">María Poveda-Villalón</a>, Ontology Engineering Group, Universidad Politecnica de Madrid</dd></dl>
Expand All @@ -83,7 +85,7 @@ <h2>25 April 2017</h2>
<img src="http://i.creativecommons.org/l/by/2.0/88x31.png" style="border-width:0" alt="License"></img>
</a>
<br/></dd></dl><dl><dt>Cite as:</dt>
<dd>Daniel Garijo and María Poveda-Villalón. A checklist for complete vocabulary metadata. URL: <a href="https://w3id.org/widoco/bestPractices">https://w3id.org/widoco/bestPractices</a></dd>
<dd>Daniel Garijo, María Poveda-Villalón. A checklist for complete vocabulary metadata. URL: <a href="https://w3id.org/widoco/bestPractices">https://w3id.org/widoco/bestPractices</a></dd>
</dl>
<hr/>
</div>
Expand All @@ -99,15 +101,17 @@ <h2>25 April 2017</h2>
<div id="references">
<h2 id="ref" class="list">References <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<ul>
<li id="AGROVOC"><strong>[AGROPORTAL]</strong>: Agroportal web page. Accessible from <a href="https://htmlpreview.github.io/?https://github.com/agroportal/documentation/blob/master/metadata/Metadata%20for%20AgroPortal.html">https://htmlpreview.github.io/?https://github.com/agroportal/documentation/blob/master/metadata/Metadata%20for%20AgroPortal.html</a></li>
<li id="smart"><strong>[Garc&iacute;a-Castro et al 2015]</strong>: Ra&uacute;l Garc&iacute;a-Castro (UPM), Mar&iacute;a Poveda-Villal&oacute;n (UPM), Filip Radulovic (UPM), Asunci&oacute;n G&oacute;mez-P&eacute;rez (UPM) and Jérome Euzenat. Deliverable D3.1: Strategy for Energy Measurement and Interoperability. Acessible from <a href="ftp://ftp.inrialpes.fr/pub/exmo/reports/r4sc-31.pdf">ftp://ftp.inrialpes.fr/pub/exmo/reports/r4sc-31.pdf</a></li>
<li id="LODE"><strong>[LODE]</strong>: Silvio Peroni. Live OWL Documentation Environment web page. Accessible from <a href="http://www.essepuntato.it/lode">http://www.essepuntato.it/lode</a></li>
<li id="RFC2119">
<strong>[RFC2119]</strong>
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
</li>
<li id="soft"><strong>[Smith et al 2016]</strong>: Smith AM, Katz DS, Niemeyer KE, FORCE11 Software Citation Working Group. (2016) Software Citation Principles. PeerJ Computer Science 2:e86. DOI: 10.7717/peerj-cs.86</li>
<li id="LOV"><strong>[Vandenbussche and Batant 2012]</strong>: Pierre-Yves Vandenbussche and Bernard Vatant. Metadata Recommendations For Linked Open Data Vocabularies. Accessible from <a href="https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf">https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf</a> </li>
<li id="AGROVOC"><strong>[AGROPORTAL]</strong>: Agroportal web page. Accessible from <a href="https://htmlpreview.github.io/?https://github.com/agroportal/documentation/blob/master/metadata/Metadata%20for%20AgroPortal.html">https://htmlpreview.github.io/?https://github.com/agroportal/documentation/blob/master/metadata/Metadata%20for%20AgroPortal.html</a></li>
<li id="jonquet"><strong>[Dutta et al. 2021]</strong>: Dutta, B., Toulet, A., Emonet, V. and Jonquet, C. (2017). New Generation Metadata vocabulary for Ontology Description and Publication. In E. Garoufallou, S. Virkus, R. Siatri and D. Koutsomiha (Eds.) Communications in Computer and Information Science (CCIS) 755, proceedings of 11th Metadata and Semantics Research Conference (MTSR 2017), November 28 - December 1, 2017, Tallinn, Estonia, Springer Nature, pp. 173-185. Accessible from <a href="https://w3id.org/mod">https://w3id.org/mod</a></li>
<li id="smart"><strong>[Garc&iacute;a-Castro et al 2015]</strong>: Ra&uacute;l Garc&iacute;a-Castro (UPM), Mar&iacute;a Poveda-Villal&oacute;n (UPM), Filip Radulovic (UPM), Asunci&oacute;n G&oacute;mez-P&eacute;rez (UPM) and Jérome Euzenat. Deliverable D3.1: Strategy for Energy Measurement and Interoperability. Acessible from <a href="ftp://ftp.inrialpes.fr/pub/exmo/reports/r4sc-31.pdf">ftp://ftp.inrialpes.fr/pub/exmo/reports/r4sc-31.pdf</a></li>
<li id="LODE"><strong>[LODE]</strong>: Silvio Peroni. Live OWL Documentation Environment web page. Accessible from <a href="http://www.essepuntato.it/lode">http://www.essepuntato.it/lode</a></li>
<li id="RFC2119">
<strong>[RFC2119]</strong>
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels. March 1997. Internet RFC 2119. URL: <a href="http://www.ietf.org/rfc/rfc2119.txt">http://www.ietf.org/rfc/rfc2119.txt</a>
</li>
<li id="soft"><strong>[Smith et al 2016]</strong>: Smith AM, Katz DS, Niemeyer KE, FORCE11 Software Citation Working Group. (2016) Software Citation Principles. PeerJ Computer Science 2:e86. DOI: 10.7717/peerj-cs.86</li>
<li id="LOV"><strong>[Vandenbussche and Batant 2012]</strong>: Pierre-Yves Vandenbussche and Bernard Vatant. Metadata Recommendations For Linked Open Data Vocabularies. Accessible from <a href="https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf">https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf</a> </li>
<li id="analysis"><strong>[Garijo 2023]</strong>: Daniel Garijo. Ontology landscape metadata analysis (early version). Accessible from <a href="https://github.com/dgarijo/ontology_metadata_landscape_analysis/blob/main/analysis_results/support_by_resource.csv">GitHub</a>. </li>
</ul>

</div>
Expand All @@ -120,7 +124,7 @@ <h2 id="missing" class="list">Feedback <span class="backlink"> back to <a href="

<div id="acknowledgements">
<h2 id="ack" class="list">Acknowledgements <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
<p>The authors would like to thank Vladimir Alexiev, Simon Cox, Lars G. Svensson and Pierre-Yves Vandenbussche for their detailed feedback on the document </p>
<p>The authors would like to thank Vladimir Alexiev, Giacomo Lanza, Simon Cox, Lars G. Svensson and Pierre-Yves Vandenbussche for their detailed feedback on the document </p>
</div>
</body>
</html>
50 changes: 35 additions & 15 deletions doc/bestPractices/sections/checklist-en.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<h2 id="desc" class="list">Vocabulary checklist of metadata properties <span class="backlink"> back to <a href="#toc">ToC</a></span></h2>
In this section we list the metadata terms we consider relevant for describing a vocabulary.
<p>
In this section we list the metadata terms we consider relevant for describing a vocabulary or an ontology. For each term we suggest a list of properties that may be used, including a <strong>(PREFERRED)</strong> tag for those terms that are most popular at the moment. Popularity is based on [<a href="#analysis"> an analysis </a> over thousands of ontologies and vocabularies and the work done in the Metadata for Ontology Description and publication ontology by [<a href="jonquet">Dutta et al 2021</a>].
</p>

<h3 id="access" class="list">Vocabulary access</h3>
<p>
Expand All @@ -12,41 +14,51 @@ <h4 class="list" id="namespaceURI">Vocabulary namespace URI [<em class="rfc2119"
</p>

<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://purl.org/vocab/vann/preferredNamespaceUri">vann:preferredNamespaceUri</a></li>
<li><a target="_blank" href="http://purl.org/vocab/vann/preferredNamespaceUri">vann:preferredNamespaceUri</a> <strong>(PREFERRED)</strong></li>
</ul>

<h4 class="list" id="prefix">Prefix [<em class="rfc2119" title="RECOMMENDED">RECOMMENDED</em>]</h4>
<p>Preferred prefix used to refer to the ontology. This is important to let potential reusers know how you expect your ontology to be abbreviated. You want everyone to refer to it in the same way.</p>

<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://purl.org/vocab/vann/preferredNamespacePrefix">vann:preferredNamespacePrefix</a></li>
<li><a target="_blank" href="http://purl.org/vocab/vann/preferredNamespacePrefix">vann:preferredNamespacePrefix</a> <strong>(PREFERRED)</strong></li>
</ul>

<h3 id="goals" class="list">Vocabulary goals and description</h3>
<p>Once your vocabulary can be properly identified, it is important to describe what it does without forcing users to explore it thoroughly. For this purpose, the following properties are recommended:</p>

<h4 class="list" id="name">Name [<em class="rfc2119" title="RECOMMENDED">RECOMMENDED</em>]</h4>
<p>The name (short acronym) for your ontology.</p>
<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://www.w3.org/2000/01/rdf-schema#label">rdfs:label</a> <strong>(PREFERRED)</strong></li>
<li><a target="_blank" href="https://w3id.org/mod#acronym">mod:acronym</a></li>
<li><a target="_blank" href="http://www.w3.org/2004/02/skos/core#prefLabel">skos:prefLabel</a></li>
<li><a target="_blank" href="http://schema.org/alternateName">schema:alternateName</a></li>
</ul>

<h4 class="list" id="title">Title [<em class="rfc2119" title="RECOMMENDED">RECOMMENDED</em>]</h4>
<p>If you were writing a paper describing your ontology, what would be the title?</p>
<p>If you were writing a paper describing your ontology, what would the title be?</p>
<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://purl.org/dc/terms/title">dcterms:title</a> <strong>(PREFERRED)</strong></li>
<li><a target="_blank" href="http://purl.org/dc/elements/1.1/title">dc:title</a></li>
<li><a target="_blank" href="http://purl.org/dc/terms/title">dcterms:title</a></li>
<li><a target="_blank" href="http://schema.org/name">schema:name</a></li>
</ul>
<h4 class="list" id="description">Description [<em class="rfc2119" title="RECOMMENDED">RECOMMENDED</em>]</h4>
<p>A small paragraph indicating what the ontology does and why should some one use it</p>
<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://purl.org/dc/elements/1.1/description">dc:description</a></li>
<li><a target="_blank" href="http://purl.org/dc/terms/description">dcterms:description</a></li>
<li><a target="_blank" href="http://www.w3.org/2000/01/rdf-schema#comment">rdfs:comment</a></li>
<li><a target="_blank" href="http://schema.org/description">schema:description</a></li>
<li><a target="_blank" href="http://www.w3.org/2004/02/skos/core#note">skos:note</a></li>
<li><a target="_blank" href="http://purl.org/dc/terms/description">dcterms:description</a> <strong>(PREFERRED)</strong></li>
<li><a target="_blank" href="http://purl.org/dc/elements/1.1/description">dc:description</a></li>
<li><a target="_blank" href="http://www.w3.org/2000/01/rdf-schema#comment">rdfs:comment</a></li>
<li><a target="_blank" href="http://schema.org/description">schema:description</a></li>
<li><a target="_blank" href="http://www.w3.org/2004/02/skos/core#note">skos:note</a></li>
</ul>

<h4 class="list" id="abs">Abstract [<em class="rfc2119" title="RECOMMENDED">OPTIONAL</em>]</h4>
<p>Similar to a description, but with a little bit more background and an explanation about the resued/extended vocabularies, context and applications using this ontology. It can be considered as the abstract of the paper describing you ontology.</p>

<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://purl.org/dc/elements/1.1/description">dc:abstract</a></li>
<li><a target="_blank" href="http://purl.org/dc/terms/abstract">dcterms:abstract</a></li>
<li><a target="_blank" href="http://purl.org/dc/terms/abstract">dcterms:abstract</a> <strong>(PREFERRED)</strong></li>
<li><a target="_blank" href="http://purl.org/dc/elements/1.1/description">dc:abstract</a></li>
</ul>

<h4 class="list" id="status">Status [<em class="rfc2119" title="OPTIONAL">OPTIONAL</em>]</h4>
Expand All @@ -55,7 +67,7 @@ <h4 class="list" id="status">Status [<em class="rfc2119" title="OPTIONAL">OPTION
</p>

<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://purl.org/ontology/bibo/status">bibo:status</a></li>
<li><a target="_blank" href="http://purl.org/ontology/bibo/status">bibo:status</a> <strong>(PREFERRED)</strong></li>
</ul>

<h3 id="version" class="list">Vocabulary version</h3>
Expand All @@ -65,7 +77,7 @@ <h4 class="list" id="versionIRI">Version IRI [<em class="rfc2119" title="RECOMME
<p>The IRI that identifies this version of your vocabulary.</p>

<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://www.w3.org/2002/07/owl#versionIRI">owl:versionIRI</a></li>
<li><a target="_blank" href="http://www.w3.org/2002/07/owl#versionIRI">owl:versionIRI</a> <strong>(PREFERRED)</strong></li>
<li><a target="_blank" href="http://schema.org/schemaVersion">schema:schemaVersion</a></li>
</ul>

Expand All @@ -75,7 +87,7 @@ <h4 class="list" id="versionInfo">Version info [<em class="rfc2119" title="RECOM
</p>

<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://www.w3.org/2002/07/owl#versionInfo">owl:versionInfo</a></li>
<li><a target="_blank" href="http://www.w3.org/2002/07/owl#versionInfo">owl:versionInfo</a> <strong>(PREFERRED)</strong></li>
<li><a target="_blank" href="http://schema.org/schemaVersion">schema:schemaVersion</a></li>
</ul>

Expand Down Expand Up @@ -156,6 +168,14 @@ <h4 class="list" id="source">Source [<em class="rfc2119" title="OPTIONAL">OPTION
<li><a target="_blank" href="http://www.w3.org/ns/prov#hadPrimarySource">prov:hadPrimarySource</a></li>
</ul>

<h4 class="list" id="extended">Ontology extensions [<em class="rfc2119" title="OPTIONAL">OPTIONAl</em>]</h4>
<p>Property indicating the ontologies and vocabularies extended in this ontology.
</p>

<ul class="hlist"><strong>Properties you may use</strong>:
<li><a target="_blank" href="http://purl.org/vocommons/voaf#extends">voaf:extends</a> <strong>(PREFERRED)</strong></li>
</ul>

<h3 id="credit" class="list">Vocabulary attribution</h3>
A key aspect of the medatata should specify the roles of the scientists that have participated in its creation. Having this metadata can facilitate other scientists to provide the approapriate credit to the contributors of the vocabulary.

Expand Down
4 changes: 4 additions & 0 deletions doc/bestPractices/sections/introduction-en.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ <h2 id="intro" class="list">Introduction <span class="backlink"> back to <a href
<tr><td><b>cc</b></td><td>&lt;https://www.w3.org/Submission/ccREL/&gt;</td></tr>
<tr><td><b>dc</b></td><td>&lt;http://purl.org/dc/elements/1.1/&gt;</td></tr>
<tr><td><b>foaf</b></td><td>&lt;http://xmlns.com/foaf/0.1/&gt;</td></tr>
<tr><td><b>mod</b></td><td>&lt;https://w3id.org/mod#&gt;</td></tr>
<tr><td><b>obo</b></td><td>&lt;http://purl.obolibrary.org/obo/&gt;</td></tr>
<tr><td><b>owl</b></td><td>&lt;http://www.w3.org/2002/07/owl#&gt;</td></tr>
<tr><td><b>pav</b></td><td>&lt;http://purl.org/pav/&gt;</td></tr>
Expand All @@ -30,6 +31,7 @@ <h2 id="intro" class="list">Introduction <span class="backlink"> back to <a href
<tr><td><b>dcterms</b></td><td>&lt;http://purl.org/dc/terms/&gt;</td></tr>
<tr><td><b>vaem</b></td><td>&lt;http://www.linkedmodel.org/schema/vaem&gt;</td></tr>
<tr><td><b>vann</b></td><td>&lt;http://purl.org/vocab/vann/&gt;</td></tr>
<tr><td><b>voaf</b></td><td>&lt;http://purl.org/vocommons/voaf#&gt;</td></tr>
</tbody>
</table>
</div>
Expand Down Expand Up @@ -61,6 +63,7 @@ <h2 id="conv" class="list">Properties summary</h2>
<li><a href="#creators">creator</a></li>
<li><a href="#contributors">contributor</a></li>
<li><a href="#lic">license</a></li>
<li><a href="#name">name</a></li>
</ul>

Summary of <em class="rfc2119" title="OPTIONAL">OPTIONAL</em> properties for <strong>vocabularies</strong>
Expand All @@ -78,6 +81,7 @@ <h2 id="conv" class="list">Properties summary</h2>
<li><a href="#logo">logo</a></li>
<li><a href="#diagram">diagram</a></li>
<li><a href="#similar">see also</a></li>
<li><a href="#extended">Extended Ontologies</a></li>
</ul>

Summary of <em class="rfc2119" title="RECOMMENDED">RECOMMENDED</em> properties for <strong>classes and properties</strong>
Expand Down
3 changes: 2 additions & 1 deletion doc/configuration/config.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
abstract=An example ontology
backwardCompatibleWith=https://w3id.org/example/1.0.0
citeAs="add some citattion text here."
creationDate="13 Nov, 2022"
dateCreated="13 Nov, 2022"
dateModified="15 Nov, 2022"
authors=First Author;Second Author
authorsURI=http://example.org/author1;http://example.org/author2
authorsInstitution=First author institution;Second author institution
Expand Down
3 changes: 2 additions & 1 deletion doc/configuration/configuration_doc.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ In order to have Widoco accept a configuration file, you need to create a `confi
abstract=An example ontology
backwardCompatibleWith=https://w3id.org/example/1.0.0
citeAs="add some citattion text here."
creationDate="13 Nov, 2022"
dateCreated="13 Nov, 2022"
dateModified="15 Nov, 2022"
authors=First Author;Second Author
authorsURI=http://example.org/author1;http://example.org/author2
authorsInstitution=First author institution;Second author institution
Expand Down
Loading

0 comments on commit ace1929

Please sign in to comment.