Translation infrastructure #295

dbnicholson · 2024-10-29T14:44:54Z

This is a WIP branch I had to provide translations for the plugin. It would need some work regardless, but it turns out that editor translation plugins don't work, so it's a moot point. Just putting it here for reference and in the unlikely scenario that Godot does start supporting editor plugin translations.

This has now been updated to use TranslationDomain, which was added in Godot 4.4-dev3. If you run 4.4-dev3 and put some translations in the PO files, you'll see them in the editor.

Fixes: #146
Fixes: #152

https://phabricator.endlessm.com/T35705

Here's a tool script I was using to test that ultimately proved to me that translations weren't happening with TranslationServer:

@tool
extends EditorScript

func _run():
	var locale = TranslationServer.get_locale()
	var tool_locale = TranslationServer.get_tool_locale()
	print("locale: %s" % locale)
	print("tool locale: %s" % tool_locale)
	#print("languages: %s" % TranslationServer.get_all_languages())
	print("locales: %s" % TranslationServer.get_loaded_locales())

	var tx = TranslationServer.get_translation_object(locale)
	print("translation: %s" % tx)
	if tx:
		print("translation locale: %s" % tx.locale)
		print("translation message list: %s" % tx.get_translated_message_list())
	
	var tool_tx = TranslationServer.get_translation_object(tool_locale)
	print("tool translation: %s" % tool_tx)
	if tool_tx:
		print("tool translation locale: %s" % tool_tx.locale)
		print("tool translation message list: %s" % tool_tx.get_translated_message_list())
	
	print(TranslationServer.translate("Add the node into the group"))

dbnicholson · 2024-10-29T14:48:25Z

Note that if you want to set the tool locale, you have to use LANG/LC_* environment variables or however you set the locale for a process. The Godot --language option only sets the runtime locale, not the editor locale.

dbnicholson · 2024-10-30T00:29:53Z

Turns out you can do this in 4.4 using the new TranslationDomain support. I added a couple commits to do that and it seems to work. Still needs cleanup, though. I'm going to reopen and mark as a draft.

dbnicholson · 2024-10-31T12:12:40Z

This is really ready for review now. I tested with 4.3 and 4.4-dev3. The editor translations only show up in 4.4, but I added some bogus translations and they do work there.

Since BlockDefinitions are generic Resources, Godot doesn't automatically extract translatable strings from them. In order to do that, we need to provide an EditorTranslationParserPlugin that extracts the desired fields so they're included in a POT file.

These add utilities for using translations with Godot 4.4's TranslationDomain support. Besides helpers to access the translation domain, there are also utilities to load the translations from PO files. Much of the code is there to run on pre-4.4 Godot without causing errors.

This will add the godot_block_coding translation domain and include translations from any PO files in the locale directory. This is done during plugin initialization so that the translations are loaded before any component tries to translate a string.

Nodes inherit the translation domain of their parent by default, so setting our translation domain on a few top level nodes will make all of our nodes translated. The domain is set in _init() to ensure that child nodes inherit the domain before they start translating strings.

Since the inspector plugin isn't a child of our UI, it needs to have the translation domain set explicitly.

wjt

Very nice! Obviously I'm offended that there is no placeholder en_GB.po file.

addons/block_code/inspector_plugin/block_script_inspector.gd

addons/block_code/ui/blocks/block/block.gd

wjt · 2024-11-01T10:35:12Z

addons/block_code/simple_nodes/simple_ending/simple_ending.gd

 			push_warning('Unrecognized game result "%s"' % result)


 func reset():
-	text = ""
+	# Workaround for POT generation extracting empty string.
+	text = str("")


Weird, so it extracts constant strings for translation even if not tagged with tr()?

It's actually a little uglier than that now that I've read through the GDScript translation parser. The assumption is that anything that assigns to a text property is a Label or similar, which should be automatically translated. In this case, it is a subclass of a Label, so that's a correct assumption. However, I don't think it should try to translate an empty string.

I wouldn't have cared except that msgmerge errored on a duplicate empty string msgid.

Weird. I can see the appeal of not having to litter the code base with tr() at some level, but it seems error-prone.

wjt · 2024-11-01T10:36:23Z

addons/block_code/block_code_plugin.gd

@@ -56,6 +56,7 @@ func _enter_tree():

 	# Custom Project->Tools menu items.
 	add_tool_menu_item(tr("Regenerate %s POT file") % "BlockCode", TxUtils.regenerate_pot_file)
+	add_tool_menu_item(tr("Update %s translated files") % "BlockCode", TxUtils.update_pot_files)


I wonder how feasible it would be to have a CI job that runs a (real, not headless) editor and then executes these...

Good question. The TxUtils.update_pot_files one is independent of the editor, so you could write a headless SceneTree script that we could run from CI. I almost started doing it but decided to wait for now since TxUtils.regenerate_pot_file is very much dependent on the editor and I had no idea if that could be scripted.

One for another day I think.

I figured this out (at least one way). It's kinda nasty, but I'll make a PR for it.

addons/block_code/locale/pt.po

We want the strings in the BlockDefinition to stay untranslated and only translate them when being displayed in the UI.

