documentation in gfm-format examples (dir renamed from multi)

1 files changed, 22 insertions, 0 deletions

diff --git a/examples/gfm-format/Words.gfm b/examples/gfm-format/Words.gfm
new file mode 100644
index 000000000..0e3aafb3e
--- /dev/null
+++ b/examples/gfm-format/Words.gfm
@@ -0,0 +1,22 @@
+-- Baseline of .gfm format: multilingual word lists (see Food.gfm for multi-module gf)
+-- The compiler recognizes the suffix .gfm and creates four files:
+--   Words.gf, WordsEng.gf, WordsFin.gf, WordsSwe.gf
+-- The first non-comment line must give a list of lang names.
+-- The prefix comes from this file, as well as the abstract name.
+-- Languages are separated by ';', variants within a language by ','.
+-- Multi-word expressions are allowed.
+-- The startcat is S.
+-- The abstract name is multi_word_S for the first multi word (or word) on each line.
+-- This file must be UTF-8 encoded.
+
+> langs Eng Swe Fin
+
+house ; hus ; talo
+car, automobile ; bil ; auto
+man ; man ; mies
+girl ; flicka, tjej ; tyttö
+technical university ; teknisk högskola ; teknillinen korkeakoulu
+
+
+
+