From 5cbe3e13bc4ed111199a5dbf619717ff0dbfd5f3 Mon Sep 17 00:00:00 2001 From: Adrien Hopkins Date: Wed, 24 Aug 2022 16:01:25 -0500 Subject: added extra info on JSON sections --- doc/i18n.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) (limited to 'doc') diff --git a/doc/i18n.md b/doc/i18n.md index 224bcb3e..7c180dcb 100644 --- a/doc/i18n.md +++ b/doc/i18n.md @@ -62,6 +62,26 @@ You might notice that some of the left-text in the language files don't have a s These denote sections of the JSON file, which helps keep it organized. If you're translating a string that is in a section, make sure the translated string is in the same section of the new file. If that section doesn't exist, just create it. +In the translation files, sections roughly correspond to where the the strings are on CoinOS. This can be useful if you need context for a string. Here are some of these associations (`A.B` means section `B` is located inside `A`): + +| Section | Location | +|-------------------|---------------------------------------------------| +| 404 | the 404 page | +| about | the 'About' section at the bottom of the homepage | +| error | the error page | +| faq | the FAQ on the homepage | +| footer | the bottom of the homepage | +| howItWorks | the 'How it Works' section | +| invoice | the Invoice page | +| jobs | the Jobs page | +| landing | the top of the homepage | +| login | the Register and Login pages | +| user | the user page | +| user.dashboard | the user's dashboard | +| user.settings | the settings page | +| user.support | the user's support page | +| user.transactions | the user's transaction history page | + ### HTML Tags Sometimes, you will see strange text surrounded with `<>` angle brackets. Every one of these "HTML tags" will be followed by another one starting with a slash. Here's an example: @@ -111,4 +131,6 @@ There is also a program that helps you translate automatically - all you have to - How to use basic [git](https://git-scm.com/) (cloning, pulling, committing, pushing) - How to run a [Python](https://www.python.org/) script +The script also shows you the ID of each bit of text you are translating, so that you can know where it is. `A.B` means string `B` in section `A`, `A.B.C` means string `C` in subsection `B` in section `A`, etc. + Clone the repository, then use the guided translation script (at `src/locales/guided_translation.py`) to update the translation files. You will need to pull before running, and commit/push your changes in order for them to be applied to CoinOS. -- cgit v1.2.3