Set Fluent database

[mayconfmelo]

Important: The following content applies to transl:0.2.0, which is still under development.

Fluent has many more localization options than those available when using the standard database. To use Fluent with #transl, you need to individually import FTL files for each language, or set the entire Fluent database all at once; each approach has its pros and cons.

Individual Fluent files

#transl(data: read("path/en.ftl"), lang: "en")

#transl(data: read("path/es.ftl"), lang: "es")

#transl(data: read("path/pt.ftl"), lang: "pt")

This approach allows to store data for each language in its own file; but also requires to manually import each file individually.

Note that the FTL file needs to be loaded with #read, and an additional lang option needs to be used to indicate the language.

Complete Fluent database

#transl("path/fluent.yaml")

This approach allows to set an entire Fluent database using only one command; but it also requires that the content of all Fluent files be contained within the same file — which can become quite large, depending on the size of the data and the number of languages used.

The YAML file used is similar to the one used in the standard database, however the l10n: ftl entry is mandatory.

l10n: ftl

en: |
  greetings = Hello, { $name }! How are you?
  farewell = Bye, { $name }. Come back soon!

pt: |
  greetings = Oi, { $name }! Tudo bem?
  farewell = Tchau, { $name }. Volte sempre!

Important

Each time #transl(data) is used, the imported Fluent language data overwrites any existing Fluent data for those languages; therefore, if #transl already contains Fluent data for Spanish, importing new Fluent data for Spanish will overwrite it.

This does not apply to the relationship between Fluent and standard data; it is possible to have Fluent data for Spanish and also standard data for Spanish in the same database.

---

If there are any questions, please explain them below and let's discuss!