Interface Translation¶

Interface translation involves localizing static elements such as field labels, descriptions, menu items, and view titles. This is handled via JSON files located within Packages.

Directory Structure¶

Each package contains an optional i18n folder. This folder must contain subfolder for each supported language code. Inside these folders, translations are stored in .json files named after the class they translate.

Generic Path: packages/{package_name}/i18n/{lang}/{class_name}.json

Example: packages/sale/i18n/fr/Customer.json

JSON File Structure¶

The translation file contains metadata about the class, field translations (model), and UI layout translations (view).

Root Properties¶

name: The singular name of the entity (e.g., "Partner").
plural: The plural name of the entity (e.g., "Partners").
description: A general description of the entity.

The `model` Section¶

This section maps field names to their translated attributes.

label: The user-facing name of the field (Must start with a capital letter).
description: A brief summary or tooltip for the field (Should start with a capital letter and end with punctuation).
help: Detailed explanation (optional).
selection: Used for fields with a fixed set of options (like a status field), mapping internal keys to displayed values.

The `view` Section¶

This section translates specific Views and their internal layout sections (tabs, groups). The keys correspond to the view types (e.g., form.default, list.default).

name: The title of the view.
layout: An object mapping section IDs (e.g., section.identity_info) to their translated label.

The `error` Section¶

Used for translating form validation errors or specific controller exceptions.

Comprehensive Example¶

File: packages/accounting/i18n/fr/VatRule.json

{
    "name": "Règle de Tva",
    "plural": "Règles de Tva",
    "description": "Les règles comptables permettent de préciser sur quel compte une opération doit être imputée.",
    "model": {
        "name":{
            "label":"Nom", 
            "description": "Nom de la règle comptable.", 
            "help": ""
        },
        "type":{
            "label":"Type", 
            "description": "Type d'opération.", 
            "selection": {
                "purchase": "achat", 
                "sale": "vente"
            }
        }
    },
    "view": {
        "form.default": {
            "name": "Règles de Tva",
            "description": "Vue par défaut",
            "layout": {
                "section.details": {
                    "label": "Détails"
                }
            }
        },
        "list.default": {
            "name": "Liste des Règles de Tva",
            "description": "Tableau principal",
            "layout": {}
        }
    },
    "error": {}
}

Menus differ from standard Views as they do not bind to a Model field structure. Therefore, their translation files omit the model section. The view section targets the menu items directly.

{
  "description": "Menu de navigation principal",
  "view": {
    "item.bookings": {
      "label": "Réservations",
      "description": "",
      "layout": {}
    },
    "item.planning": {
      "label": "Calendrier",
      "description": "",
      "layout": {}
    }
  }
}

Inheritance and Overloading¶

Classes in eQual can extend other classes (e.g., lodging\Contact extending sale\Contact). Translation resolution follows the class hierarchy.

Inheritance: If a child class does not translate a field, it inherits the translation from its parent.
Overloading: If a child class provides a translation for a field that also exists in the parent, the child's translation takes precedence (is "overloaded").

This allows you to change the label of a generic field (e.g., changing "Name" to "Venue Name") in a specific context without altering the original parent class.

Documentation files (.md)¶

In addition to .json files, you can place Markdown (.md) files in the i18n folder. These files should match the view ID (e.g., Booking.list.default.md) and are used to display rich help content contextually within the application (accessible from the right-side navigation).

Example: packages/booking/i18n/fr/Booking.list.default.md

# Aide pour la liste des réservations
Cette page affiche toutes les réservations. Vous pouvez filtrer, trier et exporter les données selon vos besoins.

Requesting Translations via API¶

The frontend retrieves these translations using the config_i18n controller.

$ ./equal.run --get=config_i18n --entity=core\\User --lang=fr