summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLukasz Kasprzak <lukas@labunix.xyz>2026-07-28 19:03:15 +0200
committerLukasz Kasprzak <lukas@labunix.xyz>2026-07-28 19:03:15 +0200
commit9100973576f87adcadaf6c8b331df7e729aeb117 (patch)
treeb67377705bb50c30004c52abc423573d1b335ca8 /README.md
parent771ec96f07499d6efbcb587f94e30ffcbc4e0e58 (diff)
downloadlectio-9100973576f87adcadaf6c8b331df7e729aeb117.tar.gz
lectio-9100973576f87adcadaf6c8b331df7e729aeb117.zip
i18n: make all UI chrome user-translatable via ui/<code>.ini
The interface chrome (version labels, TUI keybar/messages, CLI banner words, web control labels, section-heading words) was English/Polish hardcoded in Go. It is now data: the English and Polish tables ship as embedded lang/en.ini and lang/pl.ini, and any language is user-overridable at <config>/ui/<code>.ini, resolved per key with an English fallback. With ui_language = <code> plus a names/<code>.ini, the WHOLE interface -- chrome, day names, saint names -- is translatable without a rebuild. - i18n.Get loads the embedded English baseline, overlays the embedded/user language file, caches per lang; field <-> INI-key mapping is by reflection (lang.go) so the tables and files stay in sync automatically. Edge-space values (e.g. "error: ") are double-quoted so the INI trim keeps them. The Go tables move to golden_test.go; TestGoldenMatchesEmbedded asserts the embedded files still parse back to them, and TestGenerateLangFiles regenerates them (LECTIO_GEN=1). - config.UIDir(); wire i18n.SetUserDir in the CLI, TUI and web entry points. - README/config: document ui/<code>.ini alongside names/<code>.ini.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index e344de0..3e17a29 100644
--- a/README.md
+++ b/README.md
@@ -319,13 +319,19 @@ Add your own translation the same way: a tab-separated `<code>.tsv`
`name`, `psalm_system`); validate with `lectio --corpus-check <path>`. A version
code lectio can't find renders as `(not in <code>)` — it never fails the day.
-## Localising day names
+## Localising to your language
-`ui_language` accepts **any** code. It sets the language of the **day and saint
-names** in the daily view, independently of the reading text. (The UI chrome —
-button labels, keybar — is English or Polish; any other code falls back to
-English chrome.)
+`ui_language` accepts **any** code, and *everything visible* is translatable from
+plain-text files — no rebuild. Set `ui_language = <code>` and provide the files
+below; each overrides the English baseline key by key, so a partial translation
+just leaves the rest in English. The reading text stays in its source language
+(that comes from the corpus, not the interface).
+- **Interface chrome** (button labels, keybar, menu words, column headers) lives
+ in `<code>.ini` in your UI dir (`~/.config/lectio/ui/`). English and Polish ship
+ built in; use the shipped `internal/i18n/lang/en.ini` as the full key list to
+ translate (e.g. `bookmarks = Zakładki`, `banner_gospel = Évangile`). Only the
+ built-in `en`/`pl` need no file.
- **Day names** (e.g. "3rd Sunday in Ordinary Time") are generated. English is
built in and Polish ships with lectio: `ui_language = pl` →
"3. Niedziela Okresu Zwykłego". To add or customise a language, drop a