diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 62 |
1 files changed, 62 insertions, 0 deletions
@@ -67,6 +67,68 @@ entry naming a slug that does not exist (a typo, otherwise silently dead). it came from. See `colitur(1)`'s `NAMING` section and `colitur-config(5)` for both in full. +## Citations + +A reading citation (`Jn 3:16`) is parsed into structure and re-rendered, so +its book names, its punctuation/abbreviation convention, and its numbering +tradition are each a file to edit, not something the engine hardcodes. One +day, four ways -- every line below is real, not transcribed: + +```sh +$ dune exec colitur -- readings 2026 | grep ^2026-02-25 +2026-02-25 ef-lent-ember-wed | 3 Reg 19:3-8 | Matth 12:38-50 | Feria IV Quatuor Temporum Quadragesimae + +$ dune exec colitur -- readings 2026 --sigla-book full | grep ^2026-02-25 +2026-02-25 ef-lent-ember-wed | Liber Regum III 19:3-8 | Evangelium secundum Matthaeum 12:38-50 | Feria IV Quatuor Temporum Quadragesimae + +$ dune exec colitur -- readings 2026 --lang en | grep ^2026-02-25 +2026-02-25 ef-lent-ember-wed | 3 Kgs. 19:3-8 | Matt 12:38-50 | Lenten Ember Wednesday + +$ dune exec colitur -- readings 2026 --lang en --sigla-tradition modern | grep ^2026-02-25 +2026-02-25 ef-lent-ember-wed | 1 Kgs 19:3-8 | Matt 12:38-50 | Lenten Ember Wednesday +``` + +The same four results, from a config file instead of flags (each block is +the entire `[defaults]` section on its own -- not one file with all four): + +```ini +# 1. Latin abbreviated -- the built-in default, no entries needed +[defaults] + +# 2. Latin full +[defaults] +sigla_book = full + +# 3. English (Vulgate numbering: "3 Kings", not "1 Kings") +[defaults] +lang = en + +# 4. English, modern numbering +[defaults] +lang = en +sigla_tradition = modern +``` + +Two axes are independent and easy to conflate. `--lang`/`sigla_book` (and +a language file's own `[bible]` section) decide what a book is *called* -- +this varies by language. `--sigla-tradition` (`lang/traditions.ini`) +decides which book a reference *denotes* -- this does not vary by +language. `3 Kings 19:3-8` and `1 Kings 19:3-8` above are the *same* verse, +renumbered, not two different readings; conflating naming with renumbering +is how a citation ends up naming the wrong book. + +`--raw` bypasses all of it: every citation is emitted exactly as stored, +byte-for-byte, independently of the parser -- what a script diffing this +engine's output against the sibling `lectio` engine depends on: + +```sh +$ dune exec colitur -- readings 2026 --raw | grep ^2026-02-25 +2026-02-25 ef-lent-ember-wed | 3 Kgs. 19:3-8 | Matt 12:38-50 +``` + +See `colitur(1)`'s `SIGLA` section for the `[bible]`/`[sigla]` language-file +sections, `lang/traditions.ini` in full, and all three `--sigla-*` flags. + ## License AGPL-3.0-or-later. See `LICENSE`. |