Class: RequiredMetadata

name: RequiredMetadata
description: A mixin that provides the required properties needed to index an ontology
  or SKOS vocabulary in the TIB Terminology Service.
from_schema: http://terminology.tib.eu/schema
rank: 1000
mixin: true
slots:
- purl
- title
- preferredPrefix
- acronym
- license
- creator
- versionInfo
- versionIRI
- versionNotes
- created
- modificationDate
- description
- issueTracker
- documentation
- imports

name: RequiredMetadata
description: A mixin that provides the required properties needed to index an ontology
  or SKOS vocabulary in the TIB Terminology Service.
from_schema: http://terminology.tib.eu/schema
rank: 1000
mixin: true
attributes:
  purl:
    name: purl
    description: "The PURL of an ontology is its persistent identifier. It is usually\
      \ used by within the ontology to state:\n`<https://www.domain.de/myOntology>\
      \ rdf:type owl:Ontology.` \nIt is usually able to locate and retrieve the ontology\
      \ on the world wide web, so pasting it into your web browser should retrieve\
      \ a digital document. Furthermore, it is often configured to do content negotiation\
      \ so that different related resources can be retrieved with the same identifier\
      \ - e.g. the human-readable ontology documentation or different serializations\
      \ of an ontology.        \nOntologies usually also use the PURL to identify\
      \ their classes and properties, e.g. in statements like:          \n    `<https://www.domain.de/myOntology#someProperty>\
      \ rdf:type owl:AnnotationProperty.`\nA working PURL is required to retrieve\
      \ the ontology for indexing by the TIB Terminology Service.\nThis metadatum\
      \ is also recommended by:\n\n  * http://purl.obolibrary.org/meta/context.jsonld\
      \    \n  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n\
      \  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n  * https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n\
      \  * [ Best Practices for Implementing FAIR Vocabularies and Ontologies on the\
      \ Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - vann:preferredNamespaceUri
    - owl:ontologyIRI
    aliases:
    - namspace URI
    rank: 1000
    slot_uri: dcat:accessURL
    multivalued: false
    identifier: true
    alias: purl
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: uriorcurie
    required: true
  title:
    name: title
    description: "The title or name of an ontology or SKOS vocabulary.\n\nThis metadatum\
      \ is also recommended as required by:\n\n  * https://github.com/information-artifact-ontology/ontology-metadata/pull/106#issuecomment-1117383852\n\
      \  * http://purl.obolibrary.org/meta/context.jsonld\n  * https://w3id.org/mod/2.0\n\
      \  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n  * https://github.com/owlcs/miro/blob/master/miro.md#a1-ontology-name\n\
      \  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n  * [Best\
      \ Practices for Implementing FAIR Vocabularies and Ontologies on the Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - dc:title
    - schema:name
    rank: 1000
    slot_uri: dcterms:title
    alias: title
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  preferredPrefix:
    name: preferredPrefix
    description: "The official prefix of an ontology or vocabulary namespace according\
      \ to the [W3C specification](https://www.w3.org/TR/1999/REC-xml-names-19990114/#NT-NCName)\
      \ (e.g. **dcterms** for [http://purl.org/dc/terms/](http://purl.org/dc/terms/).\n\
      \nThis metadatum is also recommended as required by:\n\n  * https://github.com/information-artifact-ontology/ontology-metadata/pull/106#issuecomment-1117383852\n\
      \  * http://purl.obolibrary.org/meta/context.jsonld\n  * https://w3id.org/mod/2.0\n\
      \  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n\
      \  * https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n\
      \  * [Best Practices for Implementing FAIR Vocabularies and Ontologies on the\
      \ Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    comments:
    - The ontology should declare its own preferred prefix. The prefix should be unique.
      You can check whether an ontology prefix is already in use on services like
      [prefix.cc](https://prefix.cc) or [bioregistry.io](https://bioregistry.io).
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - idot:preferredPrefix
    rank: 1000
    slot_uri: vann:preferredNamespacePrefix
    alias: preferredPrefix
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  acronym:
    name: acronym
    description: "The ID is used as a short name for the ontology or SKOS vocabulary\
      \ on the TIB Terminology Service ontology list. It can be the same string as\
      \ the preferred prefix. It should be unique and not contain a hyphen.\n\nThis\
      \ metadatum is also recommended as required by:\n\n        * https://github.com/information-artifact-ontology/ontology-metadata/pull/106#issuecomment-1117383852\n\
      \        * https://w3id.org/mod/2.0\n        * https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n\
      \        * https://bioportal.bioontology.org/ontologies/OMV\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    - This property is declared only as recommended in this schema although it is
      technically required within the configuration of the TIB TS, as it can be derived
      directly from the required [preferredPrefix](preferredPrefix) if not present.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - http://omv.ontoware.org/2005/05/ontology#acronym
    rank: 1000
    slot_uri: mod:acronym
    alias: acronym
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: false
    recommended: true
  license:
    name: license
    description: "The license of the ontology/vocabulary. Ontologies and SKOS vocabularies\
      \ should refer to license documents on the web via PIDs. The license text helps\
      \ others to evaluate how they may reuse the ontology/vocabulary.\nOnly ontologies\
      \ with an open license will be published on the TIB Terminology Service.\n\n\
      This metadatum is also recommended as required by:\n\n  * https://github.com/information-artifact-ontology/ontology-metadata/pull/106#issuecomment-1117383852\n\
      \  * http://purl.obolibrary.org/meta/context.jsonld\n  * https://w3id.org/mod/2.0\n\
      \  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n\
      \  * https://doi.org/10.1371/journal.pcbi.1009041\n  * http://ceur-ws.org/Vol-3127/#paper-15\
      \ \n  * [Best Practices for Implementing FAIR Vocabularies and Ontologies on\
      \ the Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    todos:
    - We should point to types of different licenses and give recommendations on which
      to choose when.
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - http://purl.org/dc/terms/rights
    - http://purl.org/dc/elements/1.1/rights
    - http://creativecommons.org/ns#license
    - http://dbpedia.org/ontology/license
    rank: 1000
    slot_uri: dcterms:license
    alias: license
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: uriorcurie
    required: true
  creator:
    name: creator
    description: "The ontology should state who was or is responsible for its development.\
      \ It is recommended to not only provide the creators’ names but also to link\
      \ to their ORCID, ROR or Wikidata profiles if available. Using an IRI to identify\
      \ the creator is a must when using the dcterms:creator predicat. For a literal\
      \ representations of a creator the predicate dc:creator is recommended to be\
      \ in line with DCMI specs.\n\nThis metadatum is also recommended as required\
      \ by:\n\n  * https://w3id.org/mod/2.0\n  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n\
      \  * https://github.com/owlcs/miro/blob/master/miro.md#c2-development-community\n\
      \  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n  * [Best\
      \ Practices for Implementing FAIR Vocabularies and Ontologies on the Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - prov:wasAttributedTo
    - pav:createdBy
    - dc:creator
    - schema:creator
    rank: 1000
    is_a: contributor
    slot_uri: dcterms:creator
    multivalued: true
    alias: creator
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: uriorcurie
    required: true
    recommended: true
  versionInfo:
    name: versionInfo
    description: "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.\n\nThis metadatum is\
      \ also recommended as required by:\n\n  * https://w3id.org/mod/2.0\n  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n\
      \  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n  * https://doi.org/10.1371/journal.pcbi.1009041\n\
      \  * http://ceur-ws.org/Vol-3127/#paper-15\n  * [Best Practices for Implementing\
      \ FAIR Vocabularies and Ontologies on the Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - pav:version
    - schema:schemaVersion
    rank: 1000
    is_a: versionInformation
    slot_uri: owl:versionInfo
    multivalued: false
    alias: versionInfo
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  versionIRI:
    name: versionIRI
    description: "A version URI is a persistent identifier for a version of an ontology\
      \ and is used just like its PURL to reliably retrieve a former version of an\
      \ ontology. Since a PURL usually only points to the latest version of an ontology,\
      \ each ontology version should additionally state its version URI.\nThe textual\
      \ version information is usually part of a version URI of an ontology.\nHere\
      \ is an example from the Academic Event Ontology:\n```http://purl.obolibrary.org/obo/aeon/aeon-full.owl\n\
      http://purl.obolibrary.org/obo/aeon/releases/2022-11-25/aeon-full.owl```\n\n\
      Here is an example from ListDB Ontology:\n```https://w3id.org/listdb/onto/\n\
      https://w3id.org/listdb/onto/0.0.1```\n\nHere is an example from the GND Ontology:\n\
      ```https://d-nb.info/standards/elementset/gnd#\nhttps://d-nb.info/standards/elementset/gnd_20221010```\n\
      \nThis metadatum is also recommended as required by:\n\n  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n\
      \  * https://doi.org/10.1371/journal.pcbi.1009041\n  * http://ceur-ws.org/Vol-3127/#paper-15\n\
      \  * https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n\
      \  * [Best Practices for Implementing FAIR Vocabularies and Ontologies on the\
      \ Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - schema:schemaVersion
    rank: 1000
    is_a: versionInformation
    slot_uri: owl:versionIRI
    multivalued: false
    alias: versionIRI
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
  versionNotes:
    name: versionNotes
    description: "Version information may also be accompanied by a description about\
      \ changes between one version of the ontology and its predecessor.\n\nThis metadatum\
      \ is also recommended as required by:\n\n  * https://w3id.org/mod/2.0\n  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n\
      \  * https://doi.org/10.1371/journal.pcbi.1009041\n  * http://ceur-ws.org/Vol-3127/#paper-15\n\
      \  * https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - vann:changes
    rank: 1000
    is_a: versionInformation
    slot_uri: adms:versionNotes
    multivalued: false
    alias: versionNotes
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  created:
    name: created
    description: A property to provide the date when the ontology or a term thereof
      came into being.
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - pav:createdOn
    - schema:dateCreated
    - dcterms:issued
    - schema:datePublished
    - prov:generatedAtTime
    - schema:dateIssued
    - dc:date
    rank: 1000
    is_a: versionInformation
    slot_uri: dcterms:created
    multivalued: false
    alias: created
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  modificationDate:
    name: modificationDate
    description: A property to provide the date when a ressource was updated.
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - pav:curatedOn
    - schema:dateModified
    rank: 1000
    is_a: versionInformation
    slot_uri: dcterms:modified
    multivalued: true
    alias: modificationDate
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  description:
    name: description
    description: "The ontology should describe its own contents and scope with a few\
      \ words or sentences in order to inform human users what the ontology tries\
      \ to accomplish.\nThe description is displayed in the TIB Terminology Service\
      \ ontology list and on the start page of each ontology - we therefore recommend\
      \ to keep it short! For an extensive discussion about the ontology you may want\
      \ to consider the publication of a traditional academic article or a detailed\
      \ documentation.\n\nThis metadatum is also recommended as required by:\n\n \
      \ * https://github.com/information-artifact-ontology/ontology-metadata/pull/106#issuecomment-1117383852\n\
      \  * http://purl.obolibrary.org/meta/context.jsonld\n  * https://w3id.org/mod/2.0\n\
      \  * https://lov.linkeddata.es/Recommendations_Vocabulary_Design.pdf\n  * https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html\n\
      \  * http://ceur-ws.org/Vol-3127/#paper-15\n  * https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n\
      \  * [Best Practices for Implementing FAIR Vocabularies and Ontologies on the\
      \ Web ](http://dgarijo.com/papers/best_practices2020.pdf)\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - dc:description
    - schema:abstract
    - schema:description
    - dcterms:abstract
    - skos:note
    rank: 1000
    is_a: versionInformation
    slot_uri: dcterm:description
    multivalued: false
    alias: description
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  issueTracker:
    name: issueTracker
    description: "Ontologies should be managed with version control software like\
      \ git. Ideally, the development process of an ontology is open and takes place\
      \ on platforms like GitLab.com. The ontology should point to the issue tracker\
      \ of its own development environment so that others may report bugs or suggestions\
      \ to the developers.\n\nThis metadatum is also recommended as required by:\n\
      \n  * https://github.com/information-artifact-ontology/ontology-metadata/pull/106#issuecomment-1117383852\n\
      \  * http://purl.obolibrary.org/meta/context.jsonld\n  * https://w3id.org/mod/2.0\n\
      \  * https://github.com/owlcs/miro/blob/master/miro.md#c3-communication\n  *\
      \ https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n"
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - rdfs:seeAlso
    rank: 1000
    is_a: versionInformation
    slot_uri: doap:bug-database
    multivalued: false
    alias: issueTracker
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  documentation:
    name: documentation
    description: 'To familiarize interested others with the concepts and scope of
      your ontology, you should consider creating some kind of documentation. A relatively
      easy way to do this, is to use the tool [Widoco](https://pad.gwdg.de/). It generates
      the documentation from the ontology and a resulting html-document can be published,
      for example with GitLab Pages. This auto-generated document can contain customary
      additions that help users to understand the ontology better.

      '
    todos:
    - We need to investigate if the mapped predicates are suited enough pr if we need
      to mint/request a new predicate for this somewhere.
    comments:
    - For the RDF implementation, we recommend using the URI provided here as a standard,
      but the URI(s) listed under **See Also** might be used as alternative for this
      predicate.
    from_schema: http://terminology.tib.eu/schema
    see_also:
    - foaf:homepage
    rank: 1000
    is_a: versionInformation
    slot_uri: dcterms:isReferencedBy
    multivalued: false
    alias: documentation
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true
  imports:
    name: imports
    description: "Version information may also be accompanied by a description about\
      \ changes between one version of the ontology and its predecessor.\n\nThis metadatum\
      \ is also recommended as required by:\n\n  * https://github.com/owlcs/miro/blob/master/miro.md#e4-incorporation-of-other-ontologies\n\
      \  * https://github.com/agroportal/fairness/blob/master/doc/results/FAIR-questions.md\n"
    from_schema: http://terminology.tib.eu/schema
    rank: 1000
    is_a: versionInformation
    slot_uri: owl:imports
    multivalued: false
    alias: imports
    owner: RequiredMetadata
    domain_of:
    - RequiredMetadata
    range: string
    required: true