Issue 6171 - create CSV exporter and importer for translations

README.md

 Shared Adblock Plus UI code
 ===========================
 
 The user interface elements defined in this repository will be used by various
 Adblock Plus products like Adblock Plus for Firefox. Their functionality can be
 tested within this repository, even though they might not work exactly the same
 as they will do in the final product.
 
 Installing dependencies
 -----------------------
@@ skipping 150 matching lines @@
 
 
 Translations
 ------------
 
 Translations for the strings in this project are managed using the online
 [Crowdin platform][crowdin]. To synchronise with Crowdin you can use the build
 script. To get a list of the possible commands type `./build.py help` at
 the command line. (You will also need the Crowdin API key for the project.)
 
+Translations CSV exporter
+-------------------------
+
+Translation agencies are using CSVs for translating the strings. CSV exporter
+helps keeping that files in sync with the project. To learn more about the
+script usage run `node build/csv-export.js -h`.
+
+Format of the exported CSV files:
+
+| filename             | StringID                      | Description              | Placeholders                | en_US         | af         | am  | ... |
+|----------------------|-------------------------------|--------------------------|-----------------------------|---------------|------------|-----|-----|
+| desktop-options.json | options_customFilter_cancel   | Label in Advanced tab    |                             | Cancel        | Kanselleer | ይቅር |     |
+| desktop-options.json | options_whitelist_placeholder | Input placeholder prefix | {"domain":{"content":"$1"}} | e.g. $domain$ |            |     |     |

[Thomas Greiner, 2018/05/07 15:16:38]

Don't we have translations for this string?

Note that we don't need to use real strings for this example so feel free to
make up your own mock data for this example to illustrate the format.

[saroyanm, 2018/05/16 17:06:36]

We have I think I used translation from the generated CSV.
What is the problem with real strings ?

[Thomas Greiner, 2018/05/22 17:22:49]

What you're trying to do is to outline the capabilities of this format. Keeping
the content to a minimum and the example self-contained helps to avoid
distractions. Consider this example:

| Filename     | StringID | Description          | Placeholders                |
en_US         | af         | am  | ... |
|--------------|----------|----------------------|-----------------------------|---------------|------------|-----|-----|
| options.json | cancel   | Cancel button label  |                             |
Cancel        | Kanselleer | ይቅር | ... |
| options.json | domain   | Domain input example | {"domain":{"content":"$1"}} |
e.g. $domain$ |            |     | ... |

The content is pretty much the same as the real one but without
implementation-specifics such as
- "desktop-" prefix for the file name
- Long string IDs that are necessary to avoid naming conflicts
- References to something that cannot be found within the examples (e.g.
"Advanced tab")

Finally, using real strings means that we'd need to keep them here in sync with
the ones in the code which could lead to further confusion in the future.

[saroyanm, 2018/06/05 10:35:26]

I'll use your version, thanks.
No we wouldn't at least I wasn't planing to keep in sync until it's a structural
change.

+
+
 firstRun.html
 -------------
 
 This is the implementation of the Adblock Plus first-run page that will show up
 whenever changes are applied automatically to user's Adblock Plus configuration.
 This will usually happen when the user first installs Adblock Plus (initial
 setup), but it can also happen in case the user's settings get lost.
 
 To aid testing, the behavior of this page is affected by a number of URL
 parameters:
@@ skipping 37 matching lines @@
   errors when adding new filters on the options page
 * `blockedURLs`: a comma-separated list of URLs that should be considered
   blocked (necessary to test the check for blocked scripts in sharing buttons).
 * `downloadStatus`: sets downloadStatus parameter for filter lists, can be used
   to trigger various filter list download errors
 * `platform=chromium`: shows the opt-out for the developer tools panel
 * `showNotificationUI=true`: simulates user having opted-out of notifications
 
 
 [crowdin]: https://crowdin.com