README.md 1.07 KB
Newer Older
Rieks Joosten's avatar
Rieks Joosten committed
1
2
# README for terminology-related files.

3
This document states the requirements for files in this directory, such that they can properly processed into useful and usable Docusaurus documentation.
Rieks Joosten's avatar
Rieks Joosten committed
4
5
6
7
8

## Filenames

All file MUST have the structure: `<scopeid>-<type>-<instanceid>.mdx`, where

9
10
- `<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:
Rieks Joosten's avatar
Rieks Joosten committed
11
12
13
14
15
  - `1-scope`
  - `2-pattern`
  - `3-concept`
  - `4-term`
  - `5-glossary`
16
- `<instanceid>` MUST be a lowercase identifier that only uses characters `a`-`z` and `-`.
Rieks Joosten's avatar
Rieks Joosten committed
17
18
19

## Templates

20
The `terminology/templates` directory contains templates for each of the types. A template file has comments that hold, amongst others, requirements for the contents of instances of that template.
Rieks Joosten's avatar
Rieks Joosten committed
21
22
23

## Referring to terms in documentation files

24
Any term can be referred to in any documentation file, using the syntax `%%<termref>%%`, where `<termref>` is either the `<conceptid>` of a concept
Rieks Joosten's avatar
Rieks Joosten committed
25

26
- `<sometext>` is a text that will be displayed as if it were a term
Rieks Joosten's avatar
Rieks Joosten committed
27