Slot: documentation
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. 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.
Inheritance
- provenanceProperty
- versionInformation
- documentation
- versionInformation
Applicable Classes
Name | Description |
---|---|
RequiredMetadata | A mixin that provides the required properties needed to index an ontology or ... |
Ontology | An OWL ontology |
SkosConceptScheme | A SKOS vocabulary serialized in RDF using the skos:ConceptScheme |
Properties
- Range: String
- Required: True
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.
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.
See Also
LinkML Source
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
domain_of:
- RequiredMetadata
range: string
required: true