Skip to content

Commit

Permalink
updated SAF documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Rieks <RieksJ@users.noreply.github.com>
  • Loading branch information
RieksJ committed Dec 9, 2023
1 parent 96f2a7a commit 35e68f1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 27 deletions.
9 changes: 2 additions & 7 deletions docs/spec-files/21-saf.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,11 @@ date: 20230103

import useBaseUrl from '@docusaurus/useBaseUrl'

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Scope Administration File (SAF)

Every [scope](@) MUST have exactly one Scope Administration File or [SAF](@), i.e. a file contains whatever needs to be administered in the [scope](@), and that various tools need to find e.g. the [scope's](@) [MRG](@), [curated texts](@), [scopetags](@), etc.

The [SAF](@) MUST be located in the (root of the) [scopedir](@), and is called `saf.yaml`. It is to be created and maintained by the [curators](@) of the [scope](@).
A **Scope Administration File (SAF)** is a [YAML](https://yaml.org/) file, named `saf.yaml`, that provides a centralized record of the resources available in that [scope](@), facilitating their access by various tools involved in terminology management. It specifies where its [curated texts](@), [glossaries](@) etc. live, the relationships it has with other [scopes](@), and the specifications of the different [terminologies](@) that are [curated](@) within that [scope](@). The SAF of a [scope](@) is located in its [scopedir](@).

This document specifies the structure of such [SAFs](@).
The directory within which the [SAF](@) lives, is the [scopedir](@) of the [scope](@) that it serves.

## Scope Administration File Field Descriptions

Expand Down
21 changes: 1 addition & 20 deletions docs/terms/saf.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ id: saf
# TEv2 Curated Text Header
term: saf
termType: concept
isa:
bodyFile: /spec-files/21-saf.md
glossaryTerm: Scope Administration File (SAF)
glossaryText: "a YAML file that contains essential data about a particular [scope](@) (e.g., specifying where its [curated texts](@), [glossaries](@) etc. live), the relationships this [scope](@) has with other [scopes](@), and the specifications of the different [terminologies](@) that are [curated](@) within that [scope](@). The SAF of a [scope](@) is located in its [scopedir](@)."
hoverText: "SAF: a YAML file that contains essential data about a particular scope, such as the locations of the scope's curated texts, glossaries, and the specifications of the curated terminologies. The SAF is located in the so-called scopedir."
Expand All @@ -20,22 +20,3 @@ contributors: RieksJ
attribution: "[TNO Terminology Design](https://tno-terminology-design.github.io/tev2-specifications/docs)"
originalLicense: "[CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/?ref=chooser-v1)"
---

# SAF (Scope Administration File)

The **Scope Administration File (SAF)** is a YAML file that contains essential data about a particular [scope](@) (e.g., specifying where its [curated texts](@), [glossaries](@) etc. live), the relationships this [scope](@) has with other [scopes](@), and the specifications of the different [terminologies](@) that are [curated](@) within that [scope](@). The SAF of a [scope](@) is located in its [scopedir](@).

The SAF specifies the location and details of [machine-readable glossaries (MRGs)](@), [human-readable glossaries (HRGs)](@), [machine-readable dictionaries (MRDs)](@), [human-readable dictionaries (HRDs)](@), [curated texts](@), and other related resources within a specific [scope](@). It provides a centralized record of the resources available in that [scope](@), facilitating their access by various tools involved in terminology management.

Additionally, the SAF outlines the criteria and meta-data that define the contents of each resource, ensuring clarity and consistency in the curation and management of terminological assets.

The SAF itself lives in the [scopedir](@), i.e., the 'root' directory of the [scope](@).
## Specifications and Examples

1. The structure of the SAF is specified [here](/docs/spec-files/saf), which also provides an example.
2. The repository that hosts this documentation has a [real-life example](https://github.com/tno-terminology-design/tev2-specifications/blob/main/docs/saf.yaml)

## Notes

- The SAF acts as a comprehensive index and reference for all terminological resources and configurations within a scope.
- Properly defining and maintaining the SAF is essential for ensuring seamless collaboration and efficient terminology management.

0 comments on commit 35e68f1

Please sign in to comment.