mirror of
https://github.com/RoboSats/robosats.git
synced 2024-12-15 11:56:23 +00:00
b4a54f3b1a
* Update 00-contribute.md Add context to body * Update 01-development.md Add context, revise typos and grammatical error * Update 02-languages.md Add context, correct typos and grammatical errors * Update 03-liquidity.md Add rough draft for opening channels, and how that can be a way to contribute to RoboSats * Update 04-guides.md Add rough draft for contributing guides, and general things to consider * Update 05-art.md Add rough draft for art * Update 06-outreach.md Add rough draft for outreach * Update 07-donate.md Fix typos * Update 01-development.md Revise wording * Update 03-liquidity.md Revise wording * Update 06-outreach.md Revise wording
54 lines
4.6 KiB
Markdown
54 lines
4.6 KiB
Markdown
---
|
|
layout: single
|
|
title: "Translate RoboSats"
|
|
permalink: /contribute/languages/
|
|
sidebar:
|
|
title: '<img id="side-icon-verybig" src="/assets/vector/language.svg"/>Translation'
|
|
nav: contribute
|
|
toc: true
|
|
toc_sticky: true
|
|
src: "_pages/contribute/02-languages.md"
|
|
---
|
|
|
|
|
|
RoboSats is a way to exchange BTC for **any currency of the world**. As such, many users might only find this tool useful if it is available in a language they understand. Translating RoboSats into a new language is one of the most valuable contributions to the project! It makes the platform available to new audiences, increases the reach of this cool freedom tool, and subsequently increases order book liquidity for even more users to stack Sats privately.
|
|
|
|
There isn't a lot of text in RoboSats; however, it might be best to split the work with another contributor. You can reach out to the [Telegram communities](https://learn.robosats.com/contribute/code/#communication-channels) and find users willing to split the task.
|
|
|
|
## How To Contribute a New Translation
|
|
|
|
Simply create a new translation file in `frontend/src/static/locales` [link to GitHub](https://github.com/RoboSats/robosats/tree/main/frontend/static/locales). In `locales` there is a single file with a json dictionary for every language. In order to create a new translation, simply copy `en.json` (the master text) into a new file named after the language's [ISO 639 two character code](https://www.loc.gov/standards/iso639-2/php/English_list.php).
|
|
|
|
## Guidelines
|
|
|
|
Each language `.json` dictionary contains pairs of keys and values in the following format { "key1":"value1", "key2":"value2", ...}. Most keys are the literal English sentence. These simply have to be translated on the right side, for example, in order to translate the `Make Order` button to Spanish, you would edit the json file to look like this `{... "Make Order":"Crear Orden",...}`.
|
|
|
|
### 1. **Not all keys are explicit sentences.**
|
|
Some keys are not the English sentence, but a variable name. E.g., "phone_unsafe_alert". In this case, you must take a look at the value originally in `en.json`.
|
|
|
|
### 2. **The language dictionary is split into 9 sections.**
|
|
The first key of each section is a reference and does not need to be translated. For example, the second section starts with the key:value `"USER GENERATION PAGE - UserGenPage.js": "Landing Page and User Generation"`. It does not need to be translated; it is just information for the translator to understand what part of the app they will be working on.
|
|
|
|
### 3. **Try to keep a similar length to the original sentence.**
|
|
In most cases it will be okay if the translation is shorter. However, translations that result in a higher character count might break the UI! It might not always be possible to stick to the length of the English sentence. In those cases, the UI might have to be changed. Contact the person responsible for such a change.
|
|
|
|
### 4. **Some sentences contain variables.**
|
|
For example, {{currencyCode}}. It will insert the currency code where the variable is found. E.g., `"Pay 30 {{currencyCode}}"` will render as "Pay 30 USD".
|
|
|
|
### 5. **Some sentences contain HTML tags.**
|
|
These tags are usually hyperlinks. For example, in `{"phone_unsafe_alert": "Use <1>Tor Browser</1> and visit the <3>Onion</3> site."}` the children text of <1> (Tor Browser) will link to the Tor Download website, and the children of <3> will link to the RoboSats Onion site.
|
|
|
|
### 6. **It is best to translate from top to bottom of the .json file**
|
|
Some text is high priority, other text is low priority. Some keys are likely to change soon or they might not be so relevant for the user of the app. The translation files are sorted from top to bottom by the priority of the translation.
|
|
|
|
### 7. **Use a spell checker.**
|
|
Yes, please! 😉
|
|
|
|
### 8. **Understand the context; where will this string be displayed?**
|
|
Literal translations might not work well in some languages. While in English the wording is always similar regardless of the position in the UI, in some languages it might be very different if you are translating a button (the user is taking an action) or if you are simply translating a tooltip. It might be clever to translate the strings while looking at the app. However, many strings can only be found while trading. The testnet RoboSats site is great for this use! You can explore the whole app by simply interacting with it using a testnet Lightning wallet. However, if you cannot find where a string is displayed, it might be faster to simply write a message on the [Telegram group](https://t.me/robosats).
|
|
|
|
### 9. **Congratulate yourself!!**
|
|
Seriously. It's so awesome you are helping build freedom tools!
|
|
|
|
{% include improve %}
|