From 72da663163372ef88eba51c15d8f8ff4fd49c3b4 Mon Sep 17 00:00:00 2001
From: Lucien Cartier-Tilet <lucien@phundrak.com>
Date: Wed, 29 Jan 2020 22:01:38 +0100
Subject: [PATCH] Variables documentation

---
 funcs.el | 161 ++++++++++++++++++++++++++++++-------------------------
 1 file changed, 88 insertions(+), 73 deletions(-)

diff --git a/funcs.el b/funcs.el
index a5bd4fe..a73d788 100644
--- a/funcs.el
+++ b/funcs.el
@@ -111,70 +111,81 @@ whose first element equals `elem'"
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;                Mattér               ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-(setq conlanging//matter-latin-to-runes '((", *" . "᛬")
-                                          ("\\. *" . "᛭")
-                                          (" +" . "᛫")
-                                          ("ċ" . "ᛇ")
-                                          ("ch" . "ᛇ")
-                                          ("ae" . "ᚫ")
-                                          ("æ" . "ᚫ")
-                                          ("dh" . "ᛋ")
-                                          ("z" . "ᛋ")
-                                          ("ð" . "ᛋ")
-                                          ("th" . "ᚦ")
-                                          ("s" . "ᚦ")
-                                          ("þ" . "ᚦ")
-                                          ("w" . "ᚹ")
-                                          ("ƿ" . "ᚹ")
-                                          ("g" . "ᚷ")
-                                          ("ᵹ" . "ᚷ")
-                                          ("ea" . "ᛠ")
-                                          ("f" . "ᚠ")
-                                          ("u" . "ᚢ")
-                                          ("o" . "ᚩ")
-                                          ("r" . "ᚱ")
-                                          ("c" . "ᚳ")
-                                          ("h" . "ᚻ")
-                                          ("n" . "ᚾ")
-                                          ("i" . "ᛁ")
-                                          ("j" . "ᛄ")
-                                          ("p" . "ᛈ")
-                                          ("v" . "ᛝ")
-                                          ("t" . "ᛏ")
-                                          ("b" . "ᛒ")
-                                          ("e" . "ᛖ")
-                                          ("m" . "ᛗ")
-                                          ("l" . "ᛚ")
-                                          ("d" . "ᛞ")
-                                          ("é" . "ᛟ")
-                                          ("a" . "ᚪ")
-                                          ("y" . "ᚣ")))
+(defvar conlanging//matter-latin-to-runes '((", *" . "᛬")
+                                            ("\\. *" . "᛭")
+                                            (" +" . "᛫")
+                                            ("ċ" . "ᛇ")
+                                            ("ch" . "ᛇ")
+                                            ("ae" . "ᚫ")
+                                            ("æ" . "ᚫ")
+                                            ("dh" . "ᛋ")
+                                            ("z" . "ᛋ")
+                                            ("ð" . "ᛋ")
+                                            ("th" . "ᚦ")
+                                            ("s" . "ᚦ")
+                                            ("þ" . "ᚦ")
+                                            ("w" . "ᚹ")
+                                            ("ƿ" . "ᚹ")
+                                            ("g" . "ᚷ")
+                                            ("ᵹ" . "ᚷ")
+                                            ("ea" . "ᛠ")
+                                            ("f" . "ᚠ")
+                                            ("u" . "ᚢ")
+                                            ("o" . "ᚩ")
+                                            ("r" . "ᚱ")
+                                            ("c" . "ᚳ")
+                                            ("h" . "ᚻ")
+                                            ("n" . "ᚾ")
+                                            ("i" . "ᛁ")
+                                            ("j" . "ᛄ")
+                                            ("p" . "ᛈ")
+                                            ("v" . "ᛝ")
+                                            ("t" . "ᛏ")
+                                            ("b" . "ᛒ")
+                                            ("e" . "ᛖ")
+                                            ("m" . "ᛗ")
+                                            ("l" . "ᛚ")
+                                            ("d" . "ᛞ")
+                                            ("é" . "ᛟ")
+                                            ("a" . "ᚪ")
+                                            ("y" . "ᚣ"))
+  "Equivalence between the Mattér orthography in the Latin script
+and the Runic script. The first element of a pair is the Latin
+script orthography, the second is the Runic equivalent.")
 
-(setq conlanging//matter-latin-to-native '((" +" . " ")
-                                           ("ch" . "ċ")
-                                           ("ae" . "æ")
-                                           ("th" . "þ")
-                                           ("s" . "þ")
-                                           ("dh" . "ð")
-                                           ("z" . "ð")
-                                           ("w" . "ƿ")
-                                           ("j" . "i")))
+(defvar conlanging//matter-latin-to-native '((" +" . " ")
+                                             ("ch" . "ċ")
+                                             ("ae" . "æ")
+                                             ("th" . "þ")
+                                             ("s" . "þ")
+                                             ("dh" . "ð")
+                                             ("z" . "ð")
+                                             ("w" . "ƿ")
+                                             ("j" . "i"))
+  "Equivalence between the Mattér orthography in its native Latin
+script and the transliterated Mattér Latin script. The first
+element of a pair is the transliterated Latin script orthography,
+the second is the native Latin script equivalent.")
 
-(setq conlanging//matter-latin-to-latex '((", *" . ":")
-                                          ("\\. *" . "*")
-                                          (" +" . ".")
-                                          ("ch" . "I")
-                                          ("ċ" . "I")
-                                          ("ae" . "æ")
-                                          ("ea" . "\\\\ea")
-                                          ("ƿ" . "w")
-                                          ("dh" . "s")
-                                          ("z" . "s")
-                                          ("ð" . "s")
-                                          ("th" . "þ")
-                                          ("s" . "þ")
-                                          ("v" . "\\\\ng")
-                                          ("é " . "\\\\oe")))
+(defvar conlanging//matter-latin-to-latex '((", *" . ":")
+                                            ("\\. *" . "*")
+                                            (" +" . ".")
+                                            ("ch" . "I")
+                                            ("ċ" . "I")
+                                            ("ae" . "æ")
+                                            ("ea" . "\\\\ea")
+                                            ("ƿ" . "w")
+                                            ("dh" . "s")
+                                            ("z" . "s")
+                                            ("ð" . "s")
+                                            ("th" . "þ")
+                                            ("s" . "þ")
+                                            ("v" . "\\\\ng")
+                                            ("é " . "\\\\oe"))
+  "Equivalence between the Mattér orthography in the Latin script
+and the LaTeX code for the Runic script. The first element of a
+pair is the Latin script orthography, the second is the Runic
+LaTeX code equivalent.")
 
 (defun conlanging/matter-to-runes ()
   "Replaces transliterated Mattér with its runic writing system"
@@ -193,8 +204,8 @@ latin writing system"
   (conlanging//replace-char-by-table conlanging//matter-latin-to-latex))
 
 (defun conlanging/matter-org-export-runes (text)
-  "Replaces transliterated Mattér with its corresponding runes during org-mode
-export"
+  "Replaces the transliterated Mattér `text' with its
+corresponding runes during org-mode export"
   (interactive)
   (if (org-export-derived-backend-p org-export-current-backend
                                     'latex)
@@ -206,15 +217,19 @@ export"
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;              Eittlanda              ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-(setq conlanging//eittlanda-latin-to-latex '((", *" . "\\\\tripledot")
-                                             ("\\. *" . "\\\\tripledot")
-                                             (" +" . ":")
-                                             ("hv" . "x")
-                                             ("ø" . "\\\\o")
-                                             ("œ" . "\\\\oO")
-                                             ("v" . "w")
-                                             ("ó" . "v")
-                                             ("ń" . "\\\\ndot")))
+(defvar conlanging//eittlanda-latin-to-latex '((", *" . "\\\\tripledot")
+                                               ("\\. *" . "\\\\tripledot")
+                                               (" +" . ":")
+                                               ("hv" . "x")
+                                               ("ø" . "\\\\o")
+                                               ("œ" . "\\\\oO")
+                                               ("v" . "w")
+                                               ("ó" . "v")
+                                               ("ń" . "\\\\ndot"))
+  "Equivalence between the Eittlandic orthography in the Latin
+script and the LaTeX code for the Runic script. The first element
+of a pair is the Latin script orthography, the second is the
+Runic LaTeX code equivalent.")
 
 (defvar conlanging//eittlanda-latin-to-runes '((", *" . "⁝")
                                                ("\\. *" . "⁝")