Removed Y*-possibities

Signed-off-by: Rieks <RieksJ@users.noreply.github.com>
tno-terminology-design · Jul 14, 2023 · 6fa89ff · 6fa89ff
1 parent fbda807
commit 6fa89ff
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 22 deletions.
diff --git a/docs/tev2/spec-files/00-ctext.md b/docs/tev2/spec-files/00-ctext.md
@@ -89,24 +89,24 @@ The following table specifies the **generic header fields**:
   <summary>Legend</summary>
 
 1. **`Name`** contains the field name;
-2. **`Req'd`** specifies whether (`Y`, or `Y*`) or not (`n`, or `F`) the field is required to be present as a header field. The `Y*` signifies that the field is required, unless the [curated text](@) documents a [synonym](@) of another [term](@), in which case it is optional. The `F` means that we reserve this field for Future Use.
+2. **`Req'd`** specifies whether (`Y`) or not (`n`, or `F`) the field is required to be present as a header field. The `F` means that we reserve this field for Future Use.
 3. **`Description`** specifies the meaning of the field, and other things you may need to know, e.g. why it is needed, a required syntax, etc.
 
 </details>
 
 | Name            | Req'd | Description |
 | --------------- | :---: | ----------- |
-| `term`            | Y  | [term](@) that is used to represent ([identify](@)) a specific [knowledge artifact](@).<br/>The `term`-field of a [term identifier](@) that refers to this [curated text](@) must (be resolved to) match this value.<br/>Must satisfy regex `[a-z0-9_-]+`. |
-| `termType`        | n  | [Text](term-type@) that [identifies](@) the kind of [knowledge artifact](@) that this [curated text](@) describes. Typical values would be `concept`, `relation`, `pattern` (or `mental-model`), `term` (or `alias`), or `usecase`.<br/>Must satisfy regex `[a-z0-9_-]+`. |
-| `isa`             | n  | [concept](@) of which this is a specialization. |
+| `term`            | Y | [term](@) that is used to represent ([identify](@)) a specific [knowledge artifact](@).<br/>The `term`-field of a [term identifier](@) that refers to this [curated text](@) must (be resolved to) match this value.<br/>Must satisfy regex `[a-z0-9_-]+`. |
+| `termType`        | n | [Text](term-type@) that [identifies](@) the kind of [knowledge artifact](@) that this [curated text](@) describes. Typical values would be `concept`, `relation`, `pattern` (or `mental-model`), `term` (or `alias`), or `usecase`.<br/>Must satisfy regex `[a-z0-9_-]+`. |
+| `isa`             | n | [knowledge artifact](@) of which this is a specialization. |
 | `glossaryTerm`    | n | Text that is used for the [term](@) in a human readable [glossary](@). For example, for a [term](@) called `member`, you may want to specify a glossaryTerm `member (of a [ommunity](@))`. |
