How are translations handled 2024?

wojosc · October 6, 2024, 10:17am

Dears, I was just about to update a translation in System Settings Doctype but was not able to find the translation *.csv in the frappe/frappe repo as I was used to.

Please let me know where and how I can add translations to the core. Thank you.

rmeyer · October 6, 2024, 10:29am

Short answer: the file is now called [lang].po (e.g. de.po for German) and translations can be added comfortably via the crowdin UI:

Here’s how you can manage po files for your custom apps (this is largely automated for frappe, erpnext, hrms and lms):

https://frappeframework.com/docs/user/en/bench/reference#translation-management

Here’s the PR that introduced this, with further info in the description:

github.com/frappe/frappe

feat: translations via gettext

frappe:develop ← barredterra:po-translation

opened 06:29PM - 15 Oct 23 UTC

barredterra

+3155541 -304175

- Move navbar and help items to hooks in order to be able to extract them for tr…anslations - Translatable string extractors: - Python files (*.py) - JavaScript files (*.js) - Jinja2 templates (*.html) - DocType JSON - Report JSON - Workspace JSON - Navbar and help items (from hooks.py) - Module Onboarding - Onboarding Step - Folder structure - `[app]/locale/main.pot` holds all translatable strings of an app, along with context and comments - `[app]/locale/[locale].po` a copy of `main.pot`, with a subset translated to this language - `sites/assets/locale/[locale]/LC_MESSAGES/[app].mo` holds all translations of an app into a specific language, compiled into a binary format for optimized retrieval - Utils for creating `.pot` -> `.po` -> `.mo` files - Bench commands to access above utils - `generate-pot-file` [generate a template file with all of an app's translatable strings](https://frappeframework.com/docs/user/en/bench-generate-pot-file) - `migrate-csv-to-po` [migrate translations from CSV files (old) to PO files (new)](https://frappeframework.com/docs/user/en/bench-migrate-csv-to-po) - `update-po-files` [sync PO files with POT file](https://frappeframework.com/docs/user/en/bench-update-po-files) - `create-po-file` create a new PO file for a specific locale - `compile-po-to-mo` [compile PO files to MO files](https://frappeframework.com/docs/user/en/bench-compile-po-to-mo) This PR is similar to https://github.com/frappe/frappe/pull/19655 (some code copied, some added), but tries to do these things differently: - Non-breaking. For now we just add stuff, to ensure a smooth transition. - Smaller files. For example, each extractor gets its own file. - No bulk-changes to translations, in order to keep the PR reviewable. Todo: - [x] put `.mo` files into `sites/assets/locale/[lang]/LC_MESSAGES/[app].mo` - [x] enable translation functions to optionally use the new files Load translations from both `.csv` and `.mo` files, whatever is available. - [x] ~~migration of sub-languages, for example es_MX. Maybe copy `es.po`, then update from `es-mx.csv`.~~ No need. We can just copy sub-languages as is. Only during the final translation, we will coalesce between sub-languages and general translation. - [x] add extractor for **Module Onboarding** and **Onboarding Step** - [x] apps can provide their own extractors, for files not covered by frappe's standard extractors Each file gets processed only by the first extraction method that matches the file pattern. Apps can place a custom `babel_extractors.csv` in their root directory. These take precedence, if any. The default extractors from frappe's `babel_extractors.csv` get appended (lower relevance). - [x] add tests - [x] compile translations during `bench update` (takes ~10 seconds each, for frappe and erpnext) or try to get away with not compiling anything (just load the `.po` files) - [x] add docs (after merge) - [x] ~~reduce code duplication (see if some existing extractors can be merged with new extractors)~~ (can be done later) Backport to `version-15`: https://github.com/frappe/frappe/pull/25982

If you find it more comfortable to translate directly in the ERPNext/Frappe UI, there’s In-Context Translation. In order to use this, you have to enable the Language “In-Context Translation” / “eo”, select this for your current user and use the modal to log into your Crowdin account.

github.com/frappe/frappe

feat: In-Context Translation

frappe:develop ← barredterra:in-context-translation

opened 11:53AM - 27 Mar 24 UTC

barredterra

+37589 -0

- Add a new language called "In-Context Translation" (disabled by default) - Ad…d a file that translates source strings to Crowdin identifiers - If this language is enabled and active for the current user, load a Crowdin script that replaces the identifiers with the existing translations stored on Crowdin and enables the translation of missing strings. ![Bildschirmfoto 2024-03-27 um 12 49 35](https://github.com/frappe/frappe/assets/14891507/7403a3ad-9763-4b40-8d50-e79eaed44203) ![Bildschirmfoto 2024-03-27 um 12 45 11](https://github.com/frappe/frappe/assets/14891507/279344cb-a975-48bb-8a26-d446a69dc9d0) Related Crowdin config https://crowdin.com/project/frappe/tools/in-context

nikkothari22 · October 6, 2024, 2:57pm

@rmeyer Would this work for .tsx files (React apps) as well? I’ve added translation functions in my React app, but I’m not sure if the PO files will get generated for those strings. They are wrapped as __(“String”) in the app.

krnkris · October 6, 2024, 5:36pm

@rmeyer I would add Hungarian translation and translate as I was done on
https://translate.erpnext.com/

As today you and others using in Hungarian language, if ever want, is almost all my work, I just want to keep it updated.
Is it possible to add Hungarian and put me editor + approval ?

Would appreciate any positive response.

rmeyer · October 6, 2024, 8:05pm

Yes, in principle strings can be extracted from any file type. Check frappe’s babel_extractors.csv, which maps file paths to extractor functions. You’ll have to add one for .tsx. This can either be a real .tsx parser or you can use the existing pattern matcher for html-like templates (Jinja, JS Microtemplates).

So, for example, you’d create [app]/babel_extractors.csv and add the following line:

**.tsx,frappe.gettext.extractors.html_template.extract

This has some limitations compared to a real parser: backticks as quotes, the context parameter and translation statements formatted over multiple lines might not work as expected.

SmoothPlay · October 6, 2024, 10:51pm

Hey guys, believe it or not, this might be one of the most critical things to get right with frappe / erpnext, specially in the website / frontend part.

I’m still wondering how can we translate the following in a webshop:

Categories
Attributes
Variants
Products / Items
Prev & Next ( Switch Page Buttons )

Are there any solutions yet for dynamic variables?

rmeyer · October 8, 2024, 4:35pm

Done

Yanwan · November 19, 2024, 3:42am

How can I keep my custom translations when upgrading? For example, it is essential to retain the translations I have completed when translations on Crowdin have not been merged in a timely manner or when there is a need for personalization.

rmeyer · November 22, 2024, 11:27am

Custom translations via the Translation doctype or via custom apps are always retained.