Skip to content

Commit

Permalink
Fix #242, Fix #497, Fix #574, more metadata support
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarijo committed Aug 23, 2023
1 parent d94a698 commit c28089b
Show file tree
Hide file tree
Showing 18 changed files with 788 additions and 205 deletions.
406 changes: 367 additions & 39 deletions doc/bestPractices/sections/checklist-en.html

Large diffs are not rendered by default.

7 changes: 4 additions & 3 deletions doc/bestPractices/sections/introduction-en.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ <h2 id="intro" class="list">Introduction <span class="backlink"> back to <a href
</p>

<p>
Guidelines like <a href="#smart">[Garc&iacute;a-Castro et al 2015]</a>, <a href="#LODE">[LODE]</a> and <a href="#LOV">[Vandenbussche and Vatant 2012]</a> describe concrete recommendations of metadata properties that are typically used to describe specific aspects of a vocabulary (e.g., creators and license of the vocabulary). However, as part of our experience building vocabularies, we found these guidelines incomplete for representing metadata related to citation, examples or rationale of the vocabulary terms. In this document we build on these recommendations to create an expanded list of metadata terms typically used in vocabularies from different domains. For each metadata term, we list alternative properties from commonly used vocabularies that can be used to represent it. We also state whether we <strong>recommend</strong> to always add that property for describing your vocabulary, or we consider it advisable but <strong>optional</strong>. An additional benefit of using this list of proposed terms is that they are recognized by <a href="http://w3id.org/widoco/">WIDOCO</a> when automatically generating a human-readable documentation of an ontology.
Guidelines like <a href="#smart">[Garc&iacute;a-Castro et al 2015]</a>, <a href="#LODE">[LODE]</a> and <a href="#LOV">[Vandenbussche and Vatant 2012]</a> describe concrete recommendations of metadata properties that are typically used to describe specific aspects of a vocabulary (e.g., creators and license of the vocabulary). However, as part of our experience building vocabularies, we found these guidelines incomplete for representing metadata related to citation, examples or rationale of the vocabulary terms. In this document we build on these recommendations to create an expanded list of metadata terms typically used in vocabularies from different domains. For each metadata term, we list alternative properties from commonly used vocabularies that can be used to represent it. We also state whether we <strong>recommend</strong> to always add that property for describing your vocabulary, or we consider it advisable but <strong>optional</strong>. An additional benefit of using this list of proposed terms is that they are recognized by <a href="http://w3id.org/widoco/">WIDOCO</a> when automatically generating a human-readable documentation of an ontology. To see all the properties accepted by WIDOCO and examples, please see the <a href="https://github.com/dgarijo/Widoco/blob/master/doc/metadataGuide/guide.md">WIDOCO metadata guide</a>.
</p>

<p>
Expand All @@ -17,7 +17,7 @@ <h2 id="intro" class="list">Introduction <span class="backlink"> back to <a href
<tbody>
<tr><td><b>bibo</b></td><td>&lt;http://purl.org/ontology/bibo/&gt;</td></tr>
<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>dce</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>
Expand All @@ -28,10 +28,11 @@ <h2 id="intro" class="list">Introduction <span class="backlink"> back to <a href
<tr><td><b>schema</b></td><td>&lt;http://schema.org/&gt;</td></tr>
<tr><td><b>skos</b></td><td>&lt;http://www.w3.org/2004/02/skos/core#&gt;</td></tr>
<tr><td><b>sw</b></td><td>&lt;http://www.w3.org/2003/06/sw-vocab-status/ns#&gt;</td></tr>
<tr><td><b>dcterms</b></td><td>&lt;http://purl.org/dc/terms/&gt;</td></tr>
<tr><td><b>dct</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>
<tr><td><b>wdrs</b></td><td>&lt;http://www.w3.org/2007/05/powder-s#&gt;</td></tr>
</tbody>
</table>
</div>
Expand Down
20 changes: 12 additions & 8 deletions doc/configuration/config.properties
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,26 @@ contributorsInstitutionURI=https://isi.edu/;https://isi.edu/
description="A description of what the ontology does goes here"
diagram="https://example.org/diagram.svg"
DOI=
incompatibleWith=""
issued=""
funder=
fundingGrant=
incompatibleWith=
issued=
images=image1.png;image2.png
licenseURI=http://creativecommons.org/licenses/by/2.0/
licenseName=CC-BY
licenseIconURL=https://i.creativecommons.org/l/by/2.0/88x31.png
logo="https://example.org/logo.svg"
ontologyName=The Cohort Ontology
ontologyName=Example
ontologyPrefix=exo
modified="15 April, 2023"
ontologyNamespaceURI=https://w3id.org/example
previousVersionURI=https://w3id.org/example/1.0.0
publisher=
publisherURI=
publisherInstitution=
publisherInstitutionURI=
source=
publisher=Ontology Engineering Group
publisherURI=https://oeg-upm.es
publisherInstitution=UPM
publisherInstitutionURI=https://www.upm.es
source=http://source1;http://source2
seeAlso=http://firstResource
ontologyTitle=The Example Ontology
thisVersionURI=https://w3id.org/example/1.0.1
ontologyRevisionNumber=v1.0.0
Expand Down
Loading

0 comments on commit c28089b

Please sign in to comment.