Implement i18n support #243

rypptc · 2024-10-20T03:42:04Z

Fixes

Related to Adding i18n Support #99 by @darkshredder

Description

Added i18n dependencies (Babel, polib, transifex-python) to Pipfile
Updated i18n settings in settings.py
Added translation marks in templates, models, views, and tests
Integrated i18n URL patterns for language support
Added a language selection dropdown in the header
Ran makemessages to generate translation files (machine-translated into Spanish for testing) and compiled messages using compilemessages

Technical details

This implementation provides basic Spanish translations for testing. Full integration with Transifex for managing translations will be handled in future steps. The language selection dropdown is implemented using Django’s i18n framework, ensuring smooth language switching without the need for custom JavaScript.

Screenshots

Checklist

My pull request has a descriptive title (not a vague title like Update index.md).
My pull request targets the default branch of the repository (main or master).
My commit messages follow best practices.
My code follows the established code style of the repository.
I added or updated tests for the changes I made (if applicable).
I added or updated documentation (if applicable).
I tried running the project locally and verified that there are no
visible errors.

Developer Certificate of Origin

For the purposes of this DCO, "license" is equivalent to "license or public domain dedication," and "open source license" is equivalent to "open content license or public domain dedication."

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

…messages for es and compile translations for testing

TimidRobot

This is an impressive amount of work!

In addition to the code comments, below, please:

ensure this pull request (PR) branch (rypptc:features/implement-internationalization) is up-to-date with the main branch of creativecommons/legaldb and all conflicts are resolved.
use the formatting / static analysis tools: https://github.com/creativecommons/legaldb#code-style
- They can also be run in Docker so you don't have to configure pipenv:
```
docker compose exec app isort .
```
```
docker compose exec app black .
```
```
docker compose exec app flake8 .
```

TimidRobot · 2024-10-22T17:41:29Z

legal_db/templates/legal_db/base.html

@@ -1,15 +1,16 @@
 {% load compress %}
-{% load static %}
+{% load static i18n %}


please update load listing to be in alphabetical order

This has been fixed

TimidRobot · 2024-10-22T17:44:24Z

legal_db/templates/legal_db/case/form.html

-    <p class="hero-description body-normal">Please add any cases related to Creative Commons licenses and other legal tools that you think should be included in the database. &nbsp;&nbsp;<span class="required">*</span> Required.</p>
+    <h1 class="hero-title title is-2">{% trans "Case Submission" %}</h1>
+    <p class="hero-description body-normal">
+      {% trans "Please add any cases related to Creative Commons licenses and other legal tools that you think should be included in the database." %}


Longer sentences and paragraphs should use {% blocktrans %}. For example:

{% blocktrans trimmed %} Please add any cases related to Creative Commons licenses and other legal tools that you think should be included in the database. {% endblocktrans %}

Ok, I get it

TimidRobot · 2024-10-22T17:45:55Z

legal_db/templates/legal_db/case/form.html

@@ -1,11 +1,15 @@
 {% extends 'legal_db/base.html' %}
-{% load widget_tweaks %}
+{% load widget_tweaks i18n %}


please update load listing to be in alphabetical order

This has been fixed

TimidRobot · 2024-10-22T17:46:08Z

legal_db/templates/legal_db/case/index.html

@@ -1,23 +1,23 @@
 {% extends 'legal_db/base.html' %}
-{% load static %}
+{% load static i18n %}


please update load listing to be in alphabetical order

This has been fixed

TimidRobot · 2024-10-22T17:46:14Z

legal_db/templates/legal_db/faq.html

@@ -1,20 +1,20 @@
 {% extends 'legal_db/base.html' %}
-{% load markdown_extras %}
+{% load markdown_extras i18n %}


please update load listing to be in alphabetical order

This has been fixed

TimidRobot · 2024-10-22T17:47:00Z

legal_db/templates/legal_db/index.html

+      <p class="hero-description body-bigger column is-9">
+        {% url 'case_index' as case_index_url %}
+        {% url 'scholarship_index' as scholarship_index_url %}
+        {% blocktrans with case_url=case_index_url scholarship_url=scholarship_index_url %}


please also include trimmed option

This has been fixed

TimidRobot · 2024-10-22T17:47:35Z

legal_db/templates/legal_db/partials/_footer.html

@@ -1,14 +1,15 @@
+{% load static i18n %}


please update load listing to be in alphabetical order

This has been fixed

TimidRobot · 2024-10-22T17:47:42Z

legal_db/templates/legal_db/partials/_header.html

@@ -1,4 +1,4 @@
-{% load static %}
+{% load static i18n %}


please update load listing to be in alphabetical order

This has been fixed

TimidRobot · 2024-10-22T17:47:47Z

legal_db/templates/legal_db/partials/_search.html

@@ -1,25 +1,26 @@
-{% load widget_tweaks %}
+{% load widget_tweaks i18n %}


please update load listing to be in alphabetical order

This has been fixed

TimidRobot · 2024-10-22T17:48:00Z

legal_db/templates/legal_db/scholarship/index.html

@@ -1,23 +1,23 @@
 {% extends 'legal_db/base.html' %}
-{% load static %}
+{% load static i18n %}


please update load listing to be in alphabetical order

This has been fixed

…immed for long sentences

…internationalization

rypptc · 2024-10-23T11:39:33Z

All requested changes have been made, I made style checks with isort, black and flake8 as indicated, and legaldb main branch has been merged into the features/implement-internationalization branch, and all existing conflicts were solved.

rypptc added 5 commits October 19, 2024 16:36

implement i18n, add dependencies, update templates, models, views, tests

2bb565b

Add i18n url patterns, set_language view, language dropdown. Run make…

5fc939a

…messages for es and compile translations for testing

Merge branch 'main' into features/implement-internationalization

7f73cfe

Fix flake8 warnings

24dcc98

Fix test failures due to language code in URL

901bc1c

rypptc requested review from a team as code owners October 20, 2024 03:42

rypptc requested review from TimidRobot, possumbilities and krysal and removed request for a team October 20, 2024 03:42

TimidRobot requested changes Oct 22, 2024

View reviewed changes

rypptc added 3 commits October 22, 2024 23:19

update load listing to be in alphabetical order and use blocktrans tr…

988b700

…immed for long sentences

Merge remote-tracking branch 'upstream/main' into features/implement-…

94f9768

…internationalization

Apply code formatting using isort, black, and flake8

d4ec75e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement i18n support #243

Implement i18n support #243

rypptc commented Oct 20, 2024

TimidRobot left a comment •

edited

Loading

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

TimidRobot Oct 22, 2024

rypptc Oct 23, 2024

rypptc commented Oct 23, 2024 •

edited

Loading

		@@ -1,25 +1,26 @@
		{% load widget_tweaks %}
		{% load widget_tweaks i18n %}

Implement i18n support #243

Are you sure you want to change the base?

Implement i18n support #243

Conversation

rypptc commented Oct 20, 2024

Fixes

Description

Technical details

Screenshots

Checklist

Developer Certificate of Origin

TimidRobot left a comment • edited Loading

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

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

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

rypptc commented Oct 23, 2024 • edited Loading

TimidRobot left a comment •

edited

Loading

rypptc commented Oct 23, 2024 •

edited

Loading