Neither the user's entered variable name nor the type string should be translated, so set auto_translate_mode to disabled.

These represent block argument values and shouldn't be translated.

Workaround an issue with POT generation where the empty string is extracted for translation. Using str() avoids POT generation since the string isn't evaluated at compile time. See godotengine/godot-proposals#10590.

Currently the only way to regenerate a POT file is to go through the Regenerate POT dialog in the Localization tab of the Project Settings. This adds a Project->Tools menu item that drives the dialog from code using our POT file path. Hat tip to KoBeWi for the procedure. Hopefully in the future we'll have a Godot CLI interface to do this.

The list of translated files to include in the POT file is stored in the project settings. The primary way to update it is through the POT Generation dialog when a new file is added, but we know that we generally want to add all of the plugin's files for translation. This adds a Project->Tools menu item that finds all the relevant files and updates the project setting.

This is the result of running TxUtils.update_pot_files() and TxUtils.regenerate_pot_file() via the Project->Tools menu. There are definitely some strings extracted from scene files that we don't want translated, but I'm not sure the best way to do that without completely taking over scene file parsing. Just ignore the issue for now...

Create message catalogs for all the locales supported in the Godot editor except for es_AR and pt_BR. Due to a bug in Godot's locale matching[1], these would be preferred over the country-less variants for all countries. For example, the pt_BR translation would be used for pt_PT when the generic pt translation would be preferred. The catalogs were created like so: ``` msginit --no-translator -l $locale -i godot_block_coding.pot -o $locale.po ``` The catalogs are also added to the project settings despite that setting not being used in the editor. Nodes that are used in games such as the simple nodes can still get translations via the main domain this way. 1. godotengine/godot#90677

A bit of info about working with the translations.

dbnicholson closed this Oct 29, 2024

dbnicholson reopened this Oct 30, 2024

dbnicholson marked this pull request as draft October 30, 2024 00:30

dbnicholson force-pushed the blockdef-translations branch from 23afc7d to 8163278 Compare October 31, 2024 12:11

dbnicholson marked this pull request as ready for review October 31, 2024 12:12

dbnicholson requested review from manuq and wjt October 31, 2024 12:17

dbnicholson added 5 commits October 31, 2024 15:40

inspector_plugin: Translate button text

531cbbf

Since the inspector plugin isn't a child of our UI, it needs to have the translation domain set explicitly.

dbnicholson force-pushed the blockdef-translations branch from 8163278 to f805d5b Compare October 31, 2024 21:41

wjt reviewed Nov 1, 2024

View reviewed changes

dbnicholson added 9 commits November 1, 2024 16:24

ui: Translate displayed block and category strings

3e208d7

We want the strings in the BlockDefinition to stay untranslated and only translate them when being displayed in the UI.

variable_dialog: Disable translation of input fields

7d5a53e

Neither the user's entered variable name nor the type string should be translated, so set auto_translate_mode to disabled.

ParameterInput: Disable translation of input fields

c2eba97

These represent block argument values and shouldn't be translated.

Avoid translating empty strings

d7f50c4

Workaround an issue with POT generation where the empty string is extracted for translation. Using str() avoids POT generation since the string isn't evaluated at compile time. See godotengine/godot-proposals#10590.

Add localization documentation

6d149f0

A bit of info about working with the translations.

dbnicholson force-pushed the blockdef-translations branch from f805d5b to 6d149f0 Compare November 1, 2024 22:24

wjt approved these changes Nov 4, 2024

View reviewed changes

wjt merged commit 1e94e46 into main Nov 4, 2024
3 checks passed

wjt deleted the blockdef-translations branch November 4, 2024 10:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Translation infrastructure #295

Translation infrastructure #295

dbnicholson commented Oct 29, 2024 •

edited

Loading

dbnicholson commented Oct 29, 2024

dbnicholson commented Oct 30, 2024

dbnicholson commented Oct 31, 2024

wjt left a comment

wjt Nov 1, 2024

dbnicholson Nov 1, 2024

wjt Nov 4, 2024

wjt Nov 1, 2024

dbnicholson Nov 1, 2024 •

edited

Loading

wjt Nov 4, 2024

dbnicholson Nov 4, 2024

Translation infrastructure #295

Translation infrastructure #295

Conversation

dbnicholson commented Oct 29, 2024 • edited Loading

dbnicholson commented Oct 29, 2024

dbnicholson commented Oct 30, 2024

dbnicholson commented Oct 31, 2024

wjt left a comment

Choose a reason for hiding this comment

wjt Nov 1, 2024

Choose a reason for hiding this comment

dbnicholson Nov 1, 2024

Choose a reason for hiding this comment

wjt Nov 4, 2024

Choose a reason for hiding this comment

wjt Nov 1, 2024

Choose a reason for hiding this comment

dbnicholson Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

wjt Nov 4, 2024

Choose a reason for hiding this comment

dbnicholson Nov 4, 2024

Choose a reason for hiding this comment

dbnicholson commented Oct 29, 2024 •

edited

Loading

dbnicholson Nov 1, 2024 •

edited

Loading