Add comments for translators (#9510)

* Add translator comments for "special" strings

* Add translator comments for some "tricky" strings

diff --git a/builtin/mainmenu/dlg_settings_advanced.lua b/builtin/mainmenu/dlg_settings_advanced.lua
index 24b71d957870bcf66ad54e704cb8b19641e576d3..c16e4aad00c8a5839191728a87c2014e5ed42b1f 100644 (file)
--- a/builtin/mainmenu/dlg_settings_advanced.lua
+++ b/builtin/mainmenu/dlg_settings_advanced.lua
@@ -639,12 +639,23 @@ local function create_change_setting_formspec(dialogdata)
                -- Flags
                formspec = table.concat(fields)
                                .. "checkbox[0.5," .. height - 0.6 .. ";cb_defaults;"
+                               --[[~ "defaults" is a noise parameter flag.
+                               It describes the default processing options
+                               for noise settings in main menu -> "All Settings". ]]
                                .. fgettext("defaults") .. ";" -- defaults
                                .. tostring(flags["defaults"] == true) .. "]" -- to get false if nil
                                .. "checkbox[5," .. height - 0.6 .. ";cb_eased;"
+                               --[[~ "eased" is a noise parameter flag.
+                               It is used to make the map smoother and
+                               can be enabled in noise settings in
+                               main menu -> "All Settings". ]]
                                .. fgettext("eased") .. ";" -- eased
                                .. tostring(flags["eased"] == true) .. "]"
                                .. "checkbox[5," .. height - 0.15 .. ";cb_absvalue;"
+                               --[[~ "absvalue" is a noise parameter flag.
+                               It is short for "absolute value".
+                               It can be enabled in noise settings in
+                               main menu -> "All Settings". ]]
                                .. fgettext("absvalue") .. ";" -- absvalue
                                .. tostring(flags["absvalue"] == true) .. "]"
                height = height + 1

diff --git a/builtin/mainmenu/tab_online.lua b/builtin/mainmenu/tab_online.lua
index 8733f7618d0ba83589ad0ff85fc14aa9cb753006..7985fd84a02dc915ca49f9dbf528119880670c8a 100644 (file)
--- a/builtin/mainmenu/tab_online.lua
+++ b/builtin/mainmenu/tab_online.lua
@@ -78,6 +78,7 @@ local function get_formspec(tabview, name, tabdata)
                "text,align=right,padding=0.25;" ..   -- clients_max
                image_column(fgettext("Creative mode"), "creative") .. ",padding=1;" ..
                image_column(fgettext("Damage enabled"), "damage") .. ",padding=0.25;" ..
+               --~ PvP = Player versus Player
                image_column(fgettext("PvP enabled"), "pvp") .. ",padding=0.25;" ..
                "color,span=1;" ..
                "text,padding=1]" ..

diff --git a/src/client/fontengine.cpp b/src/client/fontengine.cpp
index 26ceda4c5bb8222ccc321d9e79081e714ca9a79d..2b5841cd8e289a5cc0a190d08527f1dd1856f811 100644 (file)
--- a/src/client/fontengine.cpp
+++ b/src/client/fontengine.cpp
@@ -194,6 +194,14 @@ void FontEngine::readSettings()
                m_default_size[FM_Fallback] = m_settings->getU16("fallback_font_size");
                m_default_size[FM_Mono]     = m_settings->getU16("mono_font_size");
 
+               /*~ DO NOT TRANSLATE THIS LITERALLY!
+               This is a special string. Put either "no" or "yes"
+               into the translation field (literally).
+               Choose "yes" if the language requires use of the fallback
+               font, "no" otherwise.
+               The fallback font is (normally) required for languages with
+               non-Latin script, like Chinese.
+               When in doubt, test your translation. */
                m_currentMode = is_yes(gettext("needs_fallback_font")) ?
                                FM_Fallback : FM_Standard;
 

diff --git a/src/client/game.cpp b/src/client/game.cpp
index 32291c7ef6b48430b15330f51c20a6c851b2362a..0201ded692ef1fc32bd387ced24cbb1dabd79a24 100644 (file)
--- a/src/client/game.cpp
+++ b/src/client/game.cpp
@@ -4184,6 +4184,7 @@ void Game::showPauseMenu()
                                << strgettext("- Creative Mode: ") << creative << "\n";
                if (!simple_singleplayer_mode) {
                        const std::string &pvp = g_settings->getBool("enable_pvp") ? on : off;
+                       //~ PvP = Player versus Player
                        os << strgettext("- PvP: ") << pvp << "\n"
                                        << strgettext("- Public: ") << announced << "\n";
                        std::string server_name = g_settings->get("server_name");

diff --git a/src/client/keycode.cpp b/src/client/keycode.cpp
index 646d181e0bd5583c7301903e8eb8a90b51f77077..6a0e9f569f74c52617a399fb2ac55d461d8ba4df 100644 (file)
--- a/src/client/keycode.cpp
+++ b/src/client/keycode.cpp
@@ -109,6 +109,7 @@ static const struct table_key table[] = {
        DEFINEKEY1(KEY_RETURN, N_("Return"))
        DEFINEKEY1(KEY_SHIFT, N_("Shift"))
        DEFINEKEY1(KEY_CONTROL, N_("Control"))
+       //~ Key name, common on Windows keyboards
        DEFINEKEY1(KEY_MENU, N_("Menu"))
        DEFINEKEY1(KEY_PAUSE, N_("Pause"))
        DEFINEKEY1(KEY_CAPITAL, N_("Caps Lock"))
@@ -121,7 +122,9 @@ static const struct table_key table[] = {
        DEFINEKEY1(KEY_UP, N_("Up"))
        DEFINEKEY1(KEY_RIGHT, N_("Right"))
        DEFINEKEY1(KEY_DOWN, N_("Down"))
+       //~ Key name
        DEFINEKEY1(KEY_SELECT, N_("Select"))
+       //~ "Print screen" key
        DEFINEKEY1(KEY_PRINT, N_("Print"))
        DEFINEKEY1(KEY_EXECUT, N_("Execute"))
        DEFINEKEY1(KEY_SNAPSHOT, N_("Snapshot"))

diff --git a/src/gui/modalMenu.cpp b/src/gui/modalMenu.cpp
index 30417943d0c4c96b1a68124689a2945164f494f7..8fb6c6f0f6309f3512bbf104e4533ebc53ae7a19 100644 (file)
--- a/src/gui/modalMenu.cpp
+++ b/src/gui/modalMenu.cpp
@@ -134,6 +134,8 @@ bool GUIModalMenu::preprocessEvent(const SEvent &event)
                                return retval;
 
                        m_jni_field_name = field_name;
+                       /*~ Imperative, as in "Enter/type in text".
+                       Don't forget the space. */
                        std::string message = gettext("Enter ");
                        std::string label = wide_to_utf8(getLabelByID(hovered->getID()));
                        if (label.empty())

diff --git a/src/network/clientpackethandler.cpp b/src/network/clientpackethandler.cpp
index 0a9f8c212b9dc9662dd0af41a3c5cce5ae4485c4..432fb415e8c4fc8eef53601a72696e83026de05e 100644 (file)
--- a/src/network/clientpackethandler.cpp
+++ b/src/network/clientpackethandler.cpp
@@ -135,6 +135,9 @@ void Client::handleCommand_AuthAccept(NetworkPacket* pkt)
                                        << m_recommended_send_interval<<std::endl;
 
        // Reply to server
+       /*~ DO NOT TRANSLATE THIS LITERALLY!
+       This is a special string which needs to contain the translation's
+       language code (e.g. "de" for German). */
        std::string lang = gettext("LANG_CODE");
        if (lang == "LANG_CODE")
                lang = "";

diff --git a/util/updatepo.sh b/util/updatepo.sh
index 84dfd3ddb0c5708869b420ade068ad3adfe5508e..168483bd44ea2f1370bf55f9534fab21d18d0b85 100755 (executable)
--- a/util/updatepo.sh
+++ b/util/updatepo.sh
@@ -49,6 +49,7 @@ cd ..
 # --package-name
 potfile=po/minetest.pot
 xgettext --package-name=minetest \
+       --add-comments='~' \
        --sort-by-file \
        --add-location=file \
        --keyword=N_ \