📝🗄️

README.md

@@ -2,32 +2,145 @@
 
 for expanding random table entries
 
+1. [Requirements](#requirements)
+2. [Installing](#installing)
+3. [Architecture](#architecture)
+4. [Tutorial](#tutorial)
+   * [Random Selections](#random-selections)
+   * [Expansion](#expansion)
+   * [Filters](#filters)
+5. [Roadmap](#roadmap)
+6. [Resources](#resources)
+
 ## Requirements
 
-Built with
+- Fennel 1.3.1 on PUC Lua 5.4
-Fennel 1.3.1 on PUC Lua 5.4
+- gnu recutils 1.9: for querying metadata
+- just 1.34.0: just a task runner
 
-## Usage
+## Installing
 
 You can run the script: `fennel src/main.fnl`.
 
 Or you can compile a binary and use that.
 See `just compile`.
 
+There is also a vim plugin for the `tbls` format.
+See `vim-tbls/README.md`.
+
+## Architecture
+
+- `src/story.fnl`: core of the project. where all the file handling and text parsing happens
+- `src/main.fnl`: wrapper for story.fnl. the ui.
+- `src/filter.fnl` logic for applying filters to strings
+- `lib/*.fnl` libraries and helper functions
+
+![Autogenerated Dependency Graph][deps]
+
+[deps]: doc/deps.png "Autogenerated Dependency Graph"
+
+## Tutorial
+
+### Random Selections
+
+At its most basic, `tbls` selects a random element from a table.
+
+Suppose you have a few tables:
+
+```
+:: suit
+Hearts
+Bells
+Whistles
+Cups
+Knives
+Shovels
+
+:: card
+Ace
+One
+Two
+[...]
+Queen
+King
+Beast
+```
+
+`tbls` might return "Whistles" from suit.
+Or "Two" from card.
+
+### Expansion
+
+But wait there's more.
+`tbls` will also expand certain text found in a table entry.
+
+Let's add another table:
+
+```
+:: draw
+[card] of [suit]
+```
+
+When you place the name of a table in `[squarebrackets]`,
+then `tbls` views that as a placeholder
+for a random item from that table.
+It will expand that text.
+So 'draw' might end up being "Thief of Shovels"
+or "Twelve or Cups".
+
+### Filters
+
+`tbls` can run arbitary filters on text after expanding it.
+Example filters can be found in `lib/filters.fnl`.
+
+To apply filters,
+dot-chain them at the end
+of a table reference.
+
+Consider the following tables:
+
+```
+:: origin
+Evelyn eats one [fruit.c]
+Evelyn eats many [fruit.c.s]
+
+:: fruit
+banana
+apple
+pear
+```
+
+`s`, `plural`, and `pluralize`
+are all different ways
+to call the 'plural' filter function.
+`c` is 'capitalize.'
+
+Example output:
+
+```
+Evelyn eats one Pear
+Evelyn eats many Bananas
+```
+
+
 ## Roadmap
 
 - [x] random table entries (ADDED in vHydrogen)
 - [x] expanding macros (ADDED in vHydrogen)
-- [ ] table files plugin: syntax highlighting + folding
+- [x] table files plugin: syntax highlighting + folding (ADDED vHelium)
-- [ ] expansion filters 
+- [x] expansion filters (ADDED vHelium)
+- [ ] table context
 
 ## Resources
 
 inspired heavily by tracery:
-https://github.com/galaxykate/tracery
+<https://github.com/galaxykate/tracery>
 
-and paper elemental's list-to-html generator:
+and this list-to-html geneator from slight adjustments:
-https://paperelemental.blogspot.com/p/list-to-html-generator.html
+<https://slightadjustments.blogspot.com/p/generator.html>
+
+but also paper elemental's:
+<https://paperelemental.blogspot.com/p/list-to-html-generator.html>
 
 and perchance:
-https://perchance.org/welcome
+<https://perchance.org/welcome>

doc/History.md

@@ -0,0 +1,15 @@
+# History
+
+`tbls` began as the Story module for a board game I was writing.
+When I completed all the features for the board game itself,
+I wanted to add some kind of a generative story engine
+based on the state of the game
+and on player moves.
+
+This ended up complicating the game quite a bit,
+and also I couldn't figure out how or where
+to actually incorporate the story.
+So I scrapped it for that particular project,
+but continued to develop the story engine on its own.
+
+It became `tbls`.

doc/Tutorial.md

@@ -1,5 +1,7 @@
 ## Tutorial
 
+### Random Selections
+
 At its most basic, `tbls` selects a random element from a table.
 
 Suppose you have a few tables:
@@ -17,21 +19,19 @@ Shovels
 Ace
 One
 Two
-...
+[...]
-Ten
-Eleven
-Twelve
-Thief
 Queen
 King
 Beast
 ```
 
 `tbls` might return "Whistles" from suit.
-Or "Twelve" from card.
+Or "Two" from card.
+
+### Expansion
 
 But wait there's more.
-`tbls` will also expand macros found in table entries.
+`tbls` will also expand certain text found in a table entry.
 
 Let's add another table:
 
@@ -43,6 +43,40 @@ Let's add another table:
 When you place the name of a table in `[squarebrackets]`,
 then `tbls` views that as a placeholder
 for a random item from that table.
-And it will expand the text.
+It will expand that text.
-So this might end up being "Thief of Shovels"
+So 'draw' might end up being "Thief of Shovels"
 or "Twelve or Cups".
+
+### Filters
+
+`tbls` can run arbitary filters on text after expanding it.
+Example filters can be found in `lib/filters.fnl`.
+
+To apply filters,
+dot-chain them at the end
+of a table reference.
+
+Consider the following tables:
+
+```
+:: origin
+Evelyn eats one [fruit.c]
+Evelyn eats many [fruit.c.s]
+
+:: fruit
+banana
+apple
+pear
+```
+
+`s`, `plural`, and `pluralize`
+are all different ways
+to call the 'plural' filter function.
+`c` is 'capitalize.'
+
+Example output:
+
+```
+Evelyn eats one Pear
+Evelyn eats many Bananas
+```

doc/src/readme.m4

@@ -0,0 +1,65 @@
+changequote(<!,!>)dnl Or else `code blocks` confuse m4
+# tbls
+
+for expanding random table entries
+
+1. [Requirements](#requirements)
+2. [Installing](#installing)
+3. [Architecture](#architecture)
+4. [Tutorial](#tutorial)
+   * [Random Selections](#random-selections)
+   * [Expansion](#expansion)
+   * [Filters](#filters)
+5. [Roadmap](#roadmap)
+6. [Resources](#resources)
+
+## Requirements
+
+- Fennel 1.3.1 on PUC Lua 5.4
+- gnu recutils 1.9: for querying metadata
+- just 1.34.0: just a task runner
+
+## Installing
+
+You can run the script: `fennel src/main.fnl`.
+
+Or you can compile a binary and use that.
+See `just compile`.
+
+There is also a vim plugin for the `tbls` format.
+See `vim-tbls/README.md`.
+
+## Architecture
+
+- `src/story.fnl`: core of the project. where all the file handling and text parsing happens
+- `src/main.fnl`: wrapper for story.fnl. the ui.
+- `src/filter.fnl` logic for applying filters to strings
+- `lib/*.fnl` libraries and helper functions
+
+![Autogenerated Dependency Graph][deps]
+
+[deps]: doc/deps.png "Autogenerated Dependency Graph"
+
+include(<!doc/Tutorial.md!>)
+
+## Roadmap
+
+- [x] random table entries (ADDED in vHydrogen)
+- [x] expanding macros (ADDED in vHydrogen)
+- [x] table files plugin: syntax highlighting + folding (ADDED vHelium)
+- [x] expansion filters (ADDED vHelium)
+- [ ] table context
+
+## Resources
+
+inspired heavily by tracery:
+<https://github.com/galaxykate/tracery>
+
+and this list-to-html geneator from slight adjustments:
+<https://slightadjustments.blogspot.com/p/generator.html>
+
+but also paper elemental's:
+<https://paperelemental.blogspot.com/p/list-to-html-generator.html>
+
+and perchance:
+<https://perchance.org/welcome>

doc/v/meta.rec

@@ -5,5 +5,5 @@
 name: tbls
 author: dozens@tilde.team
 created: 2024-07-31
-updated: 2024-08-01
+updated: 2024-08-03
-version: Hydrogen
+version: Helium

justfile

@@ -1,34 +1,85 @@
+set quiet
+
 # show all recipes
 default:
   just --list --unsorted
 
 # compile binary
+[group('build')]
 compile:
   fennel --compile-binary src/main.fnl tbls /usr/local/lib/liblua.a /usr/local/include/lua5.4
+alias build := compile
+
+# install all
+[group('install')]
+install: install-plugin install-binary
+
+# install vim plugin
+[group('install')]
+install-plugin:
+  cp -r vim-tbls/* ~/.config/nvim
+
+# install binary
+[group('install')]
+install-binary: compile
+  cp tbls ~/bin
+
+# run all tests
+[group('test')]
+test: test-main test-story
 
 # run test file
-_test-story:
+[group('test')]
+test-story:
   fennel test/story.test.fnl
 
 # test main
-_test-main:
+[group('test')]
+test-main:
   for i in $(seq 1 10); do fennel src/main.fnl -i test/morpheme-word-epithet.txt -k name; done
 
-# run all tests
+# build all docs
-test: _test-main _test-story
+[group('docs')]
+docs: deps readme
+
+# build readme
+[group('docs')]
+readme:
+  m4 doc/src/readme.m4 > README.md
+
+# create dependency graph
+[group('docs')]
+deps:
+  ag require src \
+    | sed 's/\(.*\.fnl\).*require :\([^\.]*\)\.\([^)]*\)).*/"\1" -> "\2\/\3.fnl"/' \
+    | awk 'BEGIN { print "digraph {" } { print } END { print "}" }' \
+    | dot -Tpng \
+    > doc/deps.png
+
+# create dependency graph but sixel
+[group('docs')]
+depsxl:
+  ag require src \
+    | sed 's/\(.*\.fnl\).*require :\([^\.]*\)\.\([^)]*\)).*/"\1" -> "\2\/\3.fnl"/' \
+    | awk 'BEGIN { print "digraph {" } { print } END { print "}" }' \
+    | dot -Tpng \
+    | magick - -geometry 800 sixel:-
 
 # bump version
+[group('docs')]
 bump:
   #!/usr/local/bin/bash
-  currname=$(recsel doc/meta.rec -P version)
+  currname=$(recsel doc/v/meta.rec -P version)
-  currnum=$(recsel doc/versions.rec -e "Name = '$currname'" -P Number)
+  currnum=$(recsel doc/v/versions.rec -e "Name = '$currname'" -P Number)
   nextnum=$((currnum + 1))
-  nextname=$(recsel doc/versions.rec -e "Number = $nextnum" -P Name)
+  nextname=$(recsel doc/v/versions.rec -e "Number = $nextnum" -P Name)
   echo "Bumping version from $currname to $nextname:"
-  recset doc/meta.rec -f version -s $nextname
+  recset doc/v/meta.rec -f version -s $nextname
-  recset doc/meta.rec -f updated -S $(gdate +'%Y-%m-%d')
+  recset doc/v/meta.rec -f updated -S $(gdate +'%Y-%m-%d')
-  recsel doc/meta.rec
+  recsel doc/v/meta.rec
 
 # show full metadata
+[group('docs')]
 meta:
-  awk 'FNR==1{print ""}{print}' doc/*.rec | recsel -t meta -j version
+  awk 'FNR==1{print ""}{print}' doc/v/*.rec | recsel -t meta -j version
+

lib/filters.fnl

@@ -0,0 +1,30 @@
+(fn capitalize [s]
+  (s:gsub "." string.upper 1)) 
+
+(fn uppercase [s]
+  (string.upper s))
+
+(fn lowercase [s]
+  (string.lower s))
+
+(fn plural [s]
+  (.. s :s))
+
+{
+ :capitalize {
+   :call [:c :cap :capital :capitalize]
+   :fun capitalize
+   }
+ :uppercase {
+   :call [:u :upper :uppercase]
+   :fun uppercase
+   }
+ :lowercase {
+   :call [:l :lower :lowercase]
+   :fun lowercase
+   }
+ :plural {
+   :call [:s :plural :pluralize]
+   :fun plural
+   }
+}

lib/string.fnl

@@ -0,0 +1,7 @@
+(fn split [pattern str]
+  (let [res []]
+    (each [seg (str:gmatch pattern)]
+      (table.insert res seg))
+    res))
+
+{: split}

lib/table.fnl

@@ -0,0 +1,20 @@
+(fn contains? [t x]
+  "does sequence t contain element x?"
+  (accumulate [found false
+               _ v (ipairs t)
+               &until found] ; escape early
+    (or found (= x v))))
+
+(fn keys [t]
+  "takes a table returns a sequential list of its keys"
+  (local out [])
+  (each [k _ (pairs t)] (table.insert out k))
+  out)
+
+(fn has-key? [t k]
+  (contains? (keys t) k))
+
+{: contains?
+ : keys
+ : has-key?
+ }

src/filter.fnl

@@ -0,0 +1,16 @@
+(local {: contains?} (require :lib.table))
+(local {:split split-full} (require :lib.string))
+(local split (partial split-full "[^%.]*"))
+
+(fn filter [s]
+  (let [filters (require :lib.filters)
+       [str & funs] (split s)]
+    (var res str)
+    (each [_ f (ipairs funs)]
+       (each [_ filter (pairs filters)]
+          (when (contains? filter.call f)
+            (set res (filter.fun res)))))
+    res))
+
+{: filter
+ }

src/main.fnl

@@ -8,6 +8,7 @@
   (print)
   (print "Basic Options:")
   (print " -h|--help                         print this message and exit")
+  (print " -v|--version                      print version and exit")
   (print " -i|--input <file>                 name of input file")
   (print " -k|--origin-table-key <key>       name of a table in the input file")
   (print " -s|--origin-table-string <string> a string template")
@@ -28,6 +29,12 @@
             (do
               (show-help)
               (os.exit 0)) 
+          (where [a] (or (= a "-v") (= a "--version")))
+            (let [handle (io.popen "recsel doc/meta.rec -P version")
+                  result (handle:read "*a")]
+              (print result)
+              (handle:close)
+              (os.exit 0))
           (where [a input] (or (= a "-i") (= a "--input")))
             (set opts.input input)
           (where [a key] (or (= a "-k") (= a "--origin-table-key")))
@@ -40,8 +47,7 @@
 
 (fn main []
   (let [opts (parse-args arg)
-        corpus (create-corpus opts.input)
+        corpus (create-corpus opts.input)]
-        ]
     (if opts.key
       (print (flatten corpus (. corpus opts.key)))
       (print (flatten corpus opts.string)))))

src/story.fnl

@@ -1,20 +1,8 @@
 ;; helper funs
-(local tbl {
+(local tbl (require :lib.table))
-  :contains? (fn contains [t x]
+(local {: filter} (require :src.filter))
-    "does sequence t contain element x?"
+(local split
-    (accumulate [found false
+  (partial (. (require :lib.string) :split) "[^%.]*"))
-                 _ v (ipairs t)
-                 &until found] ; escape early
-      (or found (= x v))))
-  :keys (fn keys [t]
-    "takes a table returns a sequential list of its keys"
-    (local out [])
-    (each [k v (pairs t)] (table.insert out k))
-    out)
-})
-(fn has-key? [t k]
-  (tbl.contains? (tbl.keys t) k))
-
 
 (fn lines [filename callback]
   (case (pcall #(with-open [file (io.open filename)] (each [line (file:lines)] (callback line))))
@@ -22,7 +10,7 @@
 
 (fn _create-corpus [lines data]
   (var current-key nil)
-  (var corpus {})
+  (local corpus {})
   (lines data
     #(let [key (string.match $1 "^::%s+([%a-]+)")
            blank? (or (= nil $1) (= "" $1))
@@ -50,7 +38,7 @@
         seed (math.randomseed random) ;; SIDE EFFECT
         whatever (handle:close)       ;; SIDE EFFECT
         idx (math.random len)
-        keys (accumulate [acc [] k v (pairs t)] (do (table.insert acc k) acc))
+        keys (accumulate [acc [] k _ (pairs t)] (do (table.insert acc k) acc))
         rndkey (. keys idx)
         ]
     (. t rndkey)))
@@ -60,18 +48,24 @@
               "string" origin
               "table"  (one-of origin)
               _ (error "Origin must be a table or a string"))
-        template-pattern "%[[%a-]+%]" ; [word]
+        template-pattern "%[[%a-%.]+%]" ; [word]
-        word-pattern "%[([%a-]+)%]"   ; word
+        word-pattern "%[([%a-%.]+)%]"   ; word
         (i j) (string.find str template-pattern) ; indices
-        word (string.match str word-pattern)]    ; the actual keyword
+        raw-word (or (string.match str word-pattern) str)
+        [word & fs] (split raw-word)
+        ]
     (if (not i)
       str
       (do
-        (assert (has-key? corpus word)
+        (assert (tbl.has-key? corpus word)
-          (string.format "Error trying to expand \"%s\". Corpus does not contain a table called \"%s\"" str word))
+          (string.format
+            "Error trying to expand \"%s\". Corpus does not contain a table called \"%s\""
+            str word))
         (let [next-str (string.format "%s%s%s"
                 (string.sub str 1 (- i 1))
-                (one-of (. corpus word))
+                (if (length fs)
+                  (filter (.. (one-of (. corpus word)) "." (table.concat fs ".")))
+                  (one-of (. corpus word)))
                 (string.sub str (+ j 1)))]
           (flatten corpus next-str j)))))) ;; this is a tail call!
 

test/morpheme-word-epithet.txt

@@ -2,349 +2,350 @@
 
 :: name
 ## Entry point / origin
-[morpheme][word] [epithet]
+[morpheme.c][word] [epithet]
-[prefix] [morpheme][word]
+[prefix] [morpheme.c][word]
-[prefix] [morpheme][word] [epithet]
+[prefix] [morpheme.c][word.s]
-[morpheme][word]'[morpheme]
+[prefix] [morpheme.c][word] [epithet]
-[morpheme] [morpheme][word]
+[morpheme.c][word]'[morpheme.c]
+[morpheme.c] [morpheme.c][word]
 
 :: morpheme
 ## A random sound
-Brog
+brog
-Guyn
+guyn
-Driz
+driz
-Oy
+oy
-Poin
+poin
-Broin
+broin
-Dray
+dray
-Hoy
+hoy
-Khu
+khu
-Elbb
+elbb
-Zee
+zee
-Teg
+teg
-Thig
+thig
-Volor
+volor
-Moror
+moror
-Zarn
+zarn
-Zark
+zark
-Zarzl
+zarzl
-Zhong
+zhong
-Zok
+zok
-Krinc
+krinc
-Prunc
+prunc
-Seld
+seld
-Serd
+serd
-Quo
+quo
-Quog
+quog
-Wast
+wast
-Writ
+writ
-Wub
+wub
-Eem
+eem
-Eo
+eo
-Ev
+ev
-Wuld
+wuld
-Rond
+rond
-Trop
+trop
-Yhoo
+yhoo
-Urdd
+urdd
-Ing
+ing
-Ogg
+ogg
-Phef
+phef
-Aph
+aph
-Fro
+fro
-Drov
+drov
-Frol
+frol
-Gis
+gis
-Hirn
+hirn
-Wilk
+wilk
-Rof
+rof
-Roch
+roch
-Thip
+thip
-Throg
+throg
-Teng
+teng
-Tirk
+tirk
-Tenk
+tenk
-Twu
+twu
-Twal
+twal
-Yuth
+yuth
-Yirg
+yirg
-Ull
+ull
-Uk
+uk
-Iv
+iv
-Irch
+irch
-Ok
+ok
-Ort
+ort
-Ool
+ool
-Oon
+oon
-Oos
+oos
-Oop
+oop
-Pur
+pur
-Purth
+purth
-Pux
+pux
-Pix
+pix
-Ang
+ang
-Ank
+ank
-Ack
+ack
-Arr
+arr
-Arc
+arc
-Sor
+sor
-Shri
+shri
-Sarc
+sarc
-Sib
+sib
-Spo
+spo
-Snil
+snil
-Dral
+dral
-Dax
+dax
-Druz
+druz
-Droon
+droon
-Tiong
+tiong
-Snid
+snid
-Phra
+phra
-Vang
+vang
-Gawp
+gawp
-Hool
+hool
-Grul
+grul
-Dhoop
+dhoop
-Jair
+jair
-Qim
+qim
-Quisl
+quisl
-Fiaz
+fiaz
-Prax
+prax
-Aal
+aal
-Righ
+righ
-Ugh
+ugh
-Yog
+yog
-Yig
+yig
-Yair
+yair
-Var
+var
-Vaq
+vaq
-Skog
+skog
-Drij
+drij
-Volg
+volg
-Dem
+dem
-Ghil
+ghil
-Uvar
+uvar
-Err
+err
-Azil
+azil
-Obil
+obil
-Zanzil
+zanzil
-Zhat
+zhat
-Blug
+blug
-Blig
+blig
-Hroo
+hroo
-Waf
+waf
-Xar
+xar
-Grar
+grar
-Lorp
+lorp
-Vuh
+vuh
-Ee
+ee
-Ay
+ay
-Oo
+oo
-Ux
+ux
-Ix
+ix
-Whal
+whal
-Mun
+mun
-Ilun
+ilun
-Fargl
+fargl
-Xab
+xab
-Frang
+frang
-Bao
+bao
-Bif
+bif
-Xif
+xif
-Zij
+zij
-Quix
+quix
-Vonch
+vonch
-Van
+van
-Klanc
+klanc
-Lug
+lug
-Nirm
+nirm
-Zirm
+zirm
-Sil
+sil
-Wev
+wev
-Vil
+vil
-Vran
+vran
-Quiv
+quiv
-Squan
+squan
-Squank
+squank
-Squop
+squop
-Akun
+akun
-Apar
+apar
-Epar
+epar
-Iq
+iq
-Exy
+exy
-Eny
+eny
-Ery
+ery
-Uth
+uth
-Ist
+ist
-Ost
+ost
-Hrosh
+hrosh
-Imb
+imb
-Omb
+omb
-Onk
+onk
-Arem
+arem
-Urum
+urum
-Irim
+irim
-Irik
+irik
-Eliv
+eliv
-Wep
+wep
-Wroov
+wroov
-Droov
+droov
-Seef
+seef
-Hiqa
+hiqa
-Ayy
+ayy
-Jaal
+jaal
-Khee
+khee
-Ish
+ish
-Xiliv
+xiliv
-Whij
+whij
-Koj
+koj
-Krong
+krong
-Swue
+swue
-Aur
+aur
-Eth
+eth
-Qeth
+qeth
-Neth
+neth
-Veth
+veth
-Yeth
+yeth
-Aer
+aer
-Aen
+aen
-Ain
+ain
-Aun
+aun
-Uon
+uon
-Xiv
+xiv
-Ung
+ung
-Ong
+ong
-Eng
+eng
-Ehal
+ehal
-Dhar
+dhar
-Dhom
+dhom
-Hom
+hom
-Kom
+kom
-Rom
+rom
-Qom
+qom
-Eez
+eez
-Dhezz
+dhezz
-Elpz
+elpz
-Upz
+upz
-Akz
+akz
-Auz
+auz
-Goaz
+goaz
-Goz
+goz
-Mepz
+mepz
-Tepz
+tepz
-Crunz
+crunz
-Grenz
+grenz
-Purb
+purb
-Ony
+ony
-Igy
+igy
-Eart
+eart
-Ehng
+ehng
-Leng
+leng
-Jub
+jub
-Zhoon
+zhoon
-Zhewt
+zhewt
-Juju
+juju
-Lhop
+lhop
-Lhow
+lhow
-Ewl
+ewl
-Ewil
+ewil
-Avul
+avul
-Ap
+ap
-Ip
+ip
-Ep
+ep
-Eb
+eb
-En
+en
-El
+el
-Ek
+ek
-Eh
+eh
-Ez
+ez
-Es
+es
-Ej
+ej
-Ol
+ol
-Om
+om
-Ob
+ob
-Oc
+oc
-Ot
+ot
-Oz
+oz
-Os
+os
-Oq
+oq
-Mork
+mork
-Morg
+morg
-Borg
+borg
-Franken
+franken
-Pranken
+pranken
-Lankim
+lankim
-Khim
+khim
-Khem
+khem
-Vinken
+vinken
-Inken
+inken
-Swohd
+swohd
-Glup
+glup
-Blubil
+blubil
-Bulbil
+bulbil
-Ziz
+ziz
-Miz
+miz
-Lilip
+lilip
-Soong
+soong
-Yolp
+yolp
-Grang
+grang
-Grunc
+grunc
-Gharn
+gharn
-Bral
+bral
-Criv
+criv
-Durn
+durn
-Flom
+flom
-Griv
+griv
-Harn
+harn
-Jurn
+jurn
-Klom
+klom
-Larn
+larn
-Mird
+mird
-Norl
+norl
-Plen
+plen
-Qarn
+qarn
-Rilk
+rilk
-Skiv
+skiv
-Tarm
+tarm
-Ulm
+ulm
-Vorn
+vorn
-Wim
+wim
-Yorn
+yorn
-Blen
+blen
-Cril
+cril
-Dorn
+dorn
-Frel
+frel
-Glim
+glim
-Jiln
+jiln
-Kren
+kren
-Lom
+lom
-Morn
+morn
-Nix
+nix
-Polm
+polm
-Quen
+quen
-Ralk
+ralk
-Shil
+shil
-Trok
+trok
-Ulk
+ulk
-Vlim
+vlim
-Yiln
+yiln
-Brim
+brim
-Crev
+crev
-Dril
+dril
-Flon
+flon
-Gril
+gril
-Jorn
+jorn
-Kliv
+kliv
-Lorn
+lorn
-Mirk
+mirk
-Norn
+norn
-Plim
+plim
-Qril
+qril
-Rik
+rik
-Skon
+skon
-Trel
+trel
-Ulv
+ulv
-Vril
+vril
 
 :: word
 ## A regular old word
@@ -1011,3 +1012,4 @@ Sister
 Sour
 Pickled
 The Machine known as
+# vim:set filetype=tbls:

test/story.test.fnl

@@ -5,11 +5,11 @@
 
   (let [corpus (create-corpus "test/morpheme-word-epithet.txt")
         origin-key :name
-        origin-table ["[morpheme][word] [epithet]"
+        origin-table ["[morpheme.c][word] [epithet]"
-                      "[prefix] [morpheme][word] [epithet]"
+                      "[prefix] [morpheme.c][word] [epithet]"
-                      "[prefix] [morpheme][word]"
+                      "[prefix] [morpheme.c][word]"
                       ]
-        origin-string "[morpheme][word] [epithet]"
+        origin-string "[morpheme.c][word] [epithet]"
         get-story-with-key
           (partial flatten corpus (. corpus origin-key))
         get-story-with-table

vim-tbls/README.md

@@ -0,0 +1,25 @@
+# vim-tbls
+
+syntax, filtetype detection, folding, and navigation for tbls files
+
+## installing
+
+1. find out where your `syntax` and `ftdetect` files are. e.g. `$HOME/.config/nvim/` or `$HOME/.vim/`.
+
+2. copy `syntax/tbls.vim` and `ftdetect/tbls.vim` to the appropriate folders
+
+after installing, any `.tbl` file should be detected.
+
+to use syntax for, e.g. a `.txt` file, in vim do `:set filetype=tbls`
+
+## using
+
+the syntax defines a foldable table block as the region between a `:: header` and a blank line.
+all folding commands should work.
+(e.g. `zj` and `zk` to jump to next fold. see `:help fold`.)
+the plugin file sets the foldmethod to syntax,
+so your tables should start out folded if folding in enabled.
+
+the plugin file also maps `]]` and `[[`
+(next section and previous section, respectively)
+to jump between table headers.

vim-tbls/ftdetect/tbls.vim

@@ -0,0 +1 @@
+au BufRead,BufNewFile *.tbl set filetype=tbls

vim-tbls/ftplugin/tbls.vim

@@ -0,0 +1,3 @@
+setlocal foldmethod=syntax
+nnoremap <silent><buffer> ]] m':call search('^::', "W")<CR>
+nnoremap <silent><buffer> [[ m':call search('^::', "bW")<CR>

vim-tbls/syntax/tbls.vim

@@ -0,0 +1,15 @@
+if exists("b:current_syntax")
+  finish
+endif
+
+syntax match tblsComment "^#.*$"
+syntax match tblsTitle "^:\+ .*$"
+syntax match tblsRef "\[[^\]]*\]"
+
+syntax region tblsTable start=":: .*" end="^$" fold transparent
+
+highlight default link tblsComment Comment
+highlight default link tblsTitle Statement
+highlight default link tblsRef Type
+
+let b:current_syntax = "tbls"