This document states the requirements for files in this directory, such that they can properly processed into useful and useable Docusaurus documentation.
## Filenames
All file MUST have the structure: `<scopeid>-<type>-<instanceid>.mdx`, where
-<scopeid> is the (all lowercase) identifier of an existing scope, i.e. the file `<scopeid>-1-scope.mdx` must exist.
-<type> MUST be any of the following:
-`1-scope`
-`2-pattern`
-`3-concept`
-`4-term`
-`5-glossary`
-<instanceid> MUST be a lowercase identifier that only uses charancters `a`-`z` and `-`.
## Templates
The `terminology/templates` directory contains templates for each of the <type>s. A template file has comments that hold, amongst others, requirements for the contents of instances of that template.
## Referring to terms in documentation files
Any term can be referred to in any documentation file, using the syntax %%<termref>%%, where <termref> is either the <conceptid> of a concept
-<sometext> is a text that will be displayed as if it were a term
<!--A %%pattern%% capture a set of %%concepts:concept%%, relations between them, and rules or constraints that (instances) thereof comply with. As such, it is a concise and possibly formal description of a coherent set of ideas, a mental model if you will, that can be used to facilitate one's thinking about/with these concepts.
<!--A %%glossary%% is a list of %%terms:term%% with (short) explanations, usually aimed to help people understand texts around a certain (set of) topic(s) in some context(s).-->
<!--A %%pattern%% capture a set of %%concepts:concept%%, relations between them, and rules or constraints that (instances) thereof comply with. As such, it is a concise and possibly formal description of a coherent set of ideas, a mental model if you will, that can be used to facilitate one's thinking about/with these concepts.
<!--A %%concept%% tries to capture the idea behind a classification of %%entities:entity%%, allowing us to reason about everything in the class as if it were one thing. This file specifies the idea(s) that, within the scope of `<ExistingScope>` will be referred to using the %%term%% `<NewConcept>`.
<!--A %%glossary%% is a list of %%terms:term%% with (short) explanations, usually aimed to help people understand texts around a certain (set of) topic(s) in some context(s).-->
## Scope
<!-- *REQUIRED* Short text (label, abbreviation) that can be used within eSSIF-Lab (or beyond) to refer to the scope within which this glossary resides. The default is essifLab.-->
essifLab
## Purpose
<!--State the purpose(s) that this glossary aims to fulfill, in such a way that readers can easily determine whether or not it is useful for them to use it.-->
This glossary lists the basic concepts that are needed by the various stakeholders within the eSSIF-Lab project, ranging from governance, business, process, technology etc. The idea is that it defines at least the set of concepts that are often used in these varied domains, allowing a reader with a specific background to learn how the concept is used from other (valid) perspectives that may be alien to him/her.
## Sources
<!--Here, the sources should be identified from which the glossary entries (and their descriptions) are to be collected-->
### Include
<!--Specify the %%scope-files:scope-file%% that are to serve as a source for this glossary-->
* eSSIF-Lab
### Terms
<!--Specify the %%term-files:term-file%% that are to serve as a source for this glossary. If a term is defined in a scope as well as in a %%term-file%%, the latter takes precedence.-->
### Patterns
<!--Specify the %%pattern-files:pattern-file%% that are to serve as a source for this glossary. If a term is defined in a scope or as a term as well as in a %%pattern-file%%, the latter takes precedence.-->
### Concepts
<!--Specify the %%concept-files:concept-file%% that are to serve as a source for this glossary. If a term is defined in a scope, or as a term, or in a pattern as well as in a %%concept-file%%, the latter takes precedence.-->
<!--
---
## Footnotes
[//]: # This (optional) section contains any footnotes that may have been specified in the text above.
