2021-10-17 18:26:00 +02:00
|
|
|
---
|
2021-12-28 12:23:33 +01:00
|
|
|
title: Translation guide
|
2021-10-17 18:26:00 +02:00
|
|
|
---
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
Supporting multiple languages is one of the best way to promote inclusion and
|
|
|
|
accessibility. Thanks to the efforts of our community, FreeSewing is proudly
|
|
|
|
multilingual.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
This translation guide covers everything you need to know to join the effort of
|
|
|
|
translating FreeSewing into other languages.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
## Supported Languages
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
FreeSewing is currently available in the following languages:
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-22 15:50:24 +02:00
|
|
|
| Code | Language | Website |
|
|
|
|
| ----:|:-------------- |:------- |
|
|
|
|
| `de` | **German** | https://de.freesewing.org/ |
|
|
|
|
| `en` | **English** | https://en.freesewing.org/ |
|
|
|
|
| `es` | **Spanish** | https://es.freesewing.org/ |
|
|
|
|
| `fr` | **French** | https://fr.freesewing.org/ |
|
|
|
|
| `nl` | **Dutch** | https://nl.freesewing.org/ |
|
2024-01-21 11:16:40 -08:00
|
|
|
| `uk` | **Ukrainian** | https://uk.freesewing.org/ |
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
<Note compact>
|
|
|
|
English is the translation source language and the working language of the FreeSewing project
|
|
|
|
</Note>
|
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
## Become a FreeSewing translator
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
To gain access as a FreeSewing translator, you will need an invite.
|
2023-07-08 12:48:30 +02:00
|
|
|
You can request a translator invite with the link below.
|
|
|
|
When you do, we will send you an email with all further instructions.
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2023-07-08 12:48:30 +02:00
|
|
|
<Link compact>
|
|
|
|
|
2024-02-02 07:08:53 -08:00
|
|
|
###### [Request a FreeSewing translator invite](https://freesewing.org/translation/join)
|
2023-07-08 12:48:30 +02:00
|
|
|
</Link>
|
2021-08-25 16:09:31 +02:00
|
|
|
|
2023-07-08 12:48:30 +02:00
|
|
|
<Tip>
|
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
We also have [a dedicated __Translation__ channel on
|
|
|
|
Discord](https://discord.freesewing.org) for any questions that may remain.
|
2023-07-08 12:48:30 +02:00
|
|
|
</Tip>
|
2021-08-26 11:51:47 +02:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
## Adding a new language
|
|
|
|
|
2024-01-21 11:16:40 -08:00
|
|
|
We would love to make FreeSewing available in more languages. If you are
|
2023-07-08 12:41:16 +02:00
|
|
|
interested in starting a new translation effort, that is great.
|
2021-08-26 11:51:47 +02:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
We ask that you familiarize yourself with this translation guide to understand
|
2023-07-08 12:48:30 +02:00
|
|
|
what it takes to add a new language. Then if you can submit your request to setup
|
|
|
|
a new language with the link below.
|
|
|
|
|
|
|
|
<Link compact>
|
2021-08-26 11:51:47 +02:00
|
|
|
|
2024-02-02 07:08:53 -08:00
|
|
|
###### [Suggest a new FreeSewing language](https://freesewing.org/translation/suggest-language)
|
2023-07-08 12:48:30 +02:00
|
|
|
</Link>
|
2021-08-26 11:51:47 +02:00
|
|
|
|
|
|
|
<Tip>
|
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
##### Get the band together
|
2021-08-26 11:51:47 +02:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
We recommend finding some like-minded people who can help translating.
|
2021-08-26 11:51:47 +02:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
While the core materials of FreeSewing can realistically be handled by one
|
|
|
|
person, translating all of FreeSewing's documentation and content realistically
|
|
|
|
is a job you should not undertake on your own.
|
2021-08-26 11:51:47 +02:00
|
|
|
|
|
|
|
</Tip>
|
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
<Comment by="joost" >
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
##### Do or do not. There is no try.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
There is a certain cost to adding a new language. It's not a cost in money,
|
|
|
|
but rather in increased bandwidth, storage requirements, build times,
|
|
|
|
repository size, test times, and so on.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
It's a cost we are __more than happy__ to pay for the benefit gaining another
|
|
|
|
langauge. But it is also a cost that needs to be paid up front, at the start
|
|
|
|
of the effort.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
So, without wanting to discourage anyone, I would really like to avoid a
|
|
|
|
scenario where people enthusiastically start working on a new languages, only
|
|
|
|
to lose interest days or weeks later and see the effort falter.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
With that out of the way, I hope to see many more languages being added in the
|
|
|
|
future.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
</Comment>
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
## Translation status
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
The status of the ongoing translation work is available at
|
|
|
|
[FreeSewing.org/translation](https://freesewing.org/translation).
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
It's a good place to check what languages need extra help, and which are
|
|
|
|
leading the scoreboard.
|
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
## Translation priorities
|
2023-07-08 12:41:16 +02:00
|
|
|
|
|
|
|
To fully translate FreeSewing, the following types of content needs to be
|
|
|
|
translated:
|
|
|
|
|
2023-07-22 15:50:24 +02:00
|
|
|
### Top priority: UX Translations
|
2023-07-08 12:50:48 +02:00
|
|
|
These are translations the directly impact
|
2023-07-08 12:41:16 +02:00
|
|
|
the user experience (_UX_). They include the content used in design, the names
|
|
|
|
of options, translations of menus, emails, and so on.
|
|
|
|
|
|
|
|
This is a relatively small amount of text, and makes up less than 10% of the
|
|
|
|
top & high priority content. It's an effort that a motivated translator can
|
|
|
|
complete over the course of a weekend.
|
|
|
|
|
2023-07-22 15:50:24 +02:00
|
|
|
<Tip>
|
|
|
|
The top-priority translations in Crowdin are everything under the `packages`
|
|
|
|
and `sites` folder. Do this first.
|
|
|
|
</Tip>
|
|
|
|
|
2024-01-21 11:16:40 -08:00
|
|
|
### High priority: Translation of Documentation
|
2023-07-08 12:50:48 +02:00
|
|
|
This includes all the documentation on FreeSewing.org.
|
2023-07-08 12:41:16 +02:00
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
This is a significant amount of text that makes up more than 90% of the top &
|
2023-07-08 12:41:16 +02:00
|
|
|
high priority content. It's an effort you should probably not take on by
|
|
|
|
yourself, but rather tackle with a team of translators.
|
|
|
|
|
2023-07-22 15:50:24 +02:00
|
|
|
<Tip>
|
|
|
|
The high-priory translations in Crowdin is everything under the
|
|
|
|
`markdown/org/docs` folder.
|
|
|
|
</Tip>
|
|
|
|
|
|
|
|
### Low Priority: Content of blog and showcase posts, and newsletters
|
2023-07-08 12:50:48 +02:00
|
|
|
This is _nice to have_ as people can use and navigate FreeSewing even when this
|
|
|
|
content remains untranslated.
|
2023-07-08 12:41:16 +02:00
|
|
|
|
2023-07-22 15:50:24 +02:00
|
|
|
<Tip>
|
|
|
|
The low-priory translations in Crowdin is everything under the
|
|
|
|
`markdown/org/blog`, `markdown/org/showcase`, and `markdown/org/newsletter` folders.
|
|
|
|
</Tip>
|
|
|
|
|
2023-07-08 12:41:16 +02:00
|
|
|
## Translation through Crowdin
|
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
All of our translation work is handled through [Crowdin](https://crowdin.com/),
|
|
|
|
an online platform to facilitate translation.
|
2023-07-08 12:41:16 +02:00
|
|
|
|
|
|
|
<Tip compact>
|
|
|
|
|
|
|
|
You can reach the FreeSewing project on Crowdin directly via
|
|
|
|
[translate.freesewing.org](https://translate.freesewing.org).
|
|
|
|
</Tip>
|
|
|
|
|
|
|
|
Crowdin is configured to automatically detect all of the various translation
|
|
|
|
files in our repository, upload them to the platform, and break them apart into
|
|
|
|
bite-sized portions that you can translate in a collaborative way.
|
|
|
|
Rather than work on one large block of text, various people can jump in and
|
|
|
|
translate smaller snippets,
|
|
|
|
|
|
|
|
Once translated, there is a proofreading step that will be handled by one of
|
|
|
|
our proofreaders. This is often a formality, but it's an extra step to allow
|
2024-01-21 11:16:40 -08:00
|
|
|
quality assurance and avoid any mistakes from slipping in. Much like the code
|
2023-07-08 12:41:16 +02:00
|
|
|
review process when you submit a pull request on GitHub.
|
|
|
|
|
2024-01-21 11:16:40 -08:00
|
|
|
Once your translation is approved, Crowdin will automatically submit a pull
|
2023-07-08 12:41:16 +02:00
|
|
|
request on GitHub to update the translation files in our repository. And the
|
2024-02-02 07:08:53 -08:00
|
|
|
next time our website or software packages get built, they will include the new
|
2023-07-08 12:41:16 +02:00
|
|
|
translations.
|
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
## Machine translation
|
2023-07-08 12:41:16 +02:00
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
While everybody knows that translation is best when it's done by a human being,
|
|
|
|
we also have to be realistic that the growing body of documentation and other
|
|
|
|
FreeSewing content can be a daunting task to take on for translators, especially
|
|
|
|
when you want to start a new language.
|
2023-07-08 12:41:16 +02:00
|
|
|
|
2024-01-21 11:16:40 -08:00
|
|
|
Fortunately, machine translation has gotten rather good so we can get some help.
|
2023-07-16 08:01:17 +02:00
|
|
|
Our Crowdin project is integrated with a [DeepL](https://www.deepl.com)
|
|
|
|
subscription, and this can be a great help to translators.
|
2023-07-08 12:41:16 +02:00
|
|
|
|
2023-07-16 08:01:17 +02:00
|
|
|
You can use the DeepL suggestions when translating, or there is also the possibility
|
|
|
|
to machine-translate entire files or folders. For example, you may start a new
|
|
|
|
language by machine-translating everything, and then focus on proofreading the
|
|
|
|
top-priority content, and then move on to the high-priority content.
|
2021-12-28 12:23:33 +01:00
|
|
|
|
2021-08-26 11:51:47 +02:00
|
|
|
## Syntax
|
|
|
|
|
|
|
|
Most strings are just text, but sometimes you'll find a little markup sprinkled in.
|
|
|
|
|
2022-12-25 20:58:40 -08:00
|
|
|
### HTML formatting
|
2021-08-26 11:51:47 +02:00
|
|
|
|
|
|
|
When you encounter HTML tags, simply translate around them. For example:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
<b>No</b>, never.
|
|
|
|
```
|
|
|
|
|
|
|
|
looks like this in Spanish:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
<b>No</b>, nunca.
|
|
|
|
```
|
|
|
|
|
2022-12-25 20:58:40 -08:00
|
|
|
### Placeholders
|
2021-08-26 11:51:47 +02:00
|
|
|
|
|
|
|
When you encounter a `{key}` between curly braces, leave it as-is.
|
|
|
|
These will be filled in later with the correct value. For example:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
{field} saved
|
|
|
|
```
|
|
|
|
|
|
|
|
looks like this in Spanish
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
{field} guardado
|
|
|
|
```
|
2023-07-08 12:41:16 +02:00
|
|
|
|
|
|
|
## Questions, Suggestions, Discussion
|
|
|
|
|
|
|
|
If you have questions, suggestions, or would like to discuss
|
|
|
|
translation-related matters, please join
|
|
|
|
[discord.freesewing.org](https://discord.freesewing.org/) and head to the
|
|
|
|
__Translation__ channel.
|
|
|
|
|