Create a Figma project
Contents
Data Source Settings
Figma projects use a repository to store the strings coming from the Lingoport Figma Plugin, in a file following this pattern:
- figma/locales/<locale>/translation.json
If the source locale is, say 'en', then a JSON file must exist in order for the process to complete successfully:
- figma/locales/en/translation.json
The translation.json file can be as simple as:
{
}
Project Name
The values on this page are initially filled in based on the repository, but can be changed at creation or later while editing.
- Set the Group Name. Often, this is the same as the Company Name that Command Center was installed with. But it can be almost anything. There is a restriction that it must be the same case. For example, if the Group Name for other projects is ACME (all caps), then another project cannot be created with a group name of 'acme' or 'Acme'.
- Set the Project Name. Project name must be one word and cannot contain any of the following characters: < > : " * / | ? . % --
- Set the Module Name. This is defaulted to the branch that the project is using.
- Tags - tags can be selected from a drop-down list of already created tags or new ones can be created by selecting the plus sign. Projects can have a number of tags associated with them.
In the module name above, 4.0.41 would not be accepted, the dots (.) would have to be replaced by, say underscores (_).
Accessors
Select the Users and Teams that will have access to this project. Also verify the users that will receive email notifications for this project. The Lingoport Figma Plugin is configured with an API User and token for a Figma project in Command Center. A Command Center Figma project must have an assigned API User.
Translation Connections and Locales
Select a Machine Translation, an LLM, or a Translation Management System that will be translating the resource files. These need to have been created before attempting to create a Localyzer project.
Select the source locale coming from Figma and the target locales into which the Figma strings will be translated.
Configure the Key Generation
From a Figma project, resource files used by an application can be generated. Examples of resource file types are .properties, JSON, XML, iOS strings.xml, Android Localizable.strings, etc. These resource files need a key so that the application knows which string to display on the UI. Keys are generated on the Figma side so they can be viewed in the Figma design, letting developers know what key to use for what string on the design.
See: Create_a_Localyzer_only_project#Figma_to_Dev
- Prefix: the first part of the key
- Suffix: the last part of the key before the counter
- Max key length: the part between the prefix and the suffix is based on the value of the string and cannot be longer than the max
- Key counter start: the counter is the last part of the key so no keys are identical. It's a number which keeps incrementing, starting at the 'start'
For example, if the design string is Welcome, the generated key could be FKEY_Welcome_17 based on the configuration shown in the screen shot above.
Note: If on the Developer's repository, the same file will have strings generated from different Figma Localyzer projects, then the Prefix should be different in each Figma Localyzer projects. For instance, if one Figma design is targeting an Admin screen and another, separate, Figma design is targeting a User screen, and they are on-boarded with two different Localyzer projects, one could have an ADM prefix, the other a USR project, so that two strings both named 'Home' would have unique keys in the same generated Developers project, say ADM_Home_1 and USR_Home_1.
Advanced Settings
These are optional settings to consider in special situations. For example, the commit message for Figma only project could be set as follows:
