djangocms-xliff 2.0.4
XLIFF Import and Export for the Django CMS
Requires Python: >=3.13
Keywords: django, django-cms, export, import, xliff

# djangocms-xliff

[![Tests](https://github.com/energie360/djangocms-xliff/actions/workflows/tests.yaml/badge.svg?branch=main)](https://github.com/energie360/djangocms-xliff/actions/workflows/tests.yaml)
[![PyPI](https://img.shields.io/pypi/v/djangocms-xliff)](https://pypi.org/project/djangocms-xliff)


XLIFF (XML Localization Interchange File Format) is an XML-based format created
to standardize the way localizable data are passed between and among tools during a localization process.

With djangocms-xliff it is possible to export all text objects from a page into an XLIFF-compatible file and re-import
the file at the end of the translation process.

## Migration to django-cms 5

If you are using djangocms-xliff with django-cms version 3 or lower use the v1 release of this package:
```shell
pip install djangocms-xliff==1.*.*
```

*We are not planning to support this package for django-cms version 3 or lower*

Please upgrade to a v2 release if you are using django-cms version 5 or higher

## Installation

Before the installation you need to make sure, that your
localization / internalization are set up properly
for [Django](https://docs.djangoproject.com/en/dev/topics/i18n/translation/)
and [Django-CMS](https://docs.django-cms.org/en/latest/topics/i18n.html)

### Setup

djangocms-xliff is available on [PyPI](https://pypi.org/project/djangocms-xliff/):

```shell
$ pip install djangocms-xliff
```

Add `djangocms_xliff` to your `INSTALLED_APPS`.

```python
INSTALLED_APPS = (
    ...,
    "djangocms_xliff"
)
```

Add the views for `djangocms_xliff` to your `urls.py`

```python
urlpatterns = [
    path("xliff/", include("djangocms_xliff.urls"))
]
```

## Documentation

To make the process fail-safe there are some Django CMS related restrictions:

* You can only import the file to the same page and language that you exported from before.
* It is not possible to export a file for one language and import it to another language.
* It is not possible to add fields during the translation process. (Missing fields will be ignored.)

This is because the reference for an entity is the unique ID of the Django CMS plugin, and each plugin has its own
unique ID for each page and language.

Therefore, you need to follow these steps to work with djangocms-xliff.

### Step-by-step

If the page does not exist yet in the target language, create it and copy the plugins from the page with the source
plugins.

Go to the page in the target language.

Export the XLIFF file at Language > Export as XLIFF…

![Export](docs/screenshots/export.png)

This will generate an XLIFF file in the following format:

```xml
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
    <file original="verbund/meilen/projekt" datatype="plaintext" source-language="fr" target-language="en">
        <tool tool-id="96" tool-name="djangocms_xliff" tool-company-name="Energie 360°"/>
        <body>
            <trans-unit id="5872__title" resname="5872__title" maxwidth="60" size-unit="char"
                        extype="django.db.models.fields.CharField">
                <source><![CDATA[The project in short]]></source>
                <target><![CDATA[]]></target>
                <note>CarouselTripleBlockWrapperPlugin</note>
                <note>Carousel Triple Block</note>
                <note>Titel</note>
                <note>Max characters: 60</note>
            </trans-unit>
            <trans-unit id="5874__title" resname="5874__title" maxwidth="35" size-unit="char"
                        extype="django.db.models.fields.CharField">
                <source><![CDATA[Practical Solution]]></source>
                <target><![CDATA[]]></target>
                <note>CarouselTripleBlockSlidePlugin</note>
                <note>Slide</note>
                <note>Titel</note>
                <note>Max characters: 35</note>
            </trans-unit>
        </body>
    </file>
</xliff>
```

Edit the file in the XLIFF editor of your choice.

Import the XLIFF to the same page in the same language you exported from with Languages > Import from XLIFF

![Import](docs/screenshots/import.png)

You will get a preview of the import that needs to be confirmed.

![Preview](docs/screenshots/preview.png)

The translations are now imported, and you can publish the page.

## Settings

By default, djangocms-xliff searches for the following django model fields: `CharField, SlugField, TextField, URLField`
in your
plugins.
The texts from these fields will be used for the XLIFF import and export.

If you want to add additional or 3rd party app fields, you can define the following settings in your `settings.py`,
to integrate them into the XLIFF package:

```python
# A list of fields, that will be searched for while exporting.
DJANGOCMS_XLIFF_FIELDS = (
    "djangocms_text_ckeditor.fields.HTMLField",
)
```

```python
# List of tuples with field and custom function for the export
DJANGOCMS_XLIFF_FIELD_EXTRACTORS = (
    ("third_party.models.LinkField", "your_module.xliff.link_field_extractor"),
)


# The signature of the extractor function must be the following:
# The source parameter is the same as getattr(instance, field.name)
def link_field_extractor(instance: CMSPlugin, field: LinkField, source: Any) -> List[djangocms_xliff.types.Unit]:
    # example:
    from djangocms_xliff.utils import get_type_with_path

    text = source.find_text()
    return [
        Unit(
            plugin_id=str(instance.pk),
            plugin_type=instance.plugin_type,
            plugin_name=instance.get_plugin_name(),
            field_name=field.name,
            field_type=get_type_with_path(field),
            field_verbose_name=field.verbose_name,
            source=text,
            max_length=field.max_length,
        )
    ]
```

```python
# List of tuples with field and custom function for the import
DJANGOCMS_XLIFF_FIELD_IMPORTERS = (
    ("third_party.models.LinkField", "your_module.xliff.link_field_importer"),
)


# The signature of the importer function must be the following:
def link_field_importer(instance: CMSPlugin, unit: djangocms_xliff.types.Unit) -> CMSPlugin:
    # example:
    field = getattr(instance, unit.field_name)
    field.body = unit.target
    return instance
```

```python
# List of custom validators for fields that need to be ignored or included in the export
DJANGOCMS_XLIFF_VALIDATORS = ("your_module.xliff.is_not_background",)


# The signature of the validator function must be the following:
def is_not_background(field: django.db.models.Field, instance: CMSPlugin) -> bool:
    # example:
    return field.name != "background"
```

## Placeholders Outside the CMS

This package does not handle translatability at database level. There are various packages for that. We recommend the
use of `django-modeltranslation`. Because this way import and export of XLIFF works out-of-the-box.

You can import / export any django model with this package. In your admin.py add the following code:

```python
from django.contrib import admin
from djangocms_xliff.admin import XliffImportExportMixin

from magazine.models import Article


@admin.register(Article)
class ArticleAdmin(XliffImportExportMixin, admin.ModelAdmin):
    pass
```

You can customize the fields that are exported with the following configuration:

```python
# By default djangocms_xliff.settings.METADATA_FIELDS fields get exported. You can include and exclude fields like this:
DJANGOCMS_XLIFF_MODEL_METADATA_FIELDS = {
    'magazine.models.Article': {
        "include": {
            "lead": _("Lead"),
        },
        'exclude': ["slug", "og_title", "og_description"]
    }
}
```

If you have a custom alias content in your app, you need to set the following setting variable:

```python
DJANGOCMS_XLIFF_MODEL_FOR_ALIAS_CONTENT = "your_module.xliff.get_model_for_alias_content"


# The signature of the path function must be the following:
def get_model_for_alias_content(alias):
    if hasattr(alias, "magazine_article"):
        return alias.magazine_article
    return None
```

You need to make sure that the your model has a `get_absolute_url(language: str)` method for everything to work.

## Contribute

Issues and pull requests are welcomed.

You can find a documentation on how to set up your project
in [here](docs/contribute.md)