From d7ee8f756bcfd2c0ab74a61d943c8f72f4d7c6e2 Mon Sep 17 00:00:00 2001 From: Midgard Date: Fri, 18 Jun 2021 23:00:35 +0200 Subject: [PATCH] Clarify indentation vs aligment --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 51aee8c..3d82042 100644 --- a/README.md +++ b/README.md @@ -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