Skip to content

[CTRL-3191] Add Advanced Import / Export of languages - Documentation #9821

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -54,15 +54,17 @@ The **Language** menu allows you to manage additional languages and translations

The **Language** menu items are described in the table below:

| Menu Item | Description | Shortcut Key |
| --- | --- | --- |
| <a id="current-language"></a>**Current Language** | Choose the current language from one of the languages set up in **Language Settings…**. | *None* |
| **Select Previous Language** | Choose the previous language in the list of languages chosen in **Language Settings…**. | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>L</kbd> |
| **Select Next Language** | Choose the next language in the list of languages chosen in **Language Settings…**. | <kbd>Ctrl</kbd> + <kbd>L</kbd> |
| [Language Settings…](/refguide/language-settings/) | Choose which languages are supported by the app and configure date and time settings. | *None* |
| [Batch Replace…](/refguide/batch-replace/) | Change all occurrences of chosen translatable texts in the current language where they are identical. | *None* |
| [Batch Translate…](/refguide/batch-translate/) | Add and edit translations from a selected source language to a selected target language | *None* |
| [Language Operations…](/refguide/language-operations/) | Manipulate (for example, copy) translations between languages. | *None* |
| Menu Item | Description | Shortcut Key |
|-------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| --- |
| <a id="current-language"></a>**Current Language** | Choose the current language from one of the languages set up in **Language Settings…**. | *None* |
| **Select Previous Language** | Choose the previous language in the list of languages chosen in **Language Settings…**. | <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>L</kbd> |
| **Select Next Language** | Choose the next language in the list of languages chosen in **Language Settings…**. | <kbd>Ctrl</kbd> + <kbd>L</kbd> |
| [Language Settings…](/refguide/language-settings/) | Choose which languages are supported by the app and configure date and time settings. | *None* |
| [Batch Replace…](/refguide/batch-replace/) | Change all occurrences of chosen translatable texts in the current language where they are identical. | *None* |
| [Batch Translate…](/refguide/batch-translate/) | Add and edit translations from a selected source language to a selected target language | *None* |
| [Language Operations…](/refguide/language-operations/) | Manipulate (for example, copy) translations between languages. | *None* |
| [Advanced Translations Import](/refguide/advanced-translations-import/) | Import translations from Excel or PO files. | *None* |
| [Advanced Translations Export](/refguide/advanced-translations-export/) | Export translations as Excel or PO files. | *None* |

## Setting the End-User's Language

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: "Advanced Translations Export"
url: /refguide/advanced-translations-export/
weight: 60
---

## Introduction

**Advanced Translations Export** allows you to export translations to Microsoft Excel (*.xlsx*) or PO (*.po*) format files.

## Using Advanced Translations Export

To export languages, from the top-bar menu, select **Language > Advanced Translations Export** and choose one of the following options:

* **As Excel (.xlsx) file** – export translations to a Microsoft Excel (*.xlsx*) format file
* **As PO (.po) files** – export translations to PO (*.po*) format files.

{{< figure src="/attachments/refguide/modeling/menus/translatable-texts/advanced-translations-export.png" alt="Advanced Translations Export" >}}

When you select an option, a directory selector appears. Select a directory containing the files you want to export.

A pop-up will appear confirming the start of the export.

### Export as Excel

Click **As Excel (*.xlsx) file** and select a directory for the export. Studio Pro will create a subdirectory named in the format `Export_{app-name}_Xlsx_{time-stamp}`. The translations will be saved as a Microsoft Excel (*.xlsx*) format file. The file will be named in the format `{app-name}-translations.xlsx` (e.g. *App-translations.xlsx*) and contain the following columns:

* `Mendix Reference`
* `Module`
* `Document`
* `Path to element`
* `Element`
* `Source Text ({source_language})`
* `{translation_language 1}`
* ...
* `{translation_language_n}`

{{< figure src="/attachments/refguide/modeling/menus/translatable-texts/advanced-translations-excel.png" alt="Advanced Translations Export Excel" >}}

