Skip to content

Commit

Permalink
Add macromap to documentation tno-terminology-design#27
Browse files Browse the repository at this point in the history
  • Loading branch information
Ca5e committed Feb 4, 2024
1 parent 7bf9220 commit 64e9d1c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/specs/files/90-configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ output: . # (root) directory for output files to be written to
## Machine Readable Glossary Tool
mrgt:
vsntag: # versiontag for which the MRG needs to be (re)generated. Leave empty to process all versions
macros: # macros to be used for formPhrases
"{ss}": ["", "s", "'s", "(s)"]
"{yies}": ["y", "y's", "ies"]

## Human Readable Glossary Tool
hrgt:
Expand Down Expand Up @@ -122,6 +125,7 @@ Parameters that are specific to the [MRGT](mrgt@) can be put in the YAML section
| `onNotExist: <action>` | n | The action in case an MRG file unexpectedly does not exist. |
| `vsntag: <vsntag>` | n | Versiontag for which the MRG needs to be (re)generated. |
| `prune: <bool>` | n | If `<bool>` is `true`, remove all [MRG](@) files in the local scope from the [glossarydir](@) where the vsntag (or altvsntag) is not administered in the [SAF](@) |
| `macros: <macromap>` | n | A map of macros to be used to evaluate the `formPhrases` field of a [curated text](@). |

The `<action>` parameter can take the following values.

Expand All @@ -132,6 +136,8 @@ The `<action>` parameter can take the following values.
| `'log'` | A message is written to a log(file) and processing continues. |
| `'ignore'` | Processing continues as if nothing happened. |

The `<macromap>` parameter is a map of macros to be used to evaluate the `formPhrases` field of a [curated text](@). The map is a list of key-value pairs, where the key is the macro (e.g., `{ss}`, or `{yies}`), and the value is a list of the subsequent replacements (e.g., `["", "s", "'s", "(s)"]`, or `["y", "y's", "ies"]`). See [configuration file example](#configuration-files-for-tev2-tools) and [form phrases](@) for more information.

</TabItem>

<TabItem value="hrgt">
Expand Down

0 comments on commit 64e9d1c

Please sign in to comment.