diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -41,6 +41,32 @@ See `colitur-templates(5)` for the template format (syntax, escaping, the full field reference) and `colitur(1)` for `emit`, `table`/`render` and `publish` in full. +## Language + +Every command's output is names, not slugs, by default (`--raw` restores +the bare-slug form). Start a new translation from the shipped Latin table, +edit a couple of entries, check it, and render with it -- every line below +is real, not transcribed: + +```sh +$ dune exec colitur -- lang --dump la > my-lang.ini +$ sed -i \ + -e 's/^ef-circumcision = .*/ef-circumcision = My Own Circumcision Text/' \ + -e 's/^ef-epiphany = .*/ef-epiphany = My Own Epiphany Text/' \ + my-lang.ini +$ dune exec colitur -- lang --check my-lang.ini +my-lang.ini: 725 of 725 celebrations named, 0 missing, 0 unknown +$ dune exec colitur -- day 2026 --lang ./my-lang.ini | head -1 +2026-01-01 thursday christmastide - ef-circumcision class-1 white My Own Circumcision Text +``` + +`--check` reports what a language file is still missing, and rejects any +entry naming a slug that does not exist (a typo, otherwise silently dead). +`colitur lang --list` shows what this build can find; `colitur config +--show` shows the effective `--lang` (and every other setting) plus where +it came from. See `colitur(1)`'s `NAMING` section and `colitur-config(5)` +for both in full. + ## License AGPL-3.0-or-later. See `LICENSE`. |