README.md 1.06 KB
Newer Older
Rieks Joosten's avatar
Rieks Joosten committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# README for terminology-related files.

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