Joydeep Sen GuptaTable of contents
- Table of contents
- Introduction
- Tor documents to translate
- Technical details
- External translation resources
Introduction
Thanks for helping us translate our software! On this guide we give you information about the translations, please read it to solve your doubts and feel free to propose changes or additions.
Translators are, as the rest of the Tor community, bound to respect the Code of Conduct: https://gitweb.torproject.org/community/policies.git/tree/code_of_conduct.txt
Please consider helping with translations in your native language, however don't start a new regional variant of your language if there is a more general language available (for example: contribute to the French translation, instead of starting Canadian French).
This is due to the fact that each additional language requires more resources, including a set of committed translators and space on our servers.
There are many files to translate and keep up to date to maintain a language for the Tor Project. Moreover, once translated, there are always future updates and new pages needing translated too.
The more users that will benefit from a translation, the more scalable that translation becomes – as it will also benefit from the help of a larger number of volunteers keeping it up to date.
We also recommend forming a team for your language: this way, the content can be reviewed by at least one other person, producing translations that are of higher quality and are easier to maintain.
Tor documents to translate
This is the list of resources for translation ordered by priority. Please make sure translations are complete in order to start translating documents further down the list:
Tor Browser User Manual
This is an important website that is linked from the Browser and has documentation useful for new Tor Browser users.
Translate - Preview - Stats - Live
Tor Project website
This resource is written in markdown and translates the main website
Translate - Preview - Stats - Live
Support Portal
Our documentation for the whole of Tor Project, in FAQ format.
Translate - Preview - Stats - Live
Community portal
Here we show all ways to volunteer for the Tor Project (localization, running a tor relay, giving talks about tor)
Translate - Preview - Stats - Live.
BridgesDB
- The BridgesDB is a webpage where you can get bridges to join the tor network.
- Some of the strings have linebreaks. Just ignore them, no need to 'translate' them. Translate - Live.
Technical details
Markdown text
Links
One of the most common translation mistakes are links.
Links in markdown are like this: [linked word](link), where link can be a URL as in https://community.torproject.org/ , or an internal link as /censorship. For example: See our [documentation about circumvention](/circumvention), or See our [documentation about circumvention](https://tb-manual.torproject.org/circumvention/)
Remember not to leave any spaces between [] and (), because otherwise the link will not work.
| good | bad |
|---|---|
See [here](/circumvention) |
See [here] (/circumvention) |
See [here](/circumvention) |
See [here](/ circumvention) |
Leave the link untranslated:
| good | bad |
|---|---|
Mira [aquí](/circumvention) |
Mira [aquí](/censura) |
There is this page where you can see some of the current problematic strings
How to find the strings in the websites
When on the transifex page, see in the context tab:
- Click on tab to find the context
- See URL of the page. Copy in browser and see the current content of the string.
Quality checks on the websites
Ways to review your work and ensure that your translations do not create problems
- Navigate and see how your translation looks:
- There are preview versions for the yet-not-released languages at https://lektor-staging.torproject.org/ [website] /translations/
- Check specially that the links are working correctly and don't lead to a 404 error.
- Compare with the English version. Do the images appear? are the styling, links, the same?
- Check the broken links page to see if there are links you need to fix
How to submit comments about source (English) strings
If you have comments on source strings it is always better to submit the main content repositories, as developers often don't look to the issues in transifex.
Some other documents, as the Code of Conduct, are not available for source string editions at the moment, in particular the Code of conduct has been ratified by the members of the Tor Project, and changing the text here and there will need a big organizational effort. You are invited to start that process, or wait until there are new amendments to the Code of Conduct to also proposed grammar changes.
Corrections to Tor Websites
For the websites based on Lektor (Tor Browser User Manual, Support Portal, Community Portal, Tor main website) you can submit corrections as explained here:
How to edit a source string, or submit feedback about a source string
- Look for the string Context, and open the link on the 'Ocurrence'. In this picture is:
support.torproject.org/onionservices/onionservices-2/
- Once you have opened the page, click on the link 'Edit this page' at the bottom of the text. You will be offered to edit the original English strings on GitHub.
- Once you are confident with your changes, create a fork of our repository and submit a pull request. The changes will eventually be reflected on transifex.
External translation resources
Keyboard maps for Indian languages
- Keyboard Layouts for Indian Languages - For all the folks translating into Indian languages, a list of the various keyboard layouts for different languages compiled by @championquizzer, so you can change the language at the operating system level and then you can use your en-US keyboard for typing the characters using the layouts as a reference.
- PramukhIME Keyboards - Web-based keyboards for 23 different Indian languages. This will be useful if you do not have the keyboard you need installed on your computer. (Shared during the 2020 India L10n Sprint)