saf.yaml

#
# This is a Scope Administration File that can be used in conjunction with TEv2.
#
# The first section defines meta-data concerning the scope itself, both for technical use and human use.
# It shows where directories and files live that ar part of the scope, and also
# ways in which people can contribute, raise issues, see what's going on, discuss, etc.
#
scope:
  scopetag: tev2 # identifier that curators have determined for this terminology
  scopedir: https://github.com/essif-lab/framework/tree/master/docs/tev2  # URL of the scope-directory
  curatedir: terms # directory where all curated files are located. Full URL is `scopedir`/`curatedir`
  glossarydir: glossaries # directory where all glossary files and GDFs are located. Full URL is `scopedir`/`glossarydir`
  mrgfile: mrg.mrgtest.yaml # file that contains the (default) machine readable glossary. Full URL is `scopedir`/`mrgfile`
  hrgfile: glossary # file that contains the (default) human readable glossary. Full URL is `scopedir`/`hrgfile`
  license: LICENSE.md # file that contains the (default) licensing conditions. Full URL is `scopedir`/`license`
  statuses: [ proposed, approved, deprecated ] # list of status tags that are defined for terminological artifacts in this scope
  issues: https://github.com/essif-lab/framework/issues # URL where issues can be raised and handled
  website: https://essif-lab.github.io/framework/docs/tev2/tev2-overview # home page of the terminology
  slack: https://trustoverip.slack.com/archives/C01BBNGRPUH # slack channel for discussions
  curators: # contacting individual curators
  - name: RieksJ
    email: # we split up the email address to reduce the likelihood of the address being harvested for spamming
      id: rieks.joosten
      at: tno.nl
#
# The second section contains a mapping between scopetags that are used within the scope, and the associated scopedirs.
# This enables tools to find the [SAF](@) of these [scopes](@), and from there all other directories, files etc.
# that live within them, e.g. to use/import their data.
#
scopes:  #
- scopetags: # definition of (scope) tag(s) that are used within this scope to refer to a specific terminology
  - essiflab
  - essif-lab
  scopedir: https://github.com/essif-lab/framework/tree/master/docs # URL of the scope-directory
- scopetags: # definition of (scope)tag(s) that are used within this scope to refer to a specific terminology
  - ctwg
  - toip-ctwg
  scopedir: https://github.com/trustoverip/ctwg # URL of the scope-directory
#
# The third section specifies the versions that are actively maintained by the curators.
# For each version, the set of terms is selected that constitute the terminology.
# See the Glossary Generation Tool (GGT) for details about the syntax and semantics.
#
versions:
  - vsntag: mrgtest # this version MUST only be used for testing the MRG generator
    terms:
    - "[tev2]@tev2" # import all tev2 terms.
  - vsntag: 0x921456 # a versiontag that identifies this version from all other versions in the SAF
    altvsntags: # alternative verstiontags
    - latest
    - v0.9.4
    terms:
    - "[management]@essif-lab" # import all terms from the mrg of `essif-lab:latest` that have grouptag `management`.
    - "[party](@essif-lab:0.9.4)" # import the term `party` from the mrg of `essif-lab:0.9.4`.
    - "[community](@essif-lab:0.9.4)" # import the term `community` from the mrg of `essif-lab:0.9.4`.
    - "[tev2]@tev2" # import all terms defined in the scope `tev2`
    status: proposed
    from: 20220312
    to:
  - vsntag: 0x654129 # a versiontag that identifies this version from all other versions in the SAF
    altvsntags: # alternative verstiontags
    - v0.9.0
    terms:
    - "[management]@essif-lab" # import all essif-lab terms with grouptag `management`.
    - "[party@essif-lab]" # import the term `party` from the mrg of `essif-lab:latest`.
    - "[community@essif-lab]" # import the term `community` from the mrg of `essif-lab:latest`.