Variables documentation

funcs.el

@@ -15,53 +15,44 @@
 (defun conlanging//declare-node (node-text node-generation)
   "Declares a node in the graphviz source code. The node’s identifier will be
 ~node-generation~, and it will bear the label ~node-text~."
-  (concat (number-to-string node-generation)
-          "[label=\""
-          node-text
-          "\"];"))
+  (format "%d[label=\"%s\"];\n" node-generation
+          node-text))
 
-(defun conlanging//make-link (previous-node current-node)
-  "This creates a link in the graphviz source code between the two nodes
-bearing ~previous-node~ and ~current-node~ respectively as their node
-identifier."
-  (concat (number-to-string previous-node) " -- "
-          (number-to-string current-node) ";"))
-
-(defun conlanging//tree-to-dot-helper (tree current-generation previous-generation)
-  "Helper to ~tree-to-dot~ that translates an Elisp tree with any number of
-children per node to a corresponding graphviz file that can be executed from
-dot.
+(defun conlanging/tree-to-dot (tree &optional current-generation previous-generation)
+  "Translates an Elisp tree with any number of children per node
+to a corresponding graphviz file that can be executed from dot.
 Arguments:
-- tree :: tree-to-convert
-- current-generation :: Generation number, incremented when changing from a node
-     to another node from the same generation, multiplied by 10 when going from
-     a node to one of its children.
-- previous-generation :: generation number from previous named node"
+- `tree': tree to convert
+- `current-generation': generation number, incremented when
+  changing from a node to another node from the same generation,
+  multiplied by 10 when going from a node to one of its children.
+- `previous-generation': generation number from previous named
+  node"
   (cond
-   ((null tree) "")
-   ((atom (car tree)) ;; '("text" () () ())
-    (concat (conlanging//declare-node (car tree) current-generation)
-            (conlanging//make-link previous-generation current-generation)
-            (conlanging//tree-to-dot-helper (cdr tree)
-                                            (+ 1 (* 10 current-generation))
+   ((null previous-generation) ;; first call
+    (concat "graph{graph[dpi=300];node[shape=plaintext];graph[bgcolor=\"transparent\"];\n"
+            (conlanging//declare-node (car tree) 0)
+            (conlanging/tree-to-dot (cdr tree) 1 0)
+            "}"))
+   ((null tree) "") ;; last call in this branch
+   ((atom (car tree)) ;; '("text" () () ()) manage the label
+    (concat (conlanging//declare-node (car tree)
+                                      current-generation)
+            ;; make link
+            (concat (number-to-string previous-generation) " -- "
+                    (number-to-string current-generation) ";\n")
+            (conlanging/tree-to-dot (cdr tree)
+                                    (+ 1
+                                       (* 10 current-generation))
                                     current-generation)))
-   ((listp (car tree)) ;; '(() () ())
-    (concat (conlanging//tree-to-dot-helper (car tree) ;; child of current node
+   ((listp (car tree)) ;; '(() () ()) manage the branches
+    (concat (conlanging/tree-to-dot (car tree) ;; child of current node
                                     current-generation
                                     previous-generation)
-            (conlanging//tree-to-dot-helper (cdr tree)
+            (conlanging/tree-to-dot (cdr tree)
                                     (+ 1 current-generation)
                                     previous-generation)))))
 
-(defun conlanging/tree-to-dot (tree)
-  "Returns a graphviz’s dot compatible string representing an Elisp tree"
-  (if (null tree) ""
-    (concat
-     "graph{graph[dpi=300];node[shape=plaintext];graph[bgcolor=\"transparent\"];"
-     (conlanging//declare-node (car tree) 0)
-     (conlanging//tree-to-dot-helper (cdr tree) 1 0)
-     "}")))
-
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;                Common               ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@@ -120,7 +111,7 @@ whose first element equals `elem'"
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;                Mattér               ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-(setq conlanging//matter-latin-to-runes '((", *" . "᛬")
+(defvar conlanging//matter-latin-to-runes '((", *" . "᛬")
                                             ("\\. *" . "᛭")
                                             (" +" . "᛫")
                                             ("ċ" . "ᛇ")
@@ -157,9 +148,12 @@ whose first element equals `elem'"
                                             ("d" . "ᛞ")
                                             ("é" . "ᛟ")
                                             ("a" . "ᚪ")
-                                          ("y" . "ᚣ")))
+                                            ("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 '((" +" . " ")
+(defvar conlanging//matter-latin-to-native '((" +" . " ")
                                              ("ch" . "ċ")
                                              ("ae" . "æ")
                                              ("th" . "þ")
@@ -167,9 +161,13 @@ whose first element equals `elem'"
                                              ("dh" . "ð")
                                              ("z" . "ð")
                                              ("w" . "ƿ")
-                                           ("j" . "i")))
+                                             ("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 '((", *" . ":")
+(defvar conlanging//matter-latin-to-latex '((", *" . ":")
                                             ("\\. *" . "*")
                                             (" +" . ".")
                                             ("ch" . "I")
@@ -183,7 +181,11 @@ whose first element equals `elem'"
                                             ("th" . "þ")
                                             ("s" . "þ")
                                             ("v" . "\\\\ng")
-                                          ("é " . "\\\\oe")))
+                                            ("é " . "\\\\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"
@@ -202,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)
@@ -215,7 +217,7 @@ export"
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
                                         ;              Eittlanda              ;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-(setq conlanging//eittlanda-latin-to-latex '((", *" . "\\\\tripledot")
+(defvar conlanging//eittlanda-latin-to-latex '((", *" . "\\\\tripledot")
                                                ("\\. *" . "\\\\tripledot")
                                                (" +" . ":")
                                                ("hv" . "x")
@@ -223,9 +225,13 @@ export"
                                                ("œ" . "\\\\oO")
                                                ("v" . "w")
                                                ("ó" . "v")
-                                             ("ń" . "\\\\ndot")))
+                                               ("ń" . "\\\\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.")
 
-(setq conlanging//eittlanda-latin-to-runes '((", *" . "⁝")
+(defvar conlanging//eittlanda-latin-to-runes '((", *" . "⁝")
                                                ("\\. *" . "⁝")
                                                (" +" . "᛬")
                                                (":" . "᛬")
@@ -256,7 +262,10 @@ export"
                                                ("h" . "ᚼ")
                                                ("v" . "ᚥ")
                                                ("r" . "ᚱ")
-                                             ("l" . "ᛚ")))
+                                               ("l" . "ᛚ"))
+  "Equivalence between the Eittlandic 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.")
 
 (defun conlanging/eittlanda-to-runes ()
   "Replaces transliterated Eittlandic with its runic writing system"