Annotation Ontology
EKGF Editor's Draft
1. Annotation Ontology§
1.1 Overview§
Annotation Ontology
| Identifier | Value |
|---|---|
| Ontology IRI / Namespace | https://ekgf.org/ontology/annotation# |
| Prefix | ekg-annotation |
Descriptive resource metadata: Markdown descriptions, subtitles, summaries, short titles, URL slugs, colors and sort keys. Text annotations apply to classes, properties and individuals; slug and sortKey are datatype properties for resource addressing and ordering.
1.2 Properties§
1.2.1 Hexadecimal RGB color§
An RGB color code in hex
ekg-annotation:hexColor | |
https://ekgf.org/ontology/annotation#hexColor | |
| RDF predicate | Value |
|---|---|
rdf:type | owl:AnnotationProperty |
rdfs:label | Hexadecimal RGB color |
1.2.2 Markdown description§
Use this annotation on an ontology, class, property, or individual for
explanations that benefit from Markdown: scope, examples, modeling decisions,
ownership rules, and application behavior. Use an English language tag for the
English explanation. Keep a short definition in rdfs:comment where useful.
Markdown can include headings, lists, tables, fenced code examples, and links.
Consumers render this description when present and use rdfs:comment when it
is absent.
An explanation is an annotation. Describing a subclass relationship, a property range, a SHACL constraint, or an application default does not implement it. Identify agreed changes awaiting implementation explicitly, so readers can distinguish the recorded decision from the current axioms.
ekg-annotation:markdownDescription | |
https://ekgf.org/ontology/annotation#markdownDescription | |
| RDF predicate | Value |
|---|---|
rdf:type | owl:AnnotationProperty |
rdfs:label | Markdown description |
1.2.3 short title§
A short title is a real, authored name, not the result of trimming a title. For example, "Commons Identifiers Ontology" can have the short title "Identifiers Ontology" for use under the Commons family heading. A viewer chooses the short title where the context makes the full title redundant, and the full label elsewhere.
Each value carries a language tag, with at most one short title per language,
so translations work like any other label. Resources without a short title use
their normal label. A tool that knows a naming convention can generate short
titles, and ShortTitleShape validates them like any other data.
ekg-annotation:shortTitle | |
https://ekgf.org/ontology/annotation#shortTitle | |
| RDF predicate | Value |
|---|---|
rdf:type | owl:AnnotationProperty |
rdfs:label | short title |
1.2.4 slug§
A slug is a readable URL name, such as enterprise or working-draft.
It does not replace the resource's stable IRI or registered UUID identity.
Different contexts can reuse a slug: states in different lifecycles can both
be named deprecated. This property declares no global uniqueness rule,
cardinality restriction or automatic slug generation.
The property is an owl:DatatypeProperty with string values. Its placement in
this ontology does not turn it into an OWL annotation property. The existing
Markdown, subtitle and summary predicates retain their annotation semantics.
ekg-annotation:slug | |
https://ekgf.org/ontology/annotation#slug | |
| RDF predicate | Value |
|---|---|
rdf:type | owl:DatatypeProperty |
rdfs:label | slug |
rdfs:range | xsd:string |
1.2.5 Sort key§
A sort key places a resource among its siblings wherever a user interface or report lists them: use cases in a tree, concepts in a vocabulary, tabs on a page. Sorting compares the key where a resource has one and its label where it does not, so keys compete with the labels themselves.
A key is a hint, not a rank. Siblings often come from datasets and sources that know nothing of each other, so they cannot share a numbering. Each source picks an arbitrary string that lands its resource roughly in the right place: "aaa" near the start, "zzz" near the end. Two resources with the same key sit side by side and sort by their labels instead of colliding.
@prefix annotation: <https://ekgf.org/ontology/annotation#> .
@prefix ex: <https://example.org/> .
ex:overview annotation:sortKey "aaa" .
ex:shapes annotation:sortKey "zzz1" .
ex:provenance annotation:sortKey "zzz2" .
The property has no domain, so any resource can carry one. Its placement in
this ontology does not make it an OWL annotation property; like slug, it is a
datatype property with string values.
ekg-annotation:sortKey | |
https://ekgf.org/ontology/annotation#sortKey | |
| RDF predicate | Value |
|---|---|
rdf:type | owl:DatatypeProperty |
rdfs:label | Sort key |
rdfs:range | xsd:string |
1.2.6 subtitle§
One line shown under the label of the resource.
ekg-annotation:subtitle | |
https://ekgf.org/ontology/annotation#subtitle | |
| RDF predicate | Value |
|---|---|
rdf:type | owl:AnnotationProperty |
rdfs:label | subtitle |
1.2.7 summary§
A short summary of the resource, in plain text.
ekg-annotation:summary | |
https://ekgf.org/ontology/annotation#summary | |
| RDF predicate | Value |
|---|---|
rdf:type | owl:AnnotationProperty |
rdfs:label | summary |
1.3 Shapes§
1.3.1 Short Title Shape§
Requires each short title to be a nonempty language-tagged literal, with at most one per language.
ekg-annotation:ShortTitleShape | |
https://ekgf.org/ontology/annotation#ShortTitleShape | |
| RDF predicate | Value |
|---|---|
rdf:type | sh:NodeShape |
rdfs:label | Short Title Shape |
sh:property | (sh:datatype: rdf:langString; sh:message: A short title is a nonempty language-tagged string, with at most one per language.; sh:minLength: 1; sh:path: ekg-annotation:shortTitle; sh:uniqueLang: true) |
sh:targetSubjectsOf | ekg-annotation:shortTitle |