Translation context for Labels, Buttons, Tooltips, etc

[Vovkiv]

As of now, Godot can generate .pot from scripts, resources, labels, buttons, etc. In scripts, Godot will collect translations from tr() and tr_n() functions, where user can provide optional 2rd (for tr) and 4th (for tr_n) string argument, which would end up as translation context hint in .pot file for string that need to be translated, like this:

tr("Test Label", "Some context info")

Will become this in .pot file:

msgctxt "Some context info"
msgid "Test Label"
msgstr ""

But it seems, there no such option for Labels, Buttons, Tooltips, etc, that user added via Text input. At least, after some documentation reading and going through Godot ui, I can't find this option there.

I think, it could be good idea to provide additional input field for Labels, Buttons, Tooltips, etc, that would be added as translation context to that text or tooltip:

[Calinou]

This should probably be a property on Control, similar to the Auto Translate property.

[molingyu]

auto_translate has been moved to node, and I think the Localization property group should also be moved to the node.

[molingyu]

Before supporting automatic collection of localization resource from the UI system, you must first mark which properties on the UI node need to be collected.

In addition, the contents of the Localization property group should only be displayed on node that have multilingual resources.

[timothyqiu]

The problem I see is that translation context and translation comment should be text specific, not control specific. But the definition of "this control's text" varies.

Some control might contain multiple text fields so a single translation context won't fit all needs. Not to mention controls like ItemList, Tree, and OptionButton that contain multiple items, and each item could need different contexts.

If taken tooltips into account, every control's translation context also needs to be doubled.

So currently it's just easier to use tr() in NOTIFICATION_TRANSLATION_CHANGED when context is needed.

I think injecting extra elements like translation context and comment into the auto translation system needs a more in-depth design. Or we can call auto translation system simple-usecase-only, only adding translation_context properties to simple controls like Label and Button.

[molingyu]

I am doing related work.

I added the localization_resources attribute to node to record the resources to be collected for internationalization on a node component.

localization_resources is a list of I18nResource :

struct I18nResource {
    I18nResourceType type;
    String property_name;
};

In this way, we can record the information of multilingual resources that need to be collected according to the actual situation of each node.

// TextureButton:
#if TOOLS_ENABLED
	set_has_i18n_resource(true);
	add_i18n_resource(I18N_RESOURCE_IMAGE, "texture_normal");
	add_i18n_resource(I18N_RESOURCE_IMAGE, "texture_pressed");
	add_i18n_resource(I18N_RESOURCE_IMAGE, "texture_hover");
	add_i18n_resource(I18N_RESOURCE_IMAGE, "texture_disabled");
	add_i18n_resource(I18N_RESOURCE_IMAGE, "texture_focused");
	add_i18n_resource(I18N_RESOURCE_IMAGE, "texture_click_mask");
#endif

For more information, you can check out my new commits on the branch