language

This is the folder for your translations. In fact, if you only have one language, there is no actual need to maintain translations here. However, it is best practice to separate labels and configuration.

labels.xlf

This XLF file is the english basis for your translations. All translations for backend labels as well as for frontend labels are defined here. Translations to other languages are defined in separate files prefixed with the language code e.g. de.labels.xlf.

Convention

The translation keys follow a convention and are registered automatically. First of all, title and description are used in various areas for the Content Type. Field labels consist of the identifier and label separated by a dot. Same goes for the optional description.

Collections introduce another nesting level. To translate their fields, the identifiers are simply separated by a dot.

Palettes and Tabs have a special convention as well.

It is also possible to translate the items option of Select, Radio and Checkbox fields.

Have a look at the example beneath for better understanding.

Workflow

The recommended workflow is defining the label in the config.yaml first. When you are done, you run the command to auto-generate the labels.xlf file. After that you can remove the labels from the yaml definition. You can also skip the first step and generate the xlf without defining labels first. This will add the identifier as label and you can adjust it afterwards. Either way, it is recommended to maintain a labels.xlf file so you don't mix labels with configuration.

<?xml version="1.0"?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
    <file datatype="plaintext" original="labels.xlf" source-language="en" product-name="example">
        <header/>
        <body>
            <!-- Title and description of the Content Type -->
            <trans-unit id="title" resname="title">
                <source>This is the Content Type backend title</source>
            </trans-unit>
            <trans-unit id="description" resname="description">
                <source>This is the Content Type backend description</source>
            </trans-unit>
            <!-- Field labels and descriptions for the backend -->
            <trans-unit id="FIELD_IDENTIFIER.label" resname="FIELD_IDENTIFIER.label">
                <source>This is the backend label for FIELD_IDENTIFIER</source>
            </trans-unit>
            <trans-unit id="FIELD_IDENTIFIER.description" resname="FIELD_IDENTIFIER.description">
                <source>This is the backend description for FIELD_IDENTIFIER</source>
            </trans-unit>
            <!-- Collections add another nesting level -->
            <trans-unit id="COLLECTION_IDENTIFIER.FIELD_IDENTIFIER.label" resname="COLLECTION_IDENTIFIER.FIELD_IDENTIFIER.label">
                <source>This is the backend label for FIELD_IDENTIFIER in Collection COLLECTION_IDENTIFIER</source>
            </trans-unit>
            <!-- Palette labels and descriptions -->
            <trans-unit id="palettes.PALETTE_IDENTIFIER.label">
                <source>Label for Palette</source>
            </trans-unit>
            <trans-unit id="palettes.PALETTE_IDENTIFIER.description">
                <source>Description for Palette</source>
            </trans-unit>
            <!-- Palettes inside Collections -->
            <trans-unit id="COLLECTION_IDENTIFIER.palettes.PALETTE_IDENTIFIER.label">
                <source>Label for Palette in Collection</source>
            </trans-unit>
            <trans-unit id="COLLECTION_IDENTIFIER1.COLLECTION_IDENTIFIER2.palettes.PALETTE_IDENTIFIER.label">
                <source>Label for Palette in nested Collection</source>
            </trans-unit>
            <!-- Tab labels -->
            <trans-unit id="tabs.TAB_IDENTIFIER">
                <source>Label for Tab</source>
            </trans-unit>
            <!-- Tab labels inside Collections -->
            <trans-unit id="COLLECTION_IDENTIFIER.tabs.TAB_IDENTIFIER">
                <source>Label for Tab in Collection</source>
            </trans-unit>
            <trans-unit id="COLLECTION_IDENTIFIER1.COLLECTION_IDENTIFIER2.tabs.TAB_IDENTIFIER">
                <source>Label for Tab in nested Collection</source>
            </trans-unit>
        </body>
    </file>
</xliff>
Copied!