From 9b6f775b760883b49fd9c56580f22dc5933a7d2a Mon Sep 17 00:00:00 2001
From: aarne <aarne@chalmers.se>
Date: Wed, 1 Dec 2010 08:10:23 +0000
Subject: [PATCH] documentation in gfm-format examples (dir renamed from multi)

---
 examples/{multi => gfm-format}/Food.gfm |  9 ++++++++-
 examples/gfm-format/Words.gfm           | 22 ++++++++++++++++++++++
 examples/multi/Koe.gfm                  | 12 ------------
 3 files changed, 30 insertions(+), 13 deletions(-)
 rename examples/{multi => gfm-format}/Food.gfm (79%)
 create mode 100644 examples/gfm-format/Words.gfm
 delete mode 100644 examples/multi/Koe.gfm

diff --git a/examples/multi/Food.gfm b/examples/gfm-format/Food.gfm
similarity index 79%
rename from examples/multi/Food.gfm
rename to examples/gfm-format/Food.gfm
index 12a47949a..feb3dfcf6 100644
--- a/examples/multi/Food.gfm
+++ b/examples/gfm-format/Food.gfm
@@ -1,4 +1,11 @@
--- baseline
+-- Full .gfm format: multi-module files (see Words.gfm for a baseline format)
+-- The compiler recognizes the suffix .gfm and a file for each module.
+--   Food.gf, FoodEng.gf, FoodIta.gf
+-- The first non-comment line must give a list of lang names for the top modules.
+-- This modules are the ones imported in 'import Food.gfm'.
+-- Their prefix comes from this file.
+-- This file must be UTF-8 encoded.
+
 
 > langs Eng Ita
 
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
+
+
+
+
diff --git a/examples/multi/Koe.gfm b/examples/multi/Koe.gfm
deleted file mode 100644
index d8fed0e53..000000000
--- a/examples/multi/Koe.gfm
+++ /dev/null
@@ -1,12 +0,0 @@
--- baseline
-
-> 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
-
-
-
-