-
Notifications
You must be signed in to change notification settings - Fork 0
How to bring your extension to Crowdin
This document describes how an extension author can get his extension setup at Crowdin. In future it will be automated but for the beginning, follow this steps.
Important to know
- Your extension must be on GitHub, BitBucket or GitLab
- Currently TYPO3 can only handle one branch/version for languages, more to that later.
Get in contact with Georg Ringer, best via TYPO3 slack with the following information:
- Extension name
- Info if the extension is already on the current translation server or not
- Your email address for an invitation to Crowdin, so you will get the correct role for your project.
You need to handle the integration yourself as you got the permissions on GitHub.
Go to the url of your project at Crowdin (e.g. https://crowdin.com/project/typo3-extension-ttaddress
) and switch to Settings & then switch to the tab Integrations. Click on the button Setup integration.
A modal will open and will allow to to select the proper repository.
Select the branches you want to be translated. Important to know: TYPO3 can currently handle one branch, so currently it is enough to just select the master branch.
Click on the Show advanced settings link below to decide now how you want your translations to behave:
- If set, the translations will be forwared to your version control project as seperate branch and you can actually use the translations already in your extension.
- If unchecked, the translations will be shipped by the new translation server (once it is up)
Recommended setting: uncheck it!
Now click on the edit button next to the branch name to setup your branch configuration.
This will open a new modal and will ask for the Configuration file name. We propose the file name .crowdin.yaml
Adopt the file name and press Continue.
Now you need to define where the language files are located.
Typically the following setup will workout file:
-
Source file path:
/Resources/Private/Language/
-
Translated file path:
/%original_path%/%two_letters_code%.%original_file_name%
Please check in the right area of the model if all xlf files have been identified.
Important to know: If you have decided to push the translations back to your extension, you will need some further configuration for the source files, e.g. /Resources/Private/Language/l.*
to distinguish between source and target files.
Now press the green save button in upper left corner and then the save button in lower right corner.
Now press the last save button and you are done!
After a short time you should see something like that
Happy translating!
If your extension has been translated on the translation server already, I will import those translations.