-| `glossaryText`    | Y* | Text that is used as the (raw) contents for the entry of this [term](@) in a human readable [glossary](@). This text MUST be expected to contain [term refs](@). |
-| `synonymOf`       | n  | [term identifier](@) that [identifies](@) the [term](@) of which this is a [synonym](@). |
-| `grouptags`       | n  | List of [grouptags](@), each of which signifies that the [(scoped) term](@) that this [curated text](@) documents, is part of the group of [terms](@) that it represents.<br/>Example: `[tev2, management]`.<br/>Must satisfy regex [`(?:\[\s*([a-z0-9_-]+)\s*(?:,\s*([a-z0-9_-]+))*\s*\])?`](https://www.debuggex.com/r/a51CXl1NzR3kwihT). |
-| `formPhrases`     | n  | List of [texts](formphrase@) that are [used to convert](/docs/tev2/spec-tools/trrt#id) the `show text` parts of [term refs](@) into `term`s, for the purpose of accommodating plural forms (for nouns) or conjugate forms (for verbs). For details, see ['Syntax Specs - Form Phrases](/docs/tev2/spec-syntax/form-phrase-syntax). |
-| `status`          | n  | Text that identifies the status of the term. ([Communities](@) of) [scopes](@) may specify values for this field. An example is the [status tags used by ToIP](https://github.com/trustoverip/concepts-and-terminology-wg/blob/master/docs/status-tags.md). |
-| `created`         | n  | Date at which of the [curated text](@) was created, in the date format as used within this [scope](@). |
-| `updated`         | n  | Date at which of the [curated text](@) was last modified, in the date format as used within this [scope](@). |
-| `contributors`    | n  | Text that shows (or refers to) the people that have contributed to this [curated text](@). |
-| `attribution`     | n  | Text that credits the original creation of the texts in the document. |
-| `originalLicense` | n  | Reference to the license of the work from which the texts were derived. |
+| `glossaryText`    | n | Text that is used as the (raw) contents for the entry of this [term](@) in a human readable [glossary](@). This text MUST be expected to contain [term refs](@). |
+| `synonymOf`       | n | [term identifier](@) that [identifies](@) the [term](@) of which this is a [synonym](@). |
+| `grouptags`       | n | List of [grouptags](@), each of which signifies that the [(scoped) term](@) that this [curated text](@) documents, is part of the group of [terms](@) that it represents.<br/>Example: `[tev2, management]`.<br/>Must satisfy regex [`(?:\[\s*([a-z0-9_-]+)\s*(?:,\s*([a-z0-9_-]+))*\s*\])?`](https://www.debuggex.com/r/a51CXl1NzR3kwihT). |
+| `formPhrases`     | n | List of [texts](formphrase@) that are [used to convert](/docs/tev2/spec-tools/trrt#id) the `show text` parts of [term refs](@) into `term`s, for the purpose of accommodating plural forms (for nouns) or conjugate forms (for verbs). For details, see ['Syntax Specs - Form Phrases](/docs/tev2/spec-syntax/form-phrase-syntax). |
+| `status`          | n | Text that identifies the status of the term. ([Communities](@) of) [scopes](@) may specify values for this field. An example is the [status tags used by ToIP](https://github.com/trustoverip/concepts-and-terminology-wg/blob/master/docs/status-tags.md). |
+| `created`         | n | Date at which of the [curated text](@) was created, in the date format as used within this [scope](@). |
+| `updated`         | n | Date at which of the [curated text](@) was last modified, in the date format as used within this [scope](@). |
+| `contributors`    | n | Text that shows (or refers to) the people that have contributed to this [curated text](@). |
+| `attribution`     | n | Text that credits the original creation of the texts in the document. |
+| `originalLicense` | n | Reference to the license of the work from which the texts were derived. |
diff --git a/docs/tev2/spec-files/11-saf.md b/docs/tev2/spec-files/11-saf.md
@@ -71,7 +71,7 @@ The following fields are defined for the `scope` section of a [SAF](@):
   <summary>Legend</summary>
 
 1. **`Name`** contains the field name;
-2. **`Req'd`** specifies whether (`Y`, or `Y*`) or not (`n`, or `F`) the field is required to be present as a header field. The `Y*` signifies that currently, the field is required, but that we envisage it to become optional when tooling becomes more mature, and will be able to automatically create the specified default value. The `F` means that we reserve this field for Future Use.
+2. **`Req'd`** specifies whether (`Y`) or not (`n`, or `F`) the field is required to be present as a header field. The `F` means that we reserve this field for Future Use.
 3. **`Description`** specifies the meaning of the field, and other things you may need to know, e.g. why it is needed, a required syntax, etc.
 
 </details>
@@ -124,7 +124,7 @@ The following fields are defined for the `scopes` section of a [SAF](@):
   <summary>Legend</summary>
 
 1. **`Name`** contains the field name;
-2. **`Req'd`** specifies whether (`Y`, or `Y*`) or not (`n`, or `F`) the field is required to be present as a header field. The `Y*` signifies that currently, the field is required, but that we envisage it to become optional when tooling becomes more mature, and will be able to automatically create the specified default value. The `F` means that we reserve this field for Future Use.
+2. **`Req'd`** specifies whether (`Y`) or not (`n`, or `F`) the field is required to be present as a header field. The `F` means that we reserve this field for Future Use.
 3. **`Description`** specifies the meaning of the field, and other things you may need to know, e.g. why it is needed, a required syntax, etc.
 
 </details>
@@ -180,7 +180,7 @@ The following fields are defined for the `versions` section of a [SAF](@):
   <summary>Legend</summary>
 
 1. **`Name`** contains the field name;
-2. **`Req'd`** specifies whether (`Y`, or `Y*`) or not (`n`, or `F`) the field is required to be present as a header field. The `Y*` signifies that currently, the field is required, but that we envisage it to become optional when tooling becomes more mature, and will be able to automatically create the specified default value. The `F` means that we reserve this field for Future Use.
+2. **`Req'd`** specifies whether (`Y`) or not (`n`, or `F`) the field is required to be present as a header field. The `F` means that we reserve this field for Future Use.
 3. **`Description`** specifies the meaning of the field, and other things you may need to know, e.g. why it is needed, a required syntax, etc.
 
 </details>

diff --git a/docs/tev2/spec-files/20-profile-templates.md b/docs/tev2/spec-files/20-profile-templates.md
@@ -48,7 +48,7 @@ This template allows [interpreters](@) for [ingestible content](@) to be created
 
 1. **`Name`** contains the field name;
 2. **`Moustache`** specifies the name of the variable, in so-called [moustache](https://mustache.github.io/mustache.5.html) format
-3. **`Req'd`** specifies whether (`Y`, or `Y*`) or not (`n`, or `F`) the field is required to be present as a header field. The `Y*` signifies that currently, the field is required, but that we envisage it to become optional when tooling becomes more mature, and will be able to automatically create the specified default value. The `F` means that we reserve this field for Future Use.
+3. **`Req'd`** specifies whether (`Y`) or not (`n`, or `F`) the field is required to be present as a header field. The `F` means that we reserve this field for Future Use.
 4/ **`Default`** specifies the value that the interpreter must use as a default value for the variable in case the interpreted text does not specify a value. If no default is specified, the default value is "empty" or "void".
 3. **`Description`** specifies the meaning of the field, and other things you may need to know, e.g. why it is needed, a required syntax, etc.
 
@@ -58,7 +58,7 @@ This template allows [interpreters](@) for [ingestible content](@) to be created
 | :---------------- | :------------------- | :----: | :------: | :---------- |
 | `term`            | {{`term`}}             | Y  |            | word/phrase that represents a concept. |
 | `termType`        | {{`termType`}}         | n  | `concept`  | kind of concept (e.g. `concept` (default), or `mental model`). |
-| `isa`             | {{`isa`}}              | n  |            | concept of which this is a specialization. |
+| `isa`             | {{`isa`}}              | n  |            | knowledge artifact of which this is a specialization. |
 | `glossaryText`    | {{`glossaryText`}}     | Y  |            | text that summarizes the meaning of the term. |
 | `synonyms`        | {{`synonymsList`}}     | n  |            | other words/phrases that mean the same. |
 | `grouptags`       | {{`grouptagsList`}}    | n  |            | comma-separated list of tags/keywords to which the term belongs. |

diff --git a/docs/tev2/spec-files/21-mrg.md b/docs/tev2/spec-files/21-mrg.md
@@ -68,7 +68,7 @@ The following fields are defined for the sections `terminology`:
   <summary>Legend</summary>
 
 1. **`Name`** contains the field name;
-2. **`Req'd`** specifies whether (`Y`, or `Y*`) or not (`n`, or `F`) the field is required to be present as a header field. The `Y*` signifies that currently, the field is required, but that we envisage it to become optional when tooling becomes more mature, and will be able to automatically create the specified default value. The `F` means that we reserve this field for Future Use.
+2. **`Req'd`** specifies whether (`Y`) or not (`n`, or `F`) the field is required to be present as a header field. The `F` means that we reserve this field for Future Use.
 3. **`Description`** specifies the meaning of the field, and other things you may need to know, e.g. why it is needed, a required syntax, etc.
 
 </details>
@@ -90,7 +90,7 @@ The following fields are defined for the section `scopes`:
   <summary>Legend</summary>
 
 1. **`Name`** contains the field name;
-2. **`Req'd`** specifies whether (`Y`, or `Y*`) or not (`n`, or `F`) the field is required to be present as a header field. The `Y*` signifies that currently, the field is required, but that we envisage it to become optional when tooling becomes more mature, and will be able to automatically create the specified default value. The `F` means that we reserve this field for Future Use.
+2. **`Req'd`** specifies whether (`Y`) or not (`n`, or `F`) the field is required to be present as a header field. The `F` means that we reserve this field for Future Use.
 3. **`Description`** specifies the meaning of the field, and other things you may need to know, e.g. why it is needed, a required syntax, etc.
 
 </details>
@@ -139,7 +139,7 @@ The following table documents the fields that are used within the context of [TE
 | `vsntag`          | Y | [Versiontag](@) that [identifies](@) the version of the [terminology](@) from which the contents of the [MRG entry](@) is obtained. If the contents of the [MRG entry](@) was constructed from a [curated text](@), its value equals the value of the `vsntag` field in the [`terminology`-section](#mrg-terminology) of the [MRG](@) that this [MRG entry](@) is a part of. As a result, `scopetag`:`versiontag` [identifies](@) the [terminology](@) from which this [MRG entry](@) has originated.<br/>Must satisfy regex `[a-z0-9_-.]+`.  |
 | `term`            | Y | [Term](@) that is used to represent ([identify](@)) a [knowledge artifact](@) in this [scope](@).<br/>Must satisfy regex `[a-z0-9_-]+`. |
 | `termType`        | Y | [Text](term-type@) that [identifies](@) the kind of [knowledge artifact](@) that this [MRG entry](@) refers to. Typical values would be `concept`, `relation`, `pattern` (or `mental-model`), `term` (or `alias`), or `usecase`.<br/>Must satisfy regex `[a-z0-9_-]+`. |
-| `isa`             | n | [concept](@) of which this is a specialization. |
+| `isa`             | n | [knowledge artifact](@) of which this is a specialization. |
 | `glossaryTerm`    | n | Text that is used for the [term](@) in a human readable [glossary](@). For example, for a [term](@) called `member`, you may want to specify a glossaryTerm `member (of a [ommunity](@))`. |
 | `glossaryText`    | n | Text that is used as the (raw) contents for the entry of this [term](@) in a human readable [glossary](@). Such texts SHOULD be allowed to contain [term refs](@). |
 | `synonymOf`       | n | [term identifier](@) that [identifies](@) the [term](@) of which this is a [synonym](@). |