Introducing i18n URL patterns (#883) #1251

marksweb · 2022-10-17T11:40:49Z

This sets up i18n URL patterns with the language selector from the docs, beginning to address #883.

This also adds translation tags to the fundraising templates to being to address #377

As for the languages in settings, I've taken those which are currently in the locale directory.

Happy for any feedback on the current state of changes & also as to whether I should keep adding translation tags to the rest of the templates or do that as separate, smaller, PRs.

…ge language view

…patterns are in use.

…html

marksweb · 2022-11-17T13:20:35Z

@pauloxnet @carltongibson

Hello 👋

This PR is a little bit of a beast, but I think that's unavoidable when bringing in translations.

I think I've covered all HTML, Javascript and Python strings which look helpful to translate.

Besides the current script for making the messages, the javascript can be done with manage.py makemessages -d djangojs. I've not added this as I didn't want to mess with that side of things.

marksweb · 2022-11-17T13:25:17Z

djangoproject/templates/conduct/enforcement.html


-<p>The committee will then review the incident and determine, to the best of their ability:
+<p>{% blocktranslate %}The committee will then review the incident and determine, to the best of their ability:
 <ul>
    <li>what happened</li>


These could be translated individually but would need context providing to explain the opening sentence.

I decided a translation block around the whole thing was easy, but it does make for a chunky piece with markup involved.

carltongibson · 2022-11-17T13:34:52Z

Hey @marksweb — wowser, yes. Indeed. 😅

Initial thoughts:

This affects the URL structure right. (Likely that's OK)
Do we have a plan for creating the translations?
There are lots of flat pages too. Do we have a plan for those?
Is our goal translate everything or is it more limited?

Do we need to rope in more help from the DSF members, and wider community?

marksweb · 2022-11-17T14:10:07Z

@carltongibson

In terms of a goal, I think my goal with this is the facilitation of translation. With the way translations will fallback to the source language, it becomes a bit of a community task where we provide people with the tools to contribute the translations if they're using the site and would find it helpful/useful for it to be in their native language.

In terms of creating the translations, there is a script which hints at some transifex integration. A tool like that is certainly the best way to gather translations.

You're absolutely right that the URLs would change with this. Any path which doesn't have a language code in it, django will redirect to a language prefixed path. The locale middleware should select the most appropriate from those available. I've never had any issue with this coming into play, and I have left some paths outside of the i18n patterns. I split the download urls.py into 2, so that the content side of that could be translated, while the download side would stay as it is, outside of i18n. Legacy urls are also kept outside. This can be seen here.

And in terms of flatpages, I think this comes down to how much content people want to translate. It may also become permissions vs knowledge based if flatpages need to be translated via admin opposed to a third party tool. I'm afraid I have never needed to translate a flatpage - that cms platform is where similar translations have occurred in my projects.

pauloxnet · 2022-11-18T11:30:20Z

I'm sorry but I'm organizing a Django Girls workshop this weekend I'll try to find a few time to made a review next week. But feel free to find other volunteers reviewers if you can, and also to merge if @carltongibson approve it.

carltongibson · 2022-11-18T11:38:21Z

There's no rush here. We need to make sure we sure what the plan is. Measure twice... 🙂

marksweb · 2022-11-18T15:23:40Z

Absolutely. This is one that can sit & wait until everyone's happy and maybe there's plans in place for sourcing the translations 👍

CuriousLearner · 2023-02-08T18:01:42Z

djangoproject/static/js/mod/clippify.js

+		var copy_str = gettext("Press ⌘-C to copy");
+        var success = $('<span class="clipboard-success">').text(copy_str);


Minor nit: Indentation is off on line 37.

Also, while we are at it. I think we can use let instead of var.

Similarly elsewhere (for the lines at least that you're already touching in this PR).

I can go back over and fix indentation, but hesitant to change var for let, event though it's so minor, because it's outside the scope of the PR.

CuriousLearner · 2023-02-08T18:02:15Z

djangoproject/static/js/mod/mobile-menu.js

@@ -11,8 +11,9 @@ define([
    MobileMenuExport.prototype = {
        init: function(){
            var self = this;
+			var label = gettext('Menu');


Indentation is off here + use let/const for variables in JS.

I can go back over and fix indentation, but hesitant to change var for let, event though it's so minor, because it's outside the scope of the PR.

CuriousLearner · 2023-02-08T18:02:29Z

djangoproject/static/js/mod/stripe-change-card.js

@@ -17,14 +17,15 @@ define([
                    'donation_id': donationId,
                    'csrfmiddlewaretoken': csrfToken
                };
+				var success_copy = gettext('Card updated');


Indentation is off here too.

CuriousLearner · 2023-02-08T18:06:13Z

djangoproject/templates/blog/blog_pagination.html

-    <span class="page-current">
-      Page {{ page_obj.number }} of {{ page_obj.paginator.num_pages }}
-    </span>
+    <span class="page-current">{% blocktranslate trimmed with page_number=page_obj.number pages=page_obj.paginator.num_pages %}


Curious to know where this trimmed with ... is coming from?

@CuriousLearner trimmed is an option to blocktranslate which removes newline characters from the generated translations - just makes things a bit cleaner for translators in my experience. with is how you then provide variables to the block.

Info & examples on this here; https://docs.djangoproject.com/en/4.1/topics/i18n/translation/#blocktranslate-template-tag

CuriousLearner · 2023-02-08T18:35:26Z

djangoproject/views.py

+    if lang_code and check_for_language(lang_code):
+        if next_url:
+            next_trans = translate_url(next_url, lang_code)
+            if next_trans != next_url:
+                response = HttpResponseRedirect(next_trans)
+
+        activate(lang_code)
+        response.set_cookie(
+            settings.LANGUAGE_COOKIE_NAME, lang_code,
+            max_age=settings.LANGUAGE_COOKIE_AGE,
+            path=settings.LANGUAGE_COOKIE_PATH,
+            domain=settings.LANGUAGE_COOKIE_DOMAIN,
+            secure=settings.LANGUAGE_COOKIE_SECURE,
+            httponly=settings.LANGUAGE_COOKIE_HTTPONLY,
+            samesite=settings.LANGUAGE_COOKIE_SAMESITE,
+        )


Great work here!

CuriousLearner

Wow, took a lot of time to review! ☕

Great work indeed. I think we are on the right track, but a general direction of what all is needed is to be included.

I would suggest to have this work in terms of milestones. I think then we can focus on acquiring specific milestones and getting django apps to support translation.

marksweb changed the title ~~Fix/883/translation~~ Introducing i18n URL patterns Oct 17, 2022

marksweb changed the title ~~Introducing i18n URL patterns~~ Introducing i18n URL patterns (#883) Oct 17, 2022

marksweb force-pushed the fix/883/translation branch from 39ac0fb to 322ba5e Compare November 14, 2022 23:49

marksweb added 27 commits November 17, 2022 13:07

Initial translations tags for fundraising app

3e5c7b9

Added language selector from docs and setup i18n URLs.

5218c89

isort fixes

c660e82

Updating tests to account for i18n patterns & added test for new chan…

7ed56e8

…ge language view

Change param for blocktranslate to avoid error.

eb34098

Move legacy URLs outside i18n patterns

4e30cd9

Add condition to check if language is set

aec8a57

Add condition to check if LANGUAGE_CODE is set

51bcf77

Added missing with

1dc31f8

Split release URLs so the download redirect bypasses i18n patterns.

3b71acd

Removed vary header check as Accept-Language isn't added when i18n …

fa09e34

…patterns are in use.

Add translation tags to homepage

4a5321e

Add translation tags to donate_thanks.html

6211d54

Add translation tags to base and error templates

a72e8ae

Add translation tags to bouncing_tickets.html

bd02970

Add translation tags to download.html

96e451b

Add translation tags to registration templates

6753045

Add translation tags to members templates

fa2bfb1

Community template fix for blocktranslate

21d2893

Add translation tags to "includes" templates

249a0ab

Made corporatemember_list.html consistent with display_django_heroes.…

46cb40e

…html

Add translation tags to foundation templates

a06a082

Add translation tags to diversity templates

54f88fe

Add translation tags to contact templates

5f69f19

Translation syntax fixes

390eede

Add translation tags to conduct templates

6bddf17

Translation syntax fixes

7b1adca

marksweb added 7 commits November 17, 2022 13:07

Add translation tags to blog templates

c16b1fa

Translation syntax fixes

1065caa

Add translation tags to aggregator templates

abce6e7

Add translation tags to accounts templates

52aaceb

Adding translation to strings in python

2807ae4

isort fixes

646b7da

Adding translation to javascript

01b487e

marksweb force-pushed the fix/883/translation branch from 51b1304 to 01b487e Compare November 17, 2022 13:12

marksweb marked this pull request as ready for review November 17, 2022 13:14

marksweb commented Nov 17, 2022

View reviewed changes

carltongibson requested a review from a team November 17, 2022 13:35

CuriousLearner reviewed Feb 8, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introducing i18n URL patterns (#883) #1251

Introducing i18n URL patterns (#883) #1251

marksweb commented Oct 17, 2022

marksweb commented Nov 17, 2022

marksweb Nov 17, 2022

carltongibson commented Nov 17, 2022 •

edited

marksweb commented Nov 17, 2022 •

edited

pauloxnet commented Nov 18, 2022

carltongibson commented Nov 18, 2022

marksweb commented Nov 18, 2022 •

edited

CuriousLearner Feb 8, 2023

marksweb Feb 20, 2023

CuriousLearner Feb 8, 2023

marksweb Feb 20, 2023

CuriousLearner Feb 8, 2023

CuriousLearner Feb 8, 2023

marksweb Feb 20, 2023

CuriousLearner Feb 8, 2023

CuriousLearner left a comment •

edited

		var copy_str = gettext("Press ⌘-C to copy");
		var success = $('<span class="clipboard-success">').text(copy_str);

Introducing i18n URL patterns (#883) #1251

Are you sure you want to change the base?

Introducing i18n URL patterns (#883) #1251

Conversation

marksweb commented Oct 17, 2022

marksweb commented Nov 17, 2022

Choose a reason for hiding this comment

carltongibson commented Nov 17, 2022 • edited

marksweb commented Nov 17, 2022 • edited

pauloxnet commented Nov 18, 2022

carltongibson commented Nov 18, 2022

marksweb commented Nov 18, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CuriousLearner left a comment • edited

Choose a reason for hiding this comment

carltongibson commented Nov 17, 2022 •

edited

marksweb commented Nov 17, 2022 •

edited

marksweb commented Nov 18, 2022 •

edited

CuriousLearner left a comment •

edited