{{% alert color="warning" %}}
The formats of the Excel file for **Advanced Translations Export** and [Advanced Translations Import](/refguide/advanced-translations-import/) are similar. However, the files are incompatible with export to Excel and import from Excel in [Batch Replace](/refguide/batch-replace/) and [Batch Translate](/refguide/batch-translate/).
{{% /alert %}}

### Export as PO

Click **As PO (`*.po*`) files** and select a directory for the export. Studio Pro will create a subdirectory named in the format `Export_{app-name}_Po_{time-stamp}`. The translations will be saved as PO (`*.po*`) format files. The files will be named in the format `{app-name}-{language}.po` (e.g. *App-en_US.po*).

{{% alert color="warning" %}}
The formats of the PO files for **Advanced Translations Export** and [Advanced Translations Import](/refguide/advanced-translations-import/) are similar.
{{% /alert %}}

After completion, a confirmation pop-up appears. If the operation fails, a failure pop-up is displayed instead.

{{% alert color="warning" %}}
Do not close the app while the export is running.
{{% /alert %}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: "Advanced Translations Import"
url: /refguide/advanced-translations-import/
weight: 50
---

## Introduction

**Advanced Translations Import** allows you to import translations from Microsoft Excel (*.xlsx*) or PO (*.po*) format files.

## Using Advanced Translations Import

To import languages, from the top-bar menu, select **Language > Advanced Translations Import** and choose one of the following options:

* **From Excel (.xlsx) file** – import translations from a Microsoft Excel (*.xlsx*) format file
* **From PO (.po) files** – import translations from PO (*.po*) format files.

{{< figure src="/attachments/refguide/modeling/menus/translatable-texts/advanced-translations-import.png" alt="Advanced Translations Import" >}}

When you select an option, a directory selector appears. Select the directory containing the files you want to import.

A pop-up will appear confirming the start of the import.

### Import from Excel

Click **From Excel (.xlsx) file** and select a directory containing a Microsoft Excel (*.xlsx*) format file. The file needs to meet the following requirements:

* The file must be named in the format `{app-name}-translations.xlsx` (e.g. *App-translations.xlsx*)
* The file must have the following columns:
* `Mendix Reference`
* `Module`
* `Document`
* `Path to element`
* `Element`
* `Source Text ({source_language})`
* `{translation_language 1}`
* ...
* `{translation_language_n}`

{{< figure src="/attachments/refguide/modeling/menus/translatable-texts/advanced-translations-excel.png" alt="Advanced Translations Import Excel" >}}

{{% alert color="warning" %}}
The formats of the Excel file for **Advanced Translations Import** and [Advanced Translations Export](/refguide/advanced-translations-export/) are similar. However, the files are incompatible with import from Excel and export to Excel in [Batch Replace](/refguide/batch-replace/) and [Batch Translate](/refguide/batch-translate/).
{{% /alert %}}

### Import from PO

Click **From PO (.po) files** and select a directory containing PO (*.po*) format files. The files must be named in the format `{app-name}-{language}.po` (e.g. *App-en_US.po*).

{{% alert color="warning" %}}
The formats of the PO files for **Advanced Translations Import** and [Advanced Translations Export](/refguide/advanced-translations-export/) are similar.
{{% /alert %}}

After completion, a confirmation pop-up appears. If the operation fails, a failure pop-up is displayed instead.

{{% alert color="warning" %}}
Do not close the app while the import is running.
{{% /alert %}}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Language Settings"
url: /refguide/language-settings/
weight: 50
weight: 10
---

## Introduction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Using Translatable Validation Messages"
url: /refguide/translatable-validation-messages/
weight: 140
weight: 160
description: "Describes how to use translatable validation messages."
aliases:
- /howto/logic-business-rules/translatable-validation-messages/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Translating Your App Content"
url: /refguide/translate-your-app-content/
weight: 50
weight: 150
aliases:
- /howto/collaboration-requirements-management/translate-your-app-content/
---
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.