This app is built using core features of django-modeltranslation: https://github.com/deschler/django-modeltranslation
It's an alternative approach for i18n support on Wagtail CMS websites.
The wagtail-modeltranslation application is used to translate dynamic content of existing Wagtail models to an arbitrary number of languages, without having to change the original model classes. It uses a registration approach (comparable to Django's admin app) to add translations to existing or new projects and is fully integrated into the Wagtail admin UI.
The advantage of a registration approach is the ability to add translations to models on a per-app basis. You can use the same app in different projects, whether or not they use translations, and without touching the original model class.
- Add translations without changing existing models or views
- Translation fields are stored in the same table (no expensive joins)
- Supports inherited models (abstract and multi-table inheritance)
- Handle more than just text fields
- Wagtail admin integration
- Flexible fallbacks, auto-population and more!
- Default Page model fields has translatable fields by default
- StreamFields are now supported!
wagtail-modeltranslation patches Wagtail's Page model with translation fields
title_xx, slug_xx, seo_title_xx, search_description_xx and url_path_xx where "xx" represents the language code for each translated language. This
is done without migrations through command sync_page_translation_fields. Since Page model belongs to
Wagtail it's within the realm of possibility that one day Wagtail may add a conflicting field to Page thus interfering with wagtail-modeltranslation.
Wagtail's slugurl tag does not work across languages. wagtail-modeltranslation provides a drop-in replacement named slugurl_trans which by default takes the slug parameter in the default language.
Install
wagtail-modeltranslation:pip install wagtail-modeltranslation
Add 'wagtail_modeltranslation' to your
INSTALLED_APPSsetting like this (before all apps that you want to translate):INSTALLED_APPS = ( ... 'wagtail_modeltranslation', 'wagtail_modeltranslation.makemigrations', 'wagtail_modeltranslation.migrate', )Add 'django.middleware.locale.LocaleMiddleware' to
MIDDLEWAREon yoursettings.py:MIDDLEWARE = ( ... 'django.middleware.locale.LocaleMiddleware', # should be after SessionMiddleware and before CommonMiddleware )Enable i18n on
settings.py:USE_I18N = True
Define available languages on
settings.py:from django.utils.translation import gettext_lazy as _ LANGUAGES = ( ('pt', _('Portuguese')), ('es', _('Spanish')), ('fr', _('French')), )Create
translation.pyinside the root folder of the app where the model you want to translate exists:from .models import Foo from modeltranslation.translator import TranslationOptions from modeltranslation.decorators import register @register(Foo) class FooTR(TranslationOptions): fields = ( 'body', )Run
python manage.py makemigrationsfollowed bypython manage.py migrate(repeat every time you add a new language or register a new model)Run
python manage.py sync_page_translation_fields(repeat every time you add a new language)If you're adding
wagtail-modeltranslationto an existing site runpython manage.py update_translation_fields
| wagtail-modeltranslation release | Compatible Wagtail versions | Compatible Django versions | Compatible Python versions |
|---|---|---|---|
| 0.10 | >= 1.12, < 2.12 | >= 1.11 | 2.7, 3.4, 3.5, 3.6 |
| 0.11 | >= 2.13, < 3.0 | >= 3.0 | 3.6, 3.7, 3.8, 3.9 |
| 0.12 | >= 3.0, < 4.0 | >= 3.2 | 3.7, 3.8, 3.9, 3.10 |
| 0.13 | >= 4.0, < 5.0 | >= 3.2 | 3.7, 3.8, 3.9, 3.10 |
| 0.14 | >= 5.0, < 6.0 | >= 3.2 | 3.8, 3.9, 3.10, 3.11 |
| 0.15 | >= 5.2 | >= 4.2 | 3.8, 3.9, 3.10, 3.11, 3.12 |
- Template tag
change_langnow needs a second parameter,page
This version includes breaking changes as some key parts of the app have been re-written:
- The most important change is that
Pageis now patched with translation fields. WAGTAILMODELTRANSLATION_ORIGINAL_SLUG_LANGUAGEsetting has been deprecated.
To upgrade to this version you need to:
- Replace the
WagtailTranslationOptionswithTranslationOptionsin all translation.py files - Run
python manage.py sync_page_translation_fieldsat least once to createPage's translation fields - Replace any usages of Wagtail's
{% slugurl ... %}forwagtail-modeltranslation's own{% slugurl_trans ... %} - While optional it's recommended to add
'wagtail_modeltranslation.makemigrations'to your INSTALLED_APPS. This will override Django'smakemigrationscommand to avoid creating spuriousPagemigrations.
This version has some important changes as there was a refactoring to include django-modeltranslation as a dependency instead of duplicating their code in our version. This allow us to focus on Wagtail admin integration features as django-modeltranslation is very well mantained and is very quickly to fix problems with the latest Django versions. This way we also keep all the django-modeltranslation features (if you want you can also customize django-admin, for example). We also provide a new class to create the translation options classes: WagtailTranslationOptions Most of the changes are related to imports as they change from wagtail-modeltranslation to modeltranslation.
To upgrade to this version you need to:
- Replace the
TranslationOptionswithWagtailTranslationOptionsin all translation.py files - The import of the register decorator is now
from modeltranslation.decorators import register - The import of translator is now
from modeltranslation.translator import translator
https://github.com/infoportugal/wagtail-modeltranslation
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent