Skip to content

Commit

Permalink
added warnings for generating HRGs for MRGs outside the default scope…
Browse files Browse the repository at this point in the history
… (issue tev2-tools#25)

Signed-off-by: Rieks <RieksJ@users.noreply.github.com>
  • Loading branch information
RieksJ committed Apr 1, 2024
1 parent a3101df commit 7752aad
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/specs/syntax/41-mrg-refs.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ The default syntax for [MRGRefs](@) is as follows:
where

- `<tid>` is a [terminology identifier](@), that identifies a [terminology](@) (and implies an associated [MRG](@)) within the [current scope](@). If empty, or unspecified, it defaults to the default [terminology](@) of the [current scope](@).

:::warning ([issue #25](https://github.com/tno-terminology-design/tev2-tools/issues/25))
When the `<tid>` points to a [scope](@) that is not the [current scope](@), the [TermRefs](@) that appear in the generated glossary must be resolved using the [MRG](@) that contains the identified [terminology](@). Currently, the tools do not support a mechanism for doing this.
:::

- `converter="<converter>"` specifies the [converter](@) that is to be used for generating glossary entries. If it isn't specified as part of the [MRGRef](@), it must be specified as a command-line parameter, or as a value in the configuration file that the [HRGT](@) uses.
- `<converter>` is a text that specifies either:
- a predefined way in which glossary entries are being formatted (see [further down](#predefined-mrgref-converters)), such as `markdowntable` or `essif-lab`;
Expand Down
4 changes: 4 additions & 0 deletions docs/specs/tools/22-hrgt.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,10 @@ The [interpreter profile](@) of the [HRGT](@) consist of the following [named ca
Note that the values of these specified [capturing groups](@) will be [regularized](regularize@) before they are used for [processing](#processing).
:::

:::warning ([issue #25](https://github.com/tno-terminology-design/tev2-tools/issues/25))
When the `hrg` identifies a [terminology](@) that is not part of the [current scope](@), the [TermRefs](@) that appear in the generated glossary must be resolved using the [MRG](@) that contains the identified [terminology](@). Currently, the tools do not support a mechanism for doing this.
:::

### HRGT Predefined Interpreters {#predefined-interpreters}

The [HRGT](@) has only one predefined [interpreter](@), which is called `default`, the syntax of which is:
Expand Down

0 comments on commit 7752aad

Please sign in to comment.