[Solved] Is core.formspec_escape required for translations?

[isaiah658]

I have a few strings that appear in formspecs in my mod and I'm having a hard time figuring out if translated strings need to be escaped. From my testing, it appears that if the original text does not contain any characters that need to be escaped, then the translated string won't need it either even if the translation contains those special characters. However, if the original text does contain characters that need to be escaped, that's when core.formspec_escape is required.

Is my understanding correct? While it generally doesn't hurt anything, I'd rather not be escaping strings that don't need to be.

[rubenwardy]

Yes you are correct. However, you should still always pass translated strings through formspec escape

If your concern is convenience, it's common to make a util function for this called FS

Code: Select all

local function FS(...)
    return core.formspec_escape(S(...))
end

-- use in formspec like S
FS("Some text")

[Linuxdirk]

If your concern is convenience, it's common to make a util function for this called FS

Code: Select all

local function FS(...)
    return core.formspec_escape(S(...))
end

-- use in formspec like S
FS("Some text")

… which makes it impossible to translate strings using the common gettext tooling.

[rubenwardy]

If your concern is convenience, it's common to make a util function for this called FS

Code: Select all

local function FS(...)
    return core.formspec_escape(S(...))
end

-- use in formspec like S
FS("Some text")

… which makes it impossible to translate strings using the common gettext tooling.

Not true, no less so than using S("Hello")

Our example xgettext script supports FS: https://github.com/luanti-org/modtools/ ... text.sh#L3

[Linuxdirk]

Ah, yes, I was stupid 🤣 We can just add more keywords!