Skip to content

Concepts

Concepts UML

ManagedConcept

A ManagedConcept is the top-level concept entity in Glossarist. It represents a single concept in the terminology registry. See the ManagedConcept entity definition for the authoritative field list.

FieldTypeCard.Description
identifierstring1..1String identifier for the concept
urianyURI0..1URI for the concept
statusconceptStatus0..1Lifecycle status
relatedRelatedConcept[]0..*Related concepts
datesConceptDate[]0..*Governance events
sourcesConceptSource[]0..*Concept-level sources
domainsReference[]0..*Subject area references (rendered as <domain>)
tagsstring[]0..*Organizational tags for grouping and filtering (not rendered as terminological domains)
localizationsLocalizedConcept{}0..*Per-language data (keyed by language code)

Tags vs domains

tags and domains look similar but serve different purposes:

  • domains — Terminological subject-area references. Rendered as <domain> elements in TBX output and surfaced as subject-area classifications in the concept-browser.
  • tags — Free-form organizational labels used for filtering, document structuring, and retrieval. Not rendered in terminological output.
yaml
termid: "3.1.1.1"
status: valid
domains:
  - { concept_id: "103", ref_type: "domain" }
tags: [time-scale-units, foundational]

LocalizedConcept

Localizations of the concept to different languages. Each language has its own definition, notes, examples, terms, and revision history. See the LocalizedConcept entity definition for the authoritative field list.

FieldTypeCard.Description
languagestring0..1ISO 639 3-letter language code
scriptstring0..1ISO 15924 4-letter script code
systemstring0..1ISO 24229 conversion system code
designationsDesignation[]0..*Terms under which the concept is known
definitionDetailedDefinition[]0..*Definitions
notesDetailedDefinition[]0..*Notes
annotationsDetailedDefinition[]0..*Editorial annotations (distinct from notes)
examplesDetailedDefinition[]0..*Concept-level examples
entry_statusentryStatus0..1notValid, valid, superseded, or retired
classificationstring0..1preferred, admitted, or deprecated
domainanyURI0..1URI reference to the subject area
relatedRelatedConcept[]0..*Per-language concept relationships
sourcesConceptSource[]0..*Per-language sources
referencesReference[]0..*Typed references
datesConceptDate[]0..*Per-language governance events
releasestring0..1Release version
review_typestring0..1editorial or substantive
lineage_similarityinteger0..1Lineage similarity score

DetailedDefinition

A definition, note, example, or annotation with optional per-item sources and scoped sub-examples.

FieldTypeCard.Description
contentstring1..1The text content
sourcesConceptSource[]0..*Per-item sources
examplesDetailedDefinition[]0..*Examples scoped to this entry (VIM 1993 style nesting)

Scoped examples (VIM 1993 style)

Some vocabularies — notably the ISO/IEC VIM (International Vocabulary of Metrology) — nest examples inside the note or definition they elaborate on, rather than at the concept top level. Glossarist models this with examples on DetailedDefinition.

The two examples fields are MECE (mutually exclusive, collectively exhaustive):

  • LocalizedConcept.examples — concept-level examples, rendered as a flat list
  • DetailedDefinition.examples — scoped to the surrounding note/definition
yaml
eng:
  definition:
    - content: "A property of a phenomenon, body, or substance"
      notes:
        - content: "Notes can themselves have examples"
          examples:
            - content: "Mass, weight, and volume are quantities"
      examples:
        - content: "Concept-level example, rendered as a flat list"

ConceptDate

A governance event in the concept lifecycle.

FieldTypeCard.Description
datedateTime1..1Date and time of the event
typedateType1..1Event type (accepted, amended, retired, review, reviewDecision)
descriptionstring0..1Event description

Concept lifecycle

Concepts follow a lifecycle through these statuses:

  • draft — Initial proposed state
  • submitted — Change request submitted for review
  • valid — Accepted and current
  • superseded — Replaced by a newer concept
  • retired — No longer in use

Multi-language localization

A single ManagedConcept can have localizations in any number of languages. Different languages may assign the same abstract concept to different domains, and concept hierarchies can differ across languages.

ManagedConceptCollection

A collection for managed concepts. Includes the Ruby Enumerable module. Supports loading from and saving to YAML file datasets.

See the YAML Schema Reference for the complete JSON Schema definitions, the Entity Field Reference for all entity types with types, cardinality, and allowed values, and the Standards compliance reference for how each ISO standard maps to Glossarist entities.

An open source project of Ribose