Create or update text overrides using Git.
You can manually create or adjust text overrides through your community repository. This guide explains the file naming conventions and how key-value pairs are handled inside the JSON files.
Each language you want to create text overrides for receives a unique JSON file. Within the file, you can override text for specified components by identifying the components and text you are overriding.
Creating a text file for a different language
You need a separate text.{language-country}.json file for each language. These files are created automatically and pushed to the Git repository when done through a GraphQL request.
When creating these updates manually, you must put these files in the repository.
These codes follow the ISO 639-1 for language codes and ISO 3166-1 alpha-2 for country codes.
Here is a list of currently supported languages and their associated JSON file names.
| Language | File Name |
|---|---|
| English (United States) | text.en-us.json |
| English (United Kingdom) | text.en-gb.json |
| French (France) | text.fr-fr.json |
| Spanish (Spain) | text.es-es.json |
| Italian (Italy) | text.it-it.json |
| Dutch (Netherlands) | text.nl-nl.json |
| Portuguese (Brazil) | text.pt-br.json |
| Portuguese (Portugal) | text.pt-pt.json |
| Russian (Russia) | text.ru-ru.json |
| Polish (Poland) | text.pl-pl.json |
| Korean (South Korea) | text.ko-kr.json |
| Chinese (Simplified, China) | text.zh-cn.json |
| Japanese (Japan) | text.ja-jp.json |
| German (Germany) | text.de-de.json |
Caution: The language and locale codes should remain lowercase when manually creating these files. This prevents potential conflicts from case-sensitive systems.
Creating or Updating a Text Override
To manually create a text override, add a text.{language-country}.json file for each language you want to override. For example, Brazilian Portuguese would require creating a text.pt-br.json file.
The text override JSON file is a complete (not partial) override of the default Quilt, meaning the entire file is overridden and inherits nothing from the default Quilt.
Text fields
The text JSON file stores the following key-value properties:
<ComponentId, <TextKey, Text>>Field Name: key
Description: The component ID.
Example:
{
"community.pages.communityPage": {
....
}
}
Field Name: values
Description: The key and its assigned value in <key, values> format.
Example:
{
"NodeHeader.title": "Search test five",
"NodeHeader.description": "Description test five",
"NodePageHeaderWidget-title.title": "Header widget"
}
ATLAS
Comments