Joined: May 28, 2015
Post Count: 607
Status:
Offline
Dynamic translation of a plug-in
@Puybaret
As I am working on an overhaul of the public version of the PhotoVideoRendering plug-in (back to the roots of Sweet Home 3D), I am returning to a problem that dates back several years.
After changing the language in the preferences, the title of the dialog boxes is only taken into account after closing them, the menu title and the name of the plug-in actions are only taken into account after restarting the software.
Coming across this topic, I would like to know what to do for dynamic translation.
----------------------------------------
EnkoNyito
France
Joined: Nov 7, 2005
Post Count: 9181
Status:
Offline
Re: Dynamic translation of a plug-in
Yes, that's the idea, but you should rather use a separate static class for the listener to ensure the garbage collector can work correctly when you close a home (see LanguageChangeListener in PhotoRender and many other classes). The preferences instance exists during the whole life of Sweet Home 3D application, so binding to it a home object for example through an anonymous listener created in a plug-in could prevent the home object from being garbage collected.
----------------------------------------
Emmanuel Puybaret, Sweet Home 3D developer
photoVideoRendering.getUserPreferences().addPropertyChangeListener(UserPreferences.Property.LANGUAGE , new LanguageChangeListener(this)); // modification end PVR-2.7 }
// addition start PVR-2.7 // Based on https://sourceforge.net/p/sweethome3d/code/84...g/ResourceAction.java#l89 (SH3D-7.1) /** * Preferences property listener bound to this action with a weak reference to avoid * strong link between preferences and this action. */ private static class LanguageChangeListener implements PropertyChangeListener { private final WeakReference<SimplePhotoRenderingAction> pluginAction; public LanguageChangeListener(SimplePhotoRenderingAction pluginAction) { this.pluginAction = new WeakReference<SimplePhotoRenderingAction>(pluginAction); }
public void propertyChange(PropertyChangeEvent ev) { // If action was garbage collected, remove this listener from preferences SimplePhotoRenderingAction pluginAction = this.pluginAction.get(); if (pluginAction == null) { ((UserPreferences)ev.getSource()).removePropertyChangeListener( UserPreferences.Property.LANGUAGE, this); } else { ResourceBundle resource = ResourceBundle.getBundle("sh3dPlugin.ApplicationPlugin", Locale.getDefault(), getClass().getClassLoader()); pluginAction.putPropertyValue(Property.NAME, ((UserPreferences)ev.getSource()).getLocalizedString(HomePane.class, "CREATE_PHOTO.Name") + " (PVR-" + SimplePhotoRenderingAction.photoVideoRenderingPlugin.getVersion() + ")"); pluginAction.putPropertyValue(Property.SHORT_DESCRIPTION, ((UserPreferences)ev.getSource()).getLocalizedString(HomePane.class, "CREATE_PHOTO.ShortDescription")); pluginAction.putPropertyValue(Property.MENU, resource.getString("SimplePhotoRenderingAction.MENU")); } } } // addition end PVR-2.7
I could have put the plug-in actions in the existing 3D View menu, but I prefer to avoid doing so so that there is no confusion with the default actions of Sweet Home 3D.
----------------------------------------
EnkoNyito
France
Joined: Nov 7, 2005
Post Count: 9181
Status:
Offline
Re: Dynamic translation of a plug-in
Translation of plug-in menu items is not handled in HomePane class, they won’t change in the user interface.
----------------------------------------
Emmanuel Puybaret, Sweet Home 3D developer
Italy
Joined: Nov 17, 2021
Post Count: 407
Status:
Offline
Re: Dynamic translation of a plug-in
It would be nice if the plugin wouldn't need to deal with the translation of the main menu entry, at least if one means to put it in one of the default menus. For example, for some plugins I put entries in the Help menu, so I have to code tenths of lines such these: Help.MENU=Help Help.MENU=Aide etc...
It would be nice if the program could check if the menu name matches one of the predefined menu names in English language, and, if so, put the new entry in the proper main menu regardless of the current language. If there is no match, it must behave like now. This behavior would be backward compatible with existing plugins, and plugin programmers shouldn't worry about finding the exact translation of the main menus in SH3D's properties files.
The program could also define additional main menu entries for common cases that would be added on demand, such as "Tools". Right now, if a user installs 2 plugins, one of which has just the English entry "Tools", and the other has both English "Tools" and French "Outils", as long the user uses SH3D in English there is no problem, but if he uses French, then the 2 plugins would generate 2 different main menus, which is very ugly. Having optional entries for common cases would solve this problem too. Moreover, being default entries, they would be translated instantly when the user changes the language, which solves the problem raised by EncoNyito, at least for common cases.
----------------------------------------
[Edit 1 times,
last edit by Daniels118 at Jan 17, 2024, 9:49:41 AM]
France
Joined: Nov 7, 2005
Post Count: 9181
Status:
Offline
Re: Dynamic translation of a plug-in
Thanks for the suggestions. I had some similar ideas to get a better presentation of menu items.
----------------------------------------
Emmanuel Puybaret, Sweet Home 3D developer
France
Joined: Nov 7, 2005
Post Count: 9181
Status:
Offline
Re: Dynamic translation of a plug-in
Not sure it’s worth the effort, who changes preferences language once he chose the translation he wants? On the other hand, adapting menu items to existing menus in the user interface would avoid this ugly languages mix in the menu bar. Note that these requests are very recent and as far as I remember, no user ever complained of this behavior until now.
----------------------------------------
Emmanuel Puybaret, Sweet Home 3D developer
Germany
Joined: Jan 6, 2024
Post Count: 27
Status:
Offline
Re: Dynamic translation of a plug-in
I noticed that also when I made German translations. Emmanuel you are right that a normal user is not affected because he sets his language once. Developers, translators and those who change the language for screenshots for help in the forum are affected. As enkonyito wrote it would avoid to exit SH3D each time we change the language.
BTW: Multiple instances will not help. Changing the language in one instance will also change in the other instance (only tested with Linux).
In the category view the German texts of the standard libraries will also not be removed when changing to English. With imported libraries this will happen.
German:
After changing to English:
----------------------------------------
MSI GP60, Linux Mint 21.3 Virginia base: Ubuntu 22.04 jammy, SH3D 7.2 with Photo-video rendering 2.8
