From 5329de67a117ff0e65b03ec9c1c1f8326ae8e83f Mon Sep 17 00:00:00 2001 From: Kees Date: Mon, 2 Oct 2023 17:04:50 +0200 Subject: [PATCH 1/2] Update 11-saf.md --- docs/spec-files/11-saf.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/spec-files/11-saf.md b/docs/spec-files/11-saf.md index a4e3e72191..367d425e63 100644 --- a/docs/spec-files/11-saf.md +++ b/docs/spec-files/11-saf.md @@ -138,7 +138,7 @@ It may be simpler to change the `scopetags`-field, which is currently a list of 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 criteria](@). The [Terminology Construction page](/tev2-specifications/docs/spec-tools/terminology-construction) documents the kinds of [term selection criteria](@) that are available, and how they work in the [term](@) selection process. -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 of interest for the [curators](@) of other [scopes](@) as they need to decide whether or not to import [terms](@) from such a [terminology](@). +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](@). There must be at least one such field in the `versions` section, namely a field that specifies the default [terminology](@) of the scope, i.e., the [terminology](@) that is identified by the [versiontag](@) that is specified in the `defaultvsn` field of [the `scope` section](/tev2-specifications/docs/spec-files/saf#terminology) of the [SAF](@). From 9ae86ffeec546e9f57fbcff123c3f75e16187741 Mon Sep 17 00:00:00 2001 From: Ca5e Date: Mon, 2 Oct 2023 17:44:39 +0200 Subject: [PATCH 2/2] Update Terminology Construction --- .../spec-tools/20-terminology-construction.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/spec-tools/20-terminology-construction.md b/docs/spec-tools/20-terminology-construction.md index 1dc4a8577e..3b080cde43 100644 --- a/docs/spec-tools/20-terminology-construction.md +++ b/docs/spec-tools/20-terminology-construction.md @@ -12,7 +12,7 @@ import TabItem from '@theme/TabItem'; # Terminology Construction [Curators](@) need the ability to construct (different versions of) the [terminology](@) for any [scope](@) they [curate](@). This page documents -1. the way in which a [curator](@) can specify this for a [scope](@) that (s)he [curates](@), and +1. the way in which a [curator](@) can specify this for a [scope](@) that they [curate](@), and 2. how that specification is used to create the associated [terminology](@). The actual creation of a [terminology](@), and the subsequent generation of the [MRG](@) that contains it, is done by the [MRGT](@). @@ -30,7 +30,7 @@ A [curator](@) specifies a [terminology](@) by creating a new entry in the [`ver The creation of a [terminology](@) is equivalent with the creation of the set of [MRG entries](@) that document each of the [terms](@) therein. Thus, the process for creating a [terminology](@) can be described as follows: 1. start with an empty set of [MRG entries](@) - we use the term "[terminology under construction](@)" to refer to this set. 2. sequentially process the list of [term selection criteria](@) as specified in the appropriate entry of the [`versions` section](tev2-specifications/docs/spec-files/saf#versions) of the [SAF](@), i.e. instructions which allow for - - [adding](#syntax-add) [MRG entries](@) to the [terminology under construction](@); these can either be [entries](mrg-entry@) that have been created from [curated texts](@), or [entries](mrg-entry@) whose contents is obtained from an [MRG](@) other than the one that is being created. + - [adding](#syntax-add) [MRG entries](@) to the [terminology under construction](@); these can either be [entries](mrg-entry@) that have been created from [curated texts](@), or [entries](mrg-entry@) whose contents are obtained from an [MRG](@) other than the one that is being created. - [removing](#syntax-remove) [MRG entries](@) from the [terminology under construction](@); - [modifying attributes](#syntax-rename) of a specific [MRG entry](@) in the [terminology under construction](@), e.g. for renaming a term that originated from another [scope](@). ## Prerequisites @@ -43,15 +43,15 @@ In the syntax specification for [term selection criteria](@), we use the followi | Symbol | Description | | :----- | :---------- | -| `` | a text that corresponds with a field name in a [MRG entry](@) or the [header](@) (front-matter) of a [curated text](@), e.g., `term`, `grouptags`, `status`. | -| `` | a text that is used to [identify](@) an [MRG entry](@) or a [curated text](@). | -| `` | an (**optional**) text of the form `@`, that [identifies](@) the source from where [terms](@) are to be selected.
If omitted, the source is the set of [curated texts](@) that are maintained within the current scope. .
If specified, the source is the [MRG](@) identified by `` (where `` is a [terminology-identifier](@)). Note that this [MRG](@) is expected to have been [made available](mrg-importer@) within the current scope. | +| `` | A text that corresponds with a field name in a [MRG entry](@) or the [header](@) (front-matter) of a [curated text](@), e.g., `term`, `grouptags`, `status`. | +| `` | A text that is used to [identify](@) an [MRG entry](@) or a [curated text](@). | +| `` | An (**optional**) text of the form `@`, that [identifies](@) the source from where [terms](@) are to be selected.
If omitted, the source is the set of [curated texts](@) that are maintained within the current scope.
If specified, the source is the [MRG](@) identified by `` (where `` is a [terminology-identifier](@)). Note that this [MRG](@) is expected to have been [made available](mrg-importer@) within the current scope. | ## Adding Terms {#syntax-add} Adding terms is done using instructions that identify one or more [MRG entries](@) or [curated texts](@) that are not in the [terminology-under-construction](@). -The `` parameter, if it is provided, specifies the [MRG](@) within which [MRG entries](@) are to be searched. If the `` parameter is not provided, the set of [curated texts](@) in the current scope are used for searching. Both [MRG entries](@) and [headers](@) of [curated texts](@) contain fields that are examined to determine whether or not the [MRG entry](@) or [curated text](@) are to be used for inclusing in the [terminology-under-construction](@). +The `` parameter, if it is provided, specifies the [MRG](@) within which [MRG entries](@) are to be searched. If the `` parameter is not provided, the set of [curated texts](@) in the current scope is used for searching. Both [MRG entries](@) and [headers](@) of [curated texts](@) contain fields that are examined to determine whether or not the [MRG entry](@) or [curated text](@) are to be used for inclusion in the [terminology-under-construction](@). ### `* ` @@ -119,7 +119,7 @@ In analogy with [namespaces](https://en.wikipedia.org/wiki/Namespace), we accomm
Syntax examples -| Instruction | What it does when it is processed | +| Instruction | What it does when it is processed: | | :---------- | :---------- | | `rename party partij` | renames the [term](@) that is currently associated with the [term](@) `party` into `partij`. | @@ -127,13 +127,13 @@ In analogy with [namespaces](https://en.wikipedia.org/wiki/Namespace), we accomm where: -| symbol | description | -| --------------------- | :---------- | -| `` | the [term](@) of the tuple that will be selected for renaming. | -| `` | a (non-empty) comma-separated list of ``s. | -| `` | a `:` pair. | -| `` | a text that identifies a field in an [MRG entry], the value of which is to be changed, e.g. `formphrases`, `grouptags`, etc. | -| `` | a text that will replace the existing text of the field identified by ``. | +| Symbol | Description | +| :-------------------- | :---------- | +| `` | The [term](@) of the tuple that will be selected for renaming. | +| `` | A (non-empty) comma-separated list of ``s. | +| `` | A `:` pair. | +| `` | A text that identifies a field in an [MRG entry], the value of which is to be changed, e.g. `formphrases`, `grouptags`, etc. | +| `` | A text that will replace the existing text of the field identified by ``. | This syntax is processed by first selecting the tuple (in the tuple set that is being constructed) that has the specified `` as its `term`-field, and then sequentially processing the ``s in the ``, which means that the existing text of the field that is identified by the `` element of the `` is replaced by the text specified by the `` element of that ``.