minetest/minetest
1
0
Fork 0
mirror of https://github.com/minetest/minetest.git synced 2025-07-05 01:10:22 +02:00
Code Issues Releases Wiki Activity

Add '@n' escape sequences and some documentation on translated strings.

Browse Source
This commit is contained in:
Nathanaël Courant
2017-08-26 09:43:08 +02:00
committed by GitHub
parent fc13c00ef3
commit 5a6618cc57
3 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/lua_api.txt
View File

@ -2199,6 +2199,15 @@ Two functions are provided to translate strings: `minetest.translate` and `minet
this will be displayed as "Laine Rouge" on clients with a French locale.
### Operations on translated strings
The output of `minetest.translate` is a string, with escape sequences adding additional information to that string
so that it can be translated on the different clients. In particular, you can't expect operations like string.length
to work on them like you would expect them to, or string.gsub to work in the expected manner. However, string
concatenation will still work as expected (note that you should only use this for things like formspecs; do not
translate sentences by breaking them into parts; arguments should be used instead), and operations such as
`minetest.colorize` which are only concatenation under the hood as well.
### Translation file format
A translation file has the suffix `.[lang].tr`, where `[lang]` is the language it corresponds to.
The file should be a text file, with the following format:
@ -2221,6 +2230,7 @@ Strings that need to be translated can contain several escapes, preceded by `@`.
files to avoid begin confused with the `=` separating the original from the translation.
* `@\n` (where the `\n` is a literal newline) acts as a literal newline. As with `@=`, this escape is not required
in strings given to `minetest.translate`, but is in translation files.
* `@n` acts as a literal newline as well.
`minetest` namespace reference
------------------------------