From 75417f5e3d32645859d94cec82255dc130ec4a2e Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 18:55:34 +0200 Subject: Adding upstream version 2020.10.7. Signed-off-by: Daniel Baumann --- doc/Translation.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 doc/Translation.md (limited to 'doc/Translation.md') diff --git a/doc/Translation.md b/doc/Translation.md new file mode 100644 index 0000000..6292b07 --- /dev/null +++ b/doc/Translation.md @@ -0,0 +1,92 @@ +# Translating Privacy Badger + +We need your help in translating Privacy Badger to every possible language! + +When translating you should always use the source (American English) locale as +the reference. You can also use existing translations from other languages to +help you in case of doubt, but you should always consider the English version +as the correct one. + + +#### A note about adding translation strings in PRs + +While working on a Privacy Badger enhancement, you might need to add one or +more localized strings. You only need to add new strings to the source +(`en_US`) locale. There is no need to manually add untranslated copies of new +messages to all other locales. This will be taken care of later by a Privacy +Badger maintainer. + + +## Working with translations on GitHub + +Translations on GitHub are done with JSON files. +Each language has its own folder inside +[`src/_locales/`](https://github.com/EFForg/privacybadger/tree/master/src/_locales) +(e.g. 'es' for Spanish, 'ru' for Russian, etc.). +Inside each of these folders is a JSON file that contains the translated +strings for that language. Each entry in the JSON file follows this structure: + + "string_identifier": { + "message": "String text" + "description": "Some useful info" + } + +The translated string is the `"String text"` part. You should **NOT** change +any other part of the entry. + +The `"Some useful info"` part sometimes contains useful information (in +English) about the string. Usually it provides the context of the string: what +it is ("a section heading") and where it can be found in the UI ("on the new +user intro page"). You should not translate it. + +To contribute on GitHub, first check the status of your local language +translation: if you don't see a folder with your +[local language code](https://developer.chrome.com/webstore/i18n?csw=1#localeTable), +the translation for that language is missing. In this case you should follow +the instructions below to set up the JSON file for your language. If the +translation for your language is already there, you can contribute by checking +its accuracy and by correcting any errors you find (see below for +instructions). + +#### Add a new language + +To add a new language on GitHub, follow these steps: + +1. Fork this repository +2. Inside your fork, create a folder in `src/_locales/` and name it +with your [local language code](https://developer.chrome.com/webstore/i18n?csw=1#localeTable) +3. Copy the `src/_locales/en_US/messages.json` file to the folder you created +4. Start translating each message to your language by replacing the +English strings with the translated ones +5. When you have completed the translation, [open a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). Here you can find +an example translation pull request: [#1270](https://github.com/EFForg/privacybadger/pull/1270). + +#### Correct an existing translation + +To correct errors in an existing translation: + +1. Fork this repository +2. Open your local language JSON file and apply the changes +3. When you have completed your work, [open a pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/). +Here you can find an example translation pull request: +[#1270](https://github.com/EFForg/privacybadger/pull/1270). + + +## Testing your translations + +To see your (in-progress) translations in the actual Privacy Badger UI, you should first [load Privacy Badger from source code](/doc/develop.md#install-from-source). + +A quick/hacky way to change Privacy Badger's locale is to temporarily copy the locale you want to use to your default (OS) locale's folder in `src/_locales/` and reload Privacy Badger. + +The proper way would be to launch the browser in your desired locale. + +For Chrome, it might be as easy as [launching it from the command line with `LANGUAGE=fr` (for example) in front of the executable](https://stackoverflow.com/questions/24992240/start-google-chrome-with-a-specific-locale-using-a-command-line-argument). + +Firefox requires [downloading a language pack](https://addons.mozilla.org/en-US/firefox/language-tools/) and [setting it as your locale from about:config](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Internationalization#Testing_out_your_extension). + + +## Other information + +To learn about outstanding translations-related issues, and to +see how translations have been handled in the past, take a look +at issues and pull requests marked with the [translations label](https://github.com/EFForg/privacybadger/issues?utf8=%E2%9C%93&q=label%3Atranslations%20). -- cgit v1.2.3