Skip to content

Commit

Permalink
cleaning up terms that are sufficiently well-known
Browse files Browse the repository at this point in the history
Signed-off-by: Rieks <[email protected]>
  • Loading branch information
RieksJ committed Mar 1, 2024
1 parent 9f29f12 commit d2e11a6
Show file tree
Hide file tree
Showing 45 changed files with 139 additions and 265 deletions.
2 changes: 1 addition & 1 deletion docs/guides/10-preparation-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,7 @@ versions:
- "term[action]@essif-lab"
- "rename action [id:act, term:act, formPhrases:'act{ss}']"
- "term[party,actor,onboarding,action,organization,community,entity,legal-entity]@essif-lab"
- "term[ssi,assertion,claim,credential,issue,verify,validate,transaction]@essif-lab"
- "term[ssi,assertion,claim,credential,issue,verify,validate]@essif-lab"
- "term[manage,management,governance,risk,owner,owned]@essif-lab"
- "term[jurisdiction,objective,control,expectation,obligation]@essif-lab"
- "term[control-objective,risk-objective,compliance-objective]@essif-lab"
Expand Down
10 changes: 5 additions & 5 deletions docs/manuals/curator/42-curator-terminology-construction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The specification of a [terminology](@) exists as an entry in the [`versions` se

A new [terminology](@) specification must at least have

- a [versiontag](@) that allows the [terminology](@) to be [identified](@) (within its [scope](@)),
- a [versiontag](@) that allows the [terminology](@) to be identified (within its [scope](@)),
- a list of [term selection instructions](@) that specify the [terms](@) that are to be included (or removed) from the [terminology](@) as it is being constructed, and
- some meta-data (see the [documentation](/docs/specs/files/saf#versions).

Expand Down Expand Up @@ -89,7 +89,7 @@ In the syntax specification for [term selection instructions](@), we use the fol
| Symbol | Description |
| :----- | :---------- |
| `<key>` | a text that corresponds with a field name in an [MRG entry](@) of a designated [MRG](@), or the [header](@) (front-matter) of a [curated text](@). Examples: `term`, `grouptags`, `status`. |
| `<value>` | a text that is used to [identify](@) an [MRG entry](@) or a [curated text](@). |
| `<value>` | a text that is used to identify an [MRG entry](@) or a [curated text](@). |

</details>

Expand All @@ -108,7 +108,7 @@ However, any (existing) [MRG](@) can be used as an alternative source, by adding
The following syntaxes are available for adding all terms from a specific source to the [provisional MRG](@):

- **`*`**<br/>Add all [terms](@) that are described by a [curated texts](@) in the [current scope](@).<br/>&nbsp;
- **`* @<tid>`**<br/>Add all [terms](@) that have an [MRG entry](@) in the [MRG](@) as [identified](@) by the [terminology-identifier](@) `<tid>`. This [MRG](@) must have been made available in the [glossarydir](@) of the [current scope](@).
- **`* @<tid>`**<br/>Add all [terms](@) that have an [MRG entry](@) in the [MRG](@) as identified by the [terminology identifier](@) `<tid>`. This [MRG](@) must have been made available in the [glossarydir](@) of the [current scope](@).

<details>
<summary>Examples:</summary>
Expand All @@ -133,7 +133,7 @@ The following syntaxes are available for adding a selection of terms from a spec
- `<key>` is a text that corresponds with a field name in a [header](@) (front-matter) of a [curated text](@), such as `term`, `grouptags`, `status`, etc.
- `<value>`, `<value2>`, ... are texts that are used to determine whether or not a [curated text](@) is to be selected for inclusion in the [provisional MRG](@).<br/>&nbsp;
- **`<key>` [ `<value>`, `<value2>`, ... ] `@<tid>`**, where:
- `<tid>` is a [terminology identifier](@) that [identifies](@) an [MRG](@) (that must have been made available in the [glossarydir](@) of the [current scope](@)).
- `<tid>` is a [terminology identifier](@) that identifies an [MRG](@) (that must have been made available in the [glossarydir](@) of the [current scope](@)).
- `<key>` is a text that corresponds with a field name in an [MRG entry](@) that resides in that [MRG](@), such as `term`, `grouptags`, `status`, etc.
- `<value>`, `<value2>`, ... are texts that are used to determine whether or not an [MRG entry](@) from that [MRG](@) is to be selected for inclusion in the [provisional MRG](@).

Expand Down Expand Up @@ -196,7 +196,7 @@ In analogy with [namespaces](https://en.wikipedia.org/wiki/Namespace), we accomm
The following syntaxes are available for renaming fields in an [MRG entry](@) that is part of the [provisional MRG](@):

- **`rename` `<ttrm>` [ `<key>`:`<value>`, `<key2>:<value2>`, ... ]**, where:
- `<ttrm>` is the value of the `term` field in the [MRG entry](@) of the [provisional MRG](@) that is selected for the renaming process, which may optionally be preceded with `<termType>:` (where `<termType>` would then be the value of the `termType` field in that [MRG entry](@)). Note that this value is an [identifier](@) for that [MRG entry](@).
- `<ttrm>` is the value of the `term` field in the [MRG entry](@) of the [provisional MRG](@) that is selected for the renaming process, which may optionally be preceded with `<termType>:` (where `<termType>` would then be the value of the `termType` field in that [MRG entry](@)). Note that this value is an identifier for that [MRG entry](@).
- `<key>` is a text that corresponds with a field name in an [MRG entry](@) in the [provisional MRG](@), such as `formPhrases`, `glossaryText`, `grouptags`, `status`, etc.
- `<value>` is a text that will replace the existing text of the field identified by `<key>`. If the text contains multiple words, it is advised to surround it with quotes.

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/00-tev2-common-understanding.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export const mark = ({children}) => (
{children}
</span> );

In order for a [community](@) (e.g. a workgroup, taskforce, project/product team, department, etc.) to realize its [objectives](@), it is beneficial that its members have a common set of the ideas, [concepts](@) and other [semantic units](@) that are relevant for realizing these [objectives](@). The ability to realize such a common understanding, and to demonstrate that this is actually the case, is a critical capability for success.
In order for a [community](@) (e.g. a workgroup, taskforce, project/product team, department, etc.) to realize its [objectives](@essif-lab), it is beneficial that its members have a common set of the ideas, [concepts](@) and other [semantic units](@) that are relevant for realizing these [objectives](@essif-lab). The ability to realize such a common understanding, and to demonstrate that this is actually the case, is a critical capability for success.

The Terminology Engine (v2) is a set of specifications and tools that (technically) facilitate such capabilities, by recognizing that each [community](@) wants (and needs):

Expand Down
9 changes: 2 additions & 7 deletions docs/saf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,8 @@ versions:
termselection:
- "[action]@essif-lab"
- "rename action [id:act, term:act, formPhrases:'act{ss}']"
- "[party,actor,onboarding,action,organization,community,entity,legal-entity]@essif-lab"
- "[ssi,assertion,claim,credential,issue,verify,validate,transaction]@essif-lab"
- "[manage,management,governance,risk,owner,owned]@essif-lab"
- "[jurisdiction,objective,control,expectation,obligation]@essif-lab"
- "[control-objective,risk-objective,compliance-objective]@essif-lab"
- "[identity,partial-identity,identifier,identify,identification]@essif-lab"
- "[concept,relation,property,semantic-unit,terminology,vocabulary,knowledge]@essif-lab"
- "[action]@essif-lab"
- "[party,actor,organization,community,entity,legal-entity]@essif-lab"
- "*" # import all tev2 terms.
# - "termType[concept,acronym,abbreviation]" # import all of our own stuff (except patterns)
- "-excludeFromMRG[yes]" # exclude all curated texts whose `excludeFromMRG` field contains `yes`
6 changes: 3 additions & 3 deletions docs/specs/files/10-curated-text-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,13 @@ Different [TEv2 tools](@) use header fields in [headers](@) for various purposes

| Name | Req'd | Description |
| --------------- | :---: | ----------- |
| `termType` | n | [Text](term-type@) that [identifies](@) the kind of [semantic unit](@) that this [curated text](@) describes. Typical values would be `concept`, `relation`, `pattern` (or `mental-model`), or `usecase`. If not specified, its value defaults to the `defaulttype`-field in the [scope section](/docs/specs/files/saf#scope-section) of the [SAF](@). |
| `termType` | n | [Text](term-type@) that identifies the kind of [semantic unit](@) that this [curated text](@) describes. Typical values would be `concept`, `relation`, `pattern` (or `mental-model`), or `usecase`. If not specified, its value defaults to the `defaulttype`-field in the [scope section](/docs/specs/files/saf#scope-section) of the [SAF](@). |
| `term` | Y | text that is used to refer to the [semantic unit](@) that is documented by this [curated text](@). |
| `isa` | n | [Term identifier](@) that [identifies](@) the [semantic unit](@) of which this is a specialization. |
| `isa` | n | [Term identifier](@) that identifies the [semantic unit](@) of which this is a specialization. |
| `bodyFile` | n | Path, relative to the [scopedir](@), that contains the [body](@) of this [curated text](@). If not specified, the [body](@) in this file serves as the [body](@) of the [curated text](@). |
| `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 [community](@))`. |
| `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 [TermRefs](@). |
| `synonymOf` | n | [Term identifier](@) that [identifies](@) the defined [term](@) of the [semantic unit](@) for which this is a [synonym](@). |
| `synonymOf` | n | [Term identifier](@) that identifies the defined [term](@) of the [semantic unit](@) for 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]`. |
| `formPhrases` | n | List of [texts](form-phrase@) that are [used to convert](trrt#id@) the `show text` parts of [TermRefs](@) into `term`s, for the purpose of accommodating plural forms (for nouns) or conjugate forms (for verbs). For details, see [specifying form phrases](form-phrase#specifying@). |
| `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). |
Expand Down
8 changes: 4 additions & 4 deletions docs/specs/files/12-saf.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ The following fields are defined for the `scope` section of a [SAF](@):
| `scopedir` | Y | URL of the location of the [scopedir](@) associated with the [scopetags](@) listed in the `scopetags` field. |
| `curatedir` | Y | Path to the directory where all [curated files](@) are located. This directory may contain subdirectories to allow [curators](@) to organize the files in any way they see fit. Full URL is `<scopedir>`/`<curatedir>`. `curatedir` may also be an empty string. |
| `glossarydir` | Y | Path to the directory where all [glossary](@)-related files are located. Full URL is `<scopedir>`/`<glossarydir>`. This directory SHOULD contain one [MRG](@) for every element in the version-section in the [SAF](@). It MAY contain other files, e.g. [HRGs](@) or [HRG](@) templates, files that contain instructions, headers, footers or other things that are necessary for generating specific [glossaries](@). |
| `defaultvsn` | Y | [versiontag](@) that [identifies](@) the default [terminology](@) for this [scope](@). The associated [MRG](@) is located at `scopedir`/`glossarydir`/mrg.`scopetag`.`defaultvsn`.yaml |
| `defaultvsn` | Y | [versiontag](@) that identifies the default [terminology](@) for this [scope](@). The associated [MRG](@) is located at `scopedir`/`glossarydir`/mrg.`scopetag`.`defaultvsn`.yaml |
| `defaulttype` | n | Text that is used to identify the default kind of [semantic unit](@) for a [curated text](@). It is the default value for the `termType`-field in [curated texts](@). Default value for `defaulttype` is `concept`. |
| `website` | n | Base URL for creating links to rendered versions of [Curated Texts](@). It should also serve as the home page of the [terminology](@). If not specified, it is assumed to be the empty string. |
| `navpath` | n | Path to the directory where [Curated Texts](@) are rendered, relative to the value of `website`. What `curatedir` is for [Curated Texts](@), is `navpath` for the rendered versions of [Curated Texts](@). If not specified, it is assumed to be the empty string. |
Expand Down Expand Up @@ -121,7 +121,7 @@ It may be simpler to change the `scopetags`-field, which is currently a list of

### SAF Versions - Enabling changes and updates in a scope's Terminology {#versions}

The third section (called `versions`) in the [SAF](@) specifies the [terminologies](@) that are actively maintained by the [curators](@) of the [scope](@). Each such [terminology](@) is [identified](@) (within that [scope](@)) by a (main) [versiontag](@) and optionally also alternative [versiontags](@). The contents of a [terminology](@) is specified by so-called [term selection instructions](@). See the [Terminology Construction page](/docs/manuals/curator/terminology-construction) and the [term selection syntax page](/docs/specs/syntax/term-selection) for details.
The third section (called `versions`) in the [SAF](@) specifies the [terminologies](@) that are actively maintained by the [curators](@) of the [scope](@). Each such [terminology](@) is identified (within that [scope](@)) by a (main) [versiontag](@) and optionally also alternative [versiontags](@). The contents of a [terminology](@) is specified by so-called [term selection instructions](@). See the [Terminology Construction page](/docs/manuals/curator/terminology-construction) and the [term selection syntax page](/docs/specs/syntax/term-selection) for details.

This `versions` section contains a list of fields that each specify one [terminology](@) and some meta-data, e.g., regarding the state/validity of the [terminology](@) over time. This may be of interest to the [curators](@) of other [scopes](@) as they need to decide whether or not to import [terms](@) from such a [terminology](@).

Expand Down Expand Up @@ -171,11 +171,11 @@ The following fields are defined for the `versions` section of a [SAF](@):

| Name | Req'd | Description |
| ------------- | :---: | ----------- |
| `vsntag` | Y | [Versiontag](@) that that is used to [identify](@) this version within the set of all other versions that are maintained within this [scope](@). in this [SAF](@). It MUST NOT be changed during the lifetime of this version. |
| `vsntag` | Y | [Versiontag](@) that that is used to identify this version within the set of all other versions that are maintained within this [scope](@). in this [SAF](@). It MUST NOT be changed during the lifetime of this version. |
| `altvsntags` | n | List of alternative [versiontags](@) that may be used to refer to this version of the [scope's](@) [terminology](@). A typical use of this field would be to tag a version as the 'latest' version. |
| `termselection` | Y | List of [term selection instructions](@) that are used to generate (this version of) the [scope's](@) [terminology](@). See the [Terminology Construction page](/docs/manuals/curator/terminology-construction) and the [term selection syntax page](/docs/specs/syntax/term-selection) for details. |
| `license` | n | File that contains the (default) licensing conditions. Full URL is `scopedir`/`license`. If not specified, its value defaults to the value of the `license` field in the `scope` section (of this [SAF](@)). The purpose of this field is to allow different versions of the [scope's](@) [terminology](@) to have different licenses. |
| `status` | n | Text that [identifies](@) the status of the [term](@). ([Communities](@) of) [scopes](@) may specify values for this field. If not specified, the status SHOULD be assumed to be 'concept', 'draft', 'proposed', or similar. An example is the [status tags used by ToIP](https://github.com/trustoverip/concepts-and-terminology-wg/blob/master/docs/status-tags.md). |
| `status` | n | Text that identifies the status of the [term](@). ([Communities](@) of) [scopes](@) may specify values for this field. If not specified, the status SHOULD be assumed to be 'concept', 'draft', 'proposed', or similar. An example is the [status tags used by ToIP](https://github.com/trustoverip/concepts-and-terminology-wg/blob/master/docs/status-tags.md). |
| `from` | F | Date at which it was decided to establish this version. |
| `to` | F | Date at which this version will expire (or has expired). |

Expand Down
Loading

0 comments on commit d2e11a6

Please sign in to comment.