From eedf9a7301a37310d865cab161aa4f0b478b83a6 Mon Sep 17 00:00:00 2001 From: Rieks Date: Mon, 9 Oct 2023 13:57:38 +0200 Subject: [PATCH] improved `bodyFileID` doc Signed-off-by: Rieks --- docs/spec-files/11-saf.md | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/spec-files/11-saf.md b/docs/spec-files/11-saf.md index 67b3cbce03..559f270e8d 100644 --- a/docs/spec-files/11-saf.md +++ b/docs/spec-files/11-saf.md @@ -75,11 +75,11 @@ The following fields are defined for the `scope` section of a [SAF](@): | `scopedir` | Y | URL of the location of the [scopedir](@) associated with the [scopetags](@) listed in the `scopetags` field. | | `curatedir` | Y | Path to the directory where all [curated files](@) are located. This directory may contain subdirectories to allow [curators](@) to organize the files in any way they see fit. Full URL is ``/``.| | `glossarydir` | Y | Path to the directory where all [glossary](@)-related files are located. Full URL is ``/``. This directory SHOULD contain one [MRG](@) for every element in the version-section in the [SAF](@), and one or multiple [HRGs](@). It MAY contain other files, e.g. containing instructions, headers, footers or other things that are necessary for generating specific [glossaries](@). | +| `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 | Fieldname, used in the frontmatter of a [body file](@) that contains the nav-reference to be used in the TRRT. [to be elaborated/corrected] | -| `defaultvsn` | Y | [versiontag](@) that [identifies](@) the default [terminology](@) for this [scope](@). The associated [MRG](@) is located at `scopedir`/`glossarydir`/mrg.`scopetag`.`defaultvsn`.yaml | -| `license` | Y | File in the root of the [scopedir](@) that contains the (default) licensing data. | +| `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"). | +| `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.| | `curators` | n | Data that can be used to contact individual [curators](@). | @@ -87,13 +87,9 @@ The following fields are defined for the `scope` section of a [SAF](@): | `dateformat` | n | Regex (PCRE) that has named capturing groups for YYYY, MM and DD, and that can be used to parse the date fields used in this [scope](@) ) (provided another regex doesn't override it). When not provided, tools should use the regex "**(?P\d{4})-?(?P\d{2})-?(?P\d{2})(?PZ|[+-]\d{2}:\d{2})?**" for this (noting that in certain contexts, `\` characters may need to be escaped). | --> -:::info Editor's note -It might be more practical to move all of the stuff that is particular to this scope, but that is currently documented in the `scopes` section, to this section. We do then need to check throughout the documentation where that section is referenced, and correct such references. -::: - ### SAF Scopes - Mapping Scopetags and Scopedirs {#scopes} -The `scopetags` section is a list that specifies a mapping between [scopetags](@) as they are used in this [scope](@), and the associated [scopedir](@). +The `scopes` section is a list that specifies a mapping between a [scopetag](@) as they are used in this [scope](@), and its associated [scopedir](@). If you want to use multiple [scopetags](@) to refer to one particular (other) [scope](@), each of them needs its own mapping.
Example of a `scopes` section