Gamend.Theme.Translatable (gamend_core v1.0.1192)

Copy Markdown View Source

Which leaves of a theme config are text, and which are configuration.

One list, used by both the renderer (Gamend.Theme.JSONConfig) and the extractor (mix gamend.theme.extract), so the strings a translator is shown and the strings the server translates cannot drift apart.

This is also the guard that keeps configuration out of translations. The theme used to be one whole JSON file per locale, and a config field added to English never reached the other 29 — every one of them silently lost theme_color, so non-English visitors got the fallback colour. A key that is not on this list is configuration: it is never extracted, never translated, and cannot vary by locale.

Summary

Functions

keys()

Keys whose string values are user-facing text.

strings(config)

Every translatable string in a decoded config, in document order, without duplicates. What the extractor writes into theme.pot.

text?(key)

Whether a leaf at key holds text rather than configuration.

walk(value, fun)

Walks a decoded theme config, applying fun to every translatable leaf and leaving everything else untouched.

Functions

keys()

@spec keys() :: [String.t()]

Keys whose string values are user-facing text.

strings(config)

@spec strings(term()) :: [String.t()]

Every translatable string in a decoded config, in document order, without duplicates. What the extractor writes into theme.pot.

text?(key)

@spec text?(String.t() | atom()) :: boolean()

Whether a leaf at key holds text rather than configuration.

walk(value, fun)

@spec walk(term(), (String.t() -> String.t())) :: term()

Walks a decoded theme config, applying fun to every translatable leaf and leaving everything else untouched.

fun receives the string and returns its replacement, so the same traversal serves rendering (translate it) and extraction (collect it).