diff --git a/Documentation/ApiOverview/Localization/TranslationServer/Crowdin/ExtensionIntegration.rst b/Documentation/ApiOverview/Localization/TranslationServer/Crowdin/ExtensionIntegration.rst index 164f38b80f..19c71fd093 100644 --- a/Documentation/ApiOverview/Localization/TranslationServer/Crowdin/ExtensionIntegration.rst +++ b/Documentation/ApiOverview/Localization/TranslationServer/Crowdin/ExtensionIntegration.rst @@ -67,6 +67,30 @@ Step-by-step instructions for GitHub ignore: - /**/%two_letters_code%.%original_file_name% + If you provide a :file:`labels.xlf` file for the + :ref:`site settings `, + the `/Configuration/Sets/` folder should be added: + + .. code-block:: yaml + :caption: EXT:my_extension/.crowdin.yml + + preserve_hierarchy: 1 + files: + - source: /Configuration/Sets/*/*.xlf + translation: /%original_path%/%two_letters_code%.%original_file_name% + ignore: + - /**/%two_letters_code%.%original_file_name% + - source: /Resources/Private/Language/*.xlf + translation: /%original_path%/%two_letters_code%.%original_file_name% + ignore: + - /**/%two_letters_code%.%original_file_name% + + .. note:: + If you use the configuration with the :file:`/Configuration/Sets/*/*.xlf` + source and do not provide labels, the GitHub action returns an error. + However, your files from the :file:`/Resources/Private/Language/` folder + will still be uploaded. + 2. Connect your GitHub repository In order for Crowdin to manage translations, you need to somehow push the diff --git a/Documentation/ApiOverview/SiteHandling/SiteSettingDefinitions.rst b/Documentation/ApiOverview/SiteHandling/SiteSettingDefinitions.rst index 5893b6daf8..e0617da26f 100644 --- a/Documentation/ApiOverview/SiteHandling/SiteSettingDefinitions.rst +++ b/Documentation/ApiOverview/SiteHandling/SiteSettingDefinitions.rst @@ -292,6 +292,11 @@ For example, the label of the setting is simply `label` in the XLF file. My Custom Set +.. important:: + To translate the labels of your settings using Crowdin, you need to adjust + your extension's + :ref:`Crowdin configuration file `. + .. _site-settings-definition-translation-category: Translating category labels