Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,28 @@ Annotations use the same `DetailedDefinition` structure as definitions, notes,
and examples, with `content` and optional per-item `sources`.


== Scoped examples (VIM 1993 style)

A `DetailedDefinition` may carry its own `examples` collection — EXAMPLE entries
nested inside a NOTE or definition. This follows the VIM 1993 convention where
examples are scoped to the note or definition they illustrate, rather than
living at the concept level.

* **Concept-level examples** live on the concept's `examples` collection
directly and use `gloss:hasExample`.
* **Scoped examples** live on a `DetailedDefinition`'s `examples` collection
and use `gloss:hasScopedExample` (MECE separation from concept-level).

[source,yaml]
----
notes:
- content: Resistivity depends on temperature.
examples:
- content: At 20 °C, annealed copper has a resistivity of 1.68 × 10⁻⁸ Ω·m.
- content: For a 1 m copper wire with 1 mm² cross-section, R ≈ 0.017 Ω.
----


== Dataset register

Each dataset directory contains a `register.yaml` — the self-describing metadata
Expand Down
Binary file modified images/Concepts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 11 additions & 1 deletion models/concepts/DetailedDefinition.lutaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
class DetailedDefinition {
definition {
A definition of the managed term.
A definition of the managed term. Reused as the shape for
concept-level definition, notes, examples, and annotations.
}
+content: ParagraphBlock [1..*] {
definition {
Expand All @@ -12,4 +13,13 @@ class DetailedDefinition {
Bibliographic references for this particular definition of the managed term.
}
}
+examples: DetailedDefinition [0..*] {
definition {
Examples scoped to this entry — e.g. an EXAMPLE nested inside
a NOTE (VIM 1993 style) or inside a definition. Empty when
the example is concept-level, in which case it lives on
Concept#examples directly. Recursive but typically one level
deep in source data.
}
}
}
1 change: 1 addition & 0 deletions ontologies/glossarist.context.jsonld
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"hasDefinition": { "@id": "gloss:hasDefinition", "@type": "@id" },
"hasNote": { "@id": "gloss:hasNote", "@type": "@id" },
"hasExample": { "@id": "gloss:hasExample", "@type": "@id" },
"hasScopedExample": { "@id": "gloss:hasScopedExample", "@type": "@id" },
"hasAnnotation": { "@id": "gloss:hasAnnotation", "@type": "@id" },
"hasNonVerbalRep": { "@id": "gloss:hasNonVerbalRep", "@type": "@id" },
"domain": { "@id": "gloss:domain", "@type": "xsd:anyURI" },
Expand Down
14 changes: 13 additions & 1 deletion ontologies/glossarist.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -379,7 +379,19 @@ gloss:hasExample a owl:ObjectProperty ;
rdfs:domain gloss:LocalizedConcept ;
rdfs:range gloss:DetailedDefinition ;
rdfs:label "has example"@en ;
rdfs:comment "Links a localized concept to an illustrative example."@en .
rdfs:comment "Links a localized concept to a concept-level illustrative example."@en .

gloss:hasScopedExample a owl:ObjectProperty ;
rdfs:domain gloss:DetailedDefinition ;
rdfs:range gloss:DetailedDefinition ;
rdfs:label "has scoped example"@en ;
rdfs:comment """
Links a definition, note, or annotation to a scoped example nested
inside it (VIM 1993 style). Distinct from gloss:hasExample, which
links a LocalizedConcept to a concept-level example. MECE: concept-
level examples use hasExample; definition/note-scoped examples use
hasScopedExample.
"""@en .

gloss:hasAnnotation a owl:ObjectProperty ;
rdfs:domain gloss:LocalizedConcept ;
Expand Down
4 changes: 4 additions & 0 deletions ontologies/shapes/glossarist.shacl.ttl
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,10 @@ gloss:DetailedDefinitionShape a sh:NodeShape ;
sh:property [
sh:path gloss:hasSource ;
sh:class gloss:ConceptSource ;
] ;
sh:property [
sh:path gloss:hasScopedExample ;
sh:class gloss:DetailedDefinition ;
] .

gloss:ConceptSourceShape a sh:NodeShape ;
Expand Down
9 changes: 9 additions & 0 deletions schemas/v2/examples/04-definition-notes-examples.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,15 @@ data:
- type: lineage
origin:
text: "SI Brochure, 9th edition"
# Examples scoped to this note — VIM 1993 style nesting.
# Concept-level examples (below) are not scoped to a note.
examples:
- content: >-
At 20 °C, annealed copper has a resistivity of about
1.68 × 10⁻⁸ Ω·m.
- content: >-
For a 1 m length of copper wire with cross-section 1 mm²,
R ≈ 0.017 Ω.

# Illustrative examples — also DetailedDefinition
examples:
Expand Down
6 changes: 6 additions & 0 deletions schemas/v2/localized-concept.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,12 @@ $defs:
type: array
items:
$ref: "#/$defs/concept_source"
examples:
type: array
items:
$ref: "#/$defs/detailed_definition"
description: >-
Examples scoped to this entry (VIM 1993 style nesting).
description: Bibliographic references for this particular definition of the concept.

# Data Types
Expand Down
3 changes: 3 additions & 0 deletions schemas/v3/examples/04-definition-notes-examples.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ data:
origin:
ref:
source: SI Brochure, 9th edition
examples:
- content: At 20 °C, annealed copper has a resistivity of about 1.68 × 10⁻⁸ Ω·m.
- content: For a 1 m length of copper wire with cross-section 1 mm², R ≈ 0.017 Ω.
examples:
- content: A copper wire 1 m long with a cross-section of 1 mm² has a resistance
of approximately 0.017 Ω at 20 °C.
Expand Down
8 changes: 7 additions & 1 deletion schemas/v3/examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,14 @@ ConceptData defaults → Designation overrides → Pronunciation overrides.

All three use `DetailedDefinition` — text content with optional per-item sources.

A `DetailedDefinition` may carry its own scoped `examples` collection (VIM 1993
style: EXAMPLE entries nested inside a NOTE). Concept-level examples — the ones
not scoped to a specific note or definition — live on `Concept#examples`
directly.

- **`04-definition-notes-examples.yaml`**: definition with authoritative source,
two notes (one with lineage source), and an example.
two notes (one with lineage source and two scoped examples), and a concept-level
example.

## 05 — Domains (Classification)

Expand Down
9 changes: 9 additions & 0 deletions schemas/v3/localized-concept.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -711,6 +711,15 @@ $defs:
items:
$ref: "#/$defs/concept_source"
description: Bibliographic references for this content.
examples:
type: array
items:
$ref: "#/$defs/detailed_definition"
description: >-
Examples scoped to this entry (VIM 1993 style: EXAMPLE entries
nested inside a NOTE or definition). Empty when the example is
concept-level, in which case it lives on the concept's
top-level examples collection directly.

related_concept:
type: object
Expand Down
Loading