Clarify indentation vs aligment

This commit is contained in:
Midgard 2021-06-18 23:00:35 +02:00
parent 0a23e59fed
commit d7ee8f756b
Signed by: midgard
GPG key ID: 511C112F1331BBB4

View file

@ -3,10 +3,23 @@
HLDS is the Haldis Language for Describing Servings. It defines the menu you see when ordering in
Haldis.
There is syntax highlighting support for editors in `etc/` in the Haldis repository.
There is syntax highlighting support for editors in [`etc/` in the Haldis
repository](https://git.zeus.gent/haldis/haldis/-/tree/master/etc). For VSCode there is a plug-in
in the standard repository.
## Indentation
Indentation requires hard **tabs**. Spaces will not work.
Indentation at the beginning of the line requires hard **tabs**. Spaces will not work.
For alignment (putting things in the same column between lines) spaces are allowed. Example (`↦`
for tab and `·` for space):
```
dish·fries:·Frietjes
↦ single_choice size:·Formaat
↦ ↦ extra_small:·Extra small·€·1.8
↦ ↦ small:·······Small·······€·2
↦ ↦ medium:······Medium······€·2.5
↦ ↦ large:·······Large·······€·3.3
```
## Identifiers
You must choose an identifier for each location, dish, choice, option and tag. Identifiers may