Skip to content

Commit a2a10ff

Browse files
committed
add docs for authoritative source
1 parent ebce16b commit a2a10ff

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

README.adoc

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,101 @@ The following features are supported:
4040
* A DefinitionCollection is represented as a single clause
4141

4242

43+
== Authoritative source
44+
45+
An *authoritative source* is the "source of truth" for a terminological entry
46+
or any of its parts. It is the bibliographic reference from which the content
47+
originates, represented in the model by the `ConceptSource` class.
48+
49+
=== Source type
50+
51+
Each `ConceptSource` carries a `type` attribute of type `ConceptSourceType`,
52+
which distinguishes between two kinds of source:
53+
54+
`authoritative`::
55+
The source is the definitive origin of the content. This is the primary
56+
reference that the entry is based on.
57+
58+
`lineage`::
59+
The source documents the historical derivation or provenance of the content,
60+
but is not itself the authoritative reference.
61+
62+
For example, a term may originate from ISO 19101 (authoritative) but also
63+
reference an earlier ITU definition from which the ISO definition was derived
64+
(lineage).
65+
66+
=== Source status
67+
68+
The `status` attribute of type `ConceptSourceStatus` describes the relationship
69+
between the entry content and the cited source:
70+
71+
`identical`:: The content is identical to what appears in the source.
72+
`modified`:: The content has been modified from the source.
73+
`restyled`:: The content has been restyled (e.g. formatting changes) from the source.
74+
`context-added`:: Additional context has been added to the source content.
75+
`generalisation`:: The content is a generalisation of the source content.
76+
`specialisation`:: The content is a specialisation of the source content.
77+
`unspecified`:: The relationship to the source is unspecified.
78+
79+
The optional `modification` attribute on `ConceptSource` can provide a
80+
description of any change made relative to the cited source.
81+
82+
=== Multi-level source hierarchy
83+
84+
Sources can be attached at multiple levels of the model, allowing different
85+
parts of a terminological entry to have their own authoritative sources:
86+
87+
`ManagedConcept.sources`::
88+
Sources at the managed concept level, applicable to the concept as a whole
89+
rather than to any specific localisation.
90+
91+
`Concept.sources`::
92+
Sources at the localised concept level, applicable to a specific language
93+
version of the concept. This allows different language versions to cite
94+
different authoritative sources. For example, English terms sourced from one
95+
standard and French terms from another.
96+
97+
`Designation.sources`::
98+
Sources for individual terms (designations), when a particular term originates
99+
from a different source than the overall concept.
100+
101+
`DetailedDefinition.sources`::
102+
Sources for individual definitions, notes, or examples, allowing each to
103+
reference its own authoritative source independently of the enclosing concept's
104+
sources.
105+
106+
`NonVerbRep.sources`::
107+
Sources for non-verbal representations (images, tables, formulas).
108+
109+
This hierarchy means that a concept may have multiple authoritative sources.
110+
A concept's definition may come from one standard while a specific term for
111+
that concept comes from another, with each part independently referencing its
112+
own authoritative source. Multiple sources may also define the concept
113+
identically, in which case each is listed as an `authoritative` source with
114+
`identical` status.
115+
116+
=== The glossary as authoritative source
117+
118+
In some cases, the glossary itself is the authoritative source. For example,
119+
when a term and its definition originate within the glossary rather than being
120+
adopted from an external standard. In this case, the `origin` attribute of the
121+
`ConceptSource` references the glossary's own bibliographic citation.
122+
123+
The TC 204 Geolexica site is an example of this: the entire glossary represents
124+
ISO 14812 terminology, so the authoritative source for every entry is the
125+
glossary itself.
126+
127+
NOTE: The `ConceptSource` model is shown in the <<ConceptSource>> UML diagram
128+
below.
129+
130+
43131
== UML Models
44132

45133
=== Concept
46134

47135
image::images/Concepts.png[]
48136

137+
[[ConceptSource]]
49138
=== ConceptSource
50139

51140
image::images/ConceptSource.png[]

0 commit comments

Comments
 (0)