djangocms-aldryn-translation-tools 1.0.0

Contributing

We’re grateful to all contributors who have helped create and maintain this package.

Contributors are listed at contributions page.

admin.AllTranslationsMixin

Automatically adds a list of language “tags” in the changelist. Tag color indicates the state of translation for that object. Grey meaning untranslated, blue meaning translated. Darker versions of each are used to indicate the current language.

Each tag is linked to the specific language tag on the change form of the object.

A similar capability is in HVAD, and now there is this for Parler-based projects.

Preview:

To use this, merely import and add the mixin to your Model Admin class:

from parler.admin import TranslatableAdmin
from aldryn_translation_tools.admin import AllTranslationsMixin

class GroupAdmin(AllTranslationsMixin, TranslatableAdmin):
   # ....

If you wish to put the tags into a different column, you can add all_translations to the list_display list wherever you’d like, otherwise the “Languages” column will automatically be placed on the far right.

admin.LinkedRelatedInlineMixin

This admin inline mixin links the first field to the row object’s own admin change form.

If the first field is editable, results are undefined but probably won’t work as expected. For best results, consider making all fields readonly (since they can be edited with ease by following the link), and disabling the ability to add new objects by overriding has_add_permission() on the inline to always return False.

models.TranslatedAutoSlugMixin

This is a TranslatableModel mixin that automatically generates a suitable slug for the object on save().

If slug_globally_unique is True, then slugs will be required to be unique across all languages.

If slug_globally_unique is False (default), then the strategy used here is that it is OK for two objects to use the same slug if the slugs are for different languages. So if this were used on a translated Article model, these URLs would be valid:

/en/pain - An article in EN about physical discomfort

/fr/pain - An article in FR about bread

Of course, this means that when resolving an object from its URL, care must be taken to factor in the language segment of the URL too.

When using this mixin, it is important to also set the slug_source_field_name property on the implementing model to the name of the translated field which the slug is to be derived from. If you require more slugs to be derived from multiple fields (translated or otherwise), simply override the method get_slug_source to provide the source string for the slug.

models.TranslationHelperMixin

Public Methods

(value, language) = obj.known_translation_getter(field, default=None, language_code=None, any_language=False)

from django.utils.translation import override

from aldryn_translation_tools.models import TranslationHelperMixin
from cms.utils.i18n import get_current_language
from parler.models import TranslatableModel, TranslatedFields

class Fruit(TranslationHelperMixin, TranslatableModel):
    translations = TranslatableFields(
        name=models.CharField(...),
        slug=models.CharField(...)
    )

    def get_absolute_url(self, language=None):
        language = language or get_current_language()
        (slug, language) = self.known_translation_getter('slug',
            default=None, language_code=language, any_language=False)
        with override(language):
            return reverse('fruit-detail', kwargs={'slug': slug})

...

    def get_absolute_url(self, language=None)
        language = language or get_current_language()
        slug = self.safe_translation_getter('slug', default=None,
            language_code=language, any_language=False)
        with override(language):
            return reverse('fruit-detail', kwargs={'slug': slug})

/en/apple/

/fr/apple/