Development of multilingual projects
Faceplate supports multilingual projects. Localization supported:
- Development Environment Interfaces
- Text properties of mnemonic elements (see Graphic editor)
- Message Texts (see Message System)
Вставить рис. Редактор локализации
The editor allows you to connect new language packs, and add / redefine texts for already connected packages. At the top of the editor is the control panel, below - the base of texts. Control Panel:
| Update text database display. If several developers are working on a project at the same time, the button may be used to receive updates made by others. | |
|---|---|
| Adding new text (see Adding text) | |
| Text editing | |
| Deleting text | |
| Search text elements of a string entry | |
| Connecting a new language pack (see Adding a language pack) | |
| Export text database to .csv file (see Export / Import text database) | |
| Import text database from .csv file |
Adding text
To add new text to the database, click on the button.
on the control panel. As a result, the following dialog opens:
The key field defines the default value for this text, the field is required. If the text value is not defined for the language pack, the system will display the text specified in the key field. The remaining fields define the value of the text specified in the key for the connected language packs.
ATTENTION! When creating messages (see Message system) and working with text properties of elements of mnemonic circuits (see Graphic editor), the used texts are added to the database automatically. For them, the key and value for the language pack in which the user worked is filled in automatically. For automatically added texts, it is sufficient to determine their values for other language packs. Add language pack By default, the following language packs are enabled in the Faceplate system:
- English
- Russian
on the control panel. As a result, the dialog for adding a language pack will open:
It is recommended to use the common language code (ISO 639-1) as the name. By pressing OK, a new blank column will be added to the text database, defining the text values for the created language pack. For filling the language pack, it is recommended to use export / import mechanisms.
Export / Import Text Database
The database of texts can be unloaded into a .csv file - the “Export” button in the localization editor. As a result, the browser will download the text database file - LOCALIZATION_all.csv. The .csv format is text-based and is intended to represent tabular data. The encoding used is UTF8, a tab character is used as a column separator. Viewing and editing the file is conveniently performed using table editors that support the .csv format (for example, Microsoft Excel - https://products.office.com/ru-en/excel or LibreOffice - https://ru.libreoffice.org/), An example of the contents of a file in the LibreOffice editor:
Each line corresponds to the text and has a key field that defines the key (see Adding text) and a set of columns defining the meaning of the text for the connected language packs.
In the file, you can add or edit lines. Saving should be done in the same format (format - csv with Tab delimiters, UTF8 encoding). The file can be imported back into the project, as a result of which the changes made will be loaded into the database. Also, the export / import mechanism allows you to transfer settings between projects, for example, from a test server or a developer’s station to a combat project. To import a file, click on the “Import” button on the control panel. As a result, the file selection dialog will appear:
File selection is supported using the Explorer (“Browse” button) or a drag-and-drop operation, i.e. dragging a file into the area labeled “no file selected”. After selecting a file, the “OK” button will become active, when clicked, the selected file will be imported. In case of inconsistency of the data imported from the file, for example, if there is no specified tag, an error will be displayed with indication of the line number and the error text. Attention! The imported file with the database of archived parameters must have the name LOCALIZATION_all.csv. The file name is used by the import mechanism to determine the software module that loads the data from the file.