From 56f4912bcadba4b193093bb26b05bc4423563069 Mon Sep 17 00:00:00 2001 From: Rieks Date: Mon, 9 Oct 2023 14:03:05 +0200 Subject: [PATCH] update SAF so it includes `bodyFileID` Signed-off-by: Rieks --- docs/saf.yaml | 6 +++--- docs/spec-files/11-saf.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/saf.yaml b/docs/saf.yaml index ee992433a5..5d6179744d 100644 --- a/docs/saf.yaml +++ b/docs/saf.yaml @@ -10,9 +10,10 @@ scope: scopedir: https://github.com/tno-terminology-design/tev2-specifications/tree/master/docs # 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` + defaultvsn: documentation # vsntag that identifies the default terminology. MRG is located at `scopedir`/`glossarydir`/mrg.tev2.latest.yaml website: https://tno-terminology-design.github.io/tev2-specifications/docs # base URL for creating links to rendered versions of Curated Texts. It should also serve as the home page of the Tterminology. navpath: /terms # Path to the directory where Curated Texts are rendered. What `curatedir` is for Curated Texts is, `navpath` is for the rendered versions of Curated Texts. - defaultvsn: documentation # vsntag that identifies the default terminology. MRG is located at `scopedir`/`glossarydir`/mrg.tev2.latest.yaml + bodyFileID: id # Name of the field in the front matter of a [body file](@) used by your static site generator in a URL, to uniquely identify that file (e.g., "id", "slug", "permalink"). If not specified, the filename of the [body file](@) will be used. | 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 semantic units in this scope issues: https://github.com/tno-terminology-design/tev2-specifications/issues # URL where issues can be raised and handled @@ -38,16 +39,15 @@ scopes: # # versions: - vsntag: terms # this version contains all terms that are curated within this scope - altvsntags: [ latest ] # alternative verstiontags termselection: - "*" # import all tev2 terms. - vsntag: documentation # terms that are needed for this specification + altvsntags: [ latest ] # alternative verstiontags termselection: - "term[act,actor,action,community,control,entity,knowledge]@essif-lab" - "term[manage,management,govern,governance,objective,owner,owned]@essif-lab" - "term[partial-identity,identifier,identity]@essif-lab" - "term[pattern-party-actor-action,pattern-jurisdiction]@essif-lab" - - "term[pattern-terminology]@essif-lab" - "term[pattern-identity,pattern-identification]@essif-lab" - "*" # import all tev2 terms. - vsntag: test # this version MUST only be used for testing the MRG generator diff --git a/docs/spec-files/11-saf.md b/docs/spec-files/11-saf.md index 559f270e8d..e4818323f8 100644 --- a/docs/spec-files/11-saf.md +++ b/docs/spec-files/11-saf.md @@ -78,7 +78,7 @@ The following fields are defined for the `scope` section of a [SAF](@): | `defaultvsn` | Y | [versiontag](@) that [identifies](@) the default [terminology](@) for this [scope](@). The associated [MRG](@) is located at `scopedir`/`glossarydir`/mrg.`scopetag`.`defaultvsn`.yaml | | `website` | n | base URL for creating links to rendered versions of [Curated Texts](@). It should also serve as the home page of the [terminology](@). | | `navpath` | n | Path to the directory where [Curated Texts](@) are rendered. What `curatedir` is for [Curated Texts](@), is `navpath` for the rendered versions of [Curated Texts](@). | -| `bodyFileID` | n | Name of the field in the front matter of a [body file](@) used by your static site generator in a URL, to uniquely identify that file (e.g., "id", "slug", "permalink"). | +| `bodyFileID` | n | Name of the field in the front matter of a [body file](@) used by your static site generator in a URL, to uniquely identify that file (e.g., "id", "slug", "permalink"). If not specified, the filename of the [body file](@) will be used. | | `license` | n | File in the root of the [scopedir](@) that contains the (default) licensing data. | | `statuses` | n | Ordered list of [tags](@) that are defined in this [scope](@) for specifying stages in the life-cycle of [semantic units](@). The first element in the list represents the first stage, and the last element the last stage in the life-cycle. | | `issues` | n | URL where issues can be reported and handled.|