Skip to content

Commit 98ec38e

Browse files
authored
Document Crowdin configuration for site settings (#6202)
Resolves: TYPO3/crowdin-bridge#51 Releases: main, 13.4
1 parent db36259 commit 98ec38e

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

Documentation/ApiOverview/Localization/TranslationServer/Crowdin/ExtensionIntegration.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,30 @@ Step-by-step instructions for GitHub
6767
ignore:
6868
- /**/%two_letters_code%.%original_file_name%
6969
70+
If you provide a :file:`labels.xlf` file for the
71+
:ref:`site settings <site-settings-definition-translation>`,
72+
the `/Configuration/Sets/` folder should be added:
73+
74+
.. code-block:: yaml
75+
:caption: EXT:my_extension/.crowdin.yml
76+
77+
preserve_hierarchy: 1
78+
files:
79+
- source: /Configuration/Sets/*/*.xlf
80+
translation: /%original_path%/%two_letters_code%.%original_file_name%
81+
ignore:
82+
- /**/%two_letters_code%.%original_file_name%
83+
- source: /Resources/Private/Language/*.xlf
84+
translation: /%original_path%/%two_letters_code%.%original_file_name%
85+
ignore:
86+
- /**/%two_letters_code%.%original_file_name%
87+
88+
.. note::
89+
If you use the configuration with the :file:`/Configuration/Sets/*/*.xlf`
90+
source and do not provide labels, the GitHub action returns an error.
91+
However, your files from the :file:`/Resources/Private/Language/` folder
92+
will still be uploaded.
93+
7094
2. Connect your GitHub repository
7195

7296
In order for Crowdin to manage translations, you need to somehow push the

Documentation/ApiOverview/SiteHandling/SiteSettingDefinitions.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,11 @@ For example, the label of the setting is simply `label` in the XLF file.
292292
<source>My Custom Set</source>
293293
</trans-unit>
294294
295+
.. important::
296+
To translate the labels of your settings using Crowdin, you need to adjust
297+
your extension's
298+
:ref:`Crowdin configuration file <crowdin-extension-integration-github-configure>`.
299+
295300
.. _site-settings-definition-translation-category:
296301

297302
Translating category labels

0 commit comments

Comments
 (0)