peertube-plugin-livechat/support/documentation/content/contributing/translate/_index.en.md

59 lines
2.3 KiB
Markdown
Raw Normal View History

+++
title="Translate"
description="Translate the plugin"
weight=20
chapter=false
+++
You can contribute to this plugin translation.
Translations are handled using the [Weblate](https://weblate.org/) software,
using [Framasoft Weblate instance](https://weblate.framasoft.org/).
{{% notice warning %}}
Never modify directly files in the `languages` folder, this could lead to conflicts.
{{% /notice %}}
## How to
2023-02-15 13:44:03 +00:00
* Create an account: https://weblate.framasoft.org/accounts/register/
* Validate your email and follow the link sent
* Create your password and setup your account
* Go to the plugin project page: https://weblate.framasoft.org/projects/peertube-livechat/peertube-plugin-livechat/
* Choose the locale you want to translate
* Just translate missing sentences, or correct the ones that seems incorrect to you.
{{% notice warning %}}
There might be some «very technical» strings. If you are not 100% sure of
the meaning, or of your translation, you better not translate it,
so it will display in english.
{{% /notice %}}
## Documentation translation
2023-06-12 08:40:11 +00:00
Fow now, this is not done on Weblate. I am still looking for the good technical solution.
2023-02-15 13:44:03 +00:00
Please refer to the "documentation" documentation page.
2023-02-15 13:44:03 +00:00
## Adding a new locale
2023-02-15 13:44:03 +00:00
If you think there is a missing locale, please check first if it is handled in Peertube.
If so, you can [open an issue](https://github.com/JohnXLivingston/peertube-plugin-livechat/issues) to ask for it.
2023-02-15 13:44:03 +00:00
## Adding new strings / use translations in the code
2023-02-15 13:44:03 +00:00
If you are working on new features, and need new strings, you can create them directly in Weblate.
The english version is mandatory. Start with it.
2023-02-15 13:44:03 +00:00
Each string is linked to a key (for example `use_chat`).
Choose an explicit key in english.
2023-02-15 13:44:03 +00:00
To use a string in front-end, you need (for now) to call `peertubeHelpers.translate` with the english string.
This means we can't change english strings without updating the code.
This is not optimal, but will change in a near future.
2023-02-15 13:44:03 +00:00
For backend, for now the only file where there is localisation is
`server/lib/settings.ts`. There is a `loc` function to call, passing as parameter the localisation key.
2023-02-15 13:44:03 +00:00
If you have to test new strings without waiting for a Weblate merge, you can modify `languages/*.yml` files, but avoid to commit these change
(to minimize conflict risks).