diff options
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | doc/i18n-technical.md | 10 | ||||
| -rw-r--r-- | doc/i18n.md | 22 | ||||
| -rw-r--r-- | src/app.html | 2 | ||||
| -rw-r--r-- | src/locales/en.json | 14 | ||||
| -rw-r--r-- | src/locales/fr.json | 10 | ||||
| -rw-r--r-- | src/locales/guided_translation.py | 2 |
7 files changed, 33 insertions, 33 deletions
@@ -2,9 +2,9 @@ [](https://app.netlify.com/sites/coinos/deploys) -CoinOS is an easy to use bitcoin point of sale application for businesses and wallet for customers, connecting the bitcoin circular economy together. +coinos is an easy to use bitcoin point of sale application for businesses and wallet for customers, connecting the bitcoin circular economy together. -This repository is the latest front-end code for the CoinOS web application. +This repository is the latest front-end code for the coinos web application. ## Commands @@ -29,4 +29,4 @@ This UI uses the following libraries: ### Internationalization -CoinOS has a system for translation using [`sveltekit-i18n`](https://www.npmjs.com/package/sveltekit-i18n). For more information and instructions on how to translate CoinOS, click [here](./doc/i18n.md). For technical details, click [here](./doc/i18n-technical.md). +coinos has a system for translation using [`sveltekit-i18n`](https://www.npmjs.com/package/sveltekit-i18n). For more information and instructions on how to translate coinos, click [here](./doc/i18n.md). For technical details, click [here](./doc/i18n-technical.md). diff --git a/doc/i18n-technical.md b/doc/i18n-technical.md index 51e33fe6..4ea2adbe 100644 --- a/doc/i18n-technical.md +++ b/doc/i18n-technical.md @@ -1,4 +1,4 @@ -# CoinOS Internationalization - Technical Information +# coinos Internationalization - Technical Information _NOTE: This documentation was written for people with a technical background. If you do not have a technical background, consider reading [this guide](./i18n.md) instead._ @@ -6,11 +6,11 @@ Last Updated: 2022-08-23 ## Dependencies -CoinOS's internationalization system depends on the `npm` package [`sveltekit-i18n`](https://www.npmjs.com/package/sveltekit-i18n). Consider reading [its documentation](https://github.com/sveltekit-i18n/lib/tree/master/docs/README.md) in addition to this. +coinos's internationalization system depends on the `npm` package [`sveltekit-i18n`](https://www.npmjs.com/package/sveltekit-i18n). Consider reading [its documentation](https://github.com/sveltekit-i18n/lib/tree/master/docs/README.md) in addition to this. ## Internationalization Code -The main code for CoinOS's internationalization is at `src/lib/translations/index.js`. When imported, it does the following: +The main code for coinos's internationalization is at `src/lib/translations/index.js`. When imported, it does the following: 1. Load all of the locales asynchronously, based on . 2. Initialize `sveltekit-i18n`. @@ -41,11 +41,11 @@ Strings are internationalized by simply using `sveltekit-i18n`'s `$t` function. ## The Locale Selector -CoinOS also has a `LocaleSelector` component, which should be used to select locales. It is a dropdown that allows you to select & update the locale. +coinos also has a `LocaleSelector` component, which should be used to select locales. It is a dropdown that allows you to select & update the locale. ## The Guided Translation Script -CoinOS has a Python script that helps you with the technical parts of translation. It is located at `src/locales/guided_translation.py`. It also has some utility functions: +coinos has a Python script that helps you with the technical parts of translation. It is located at `src/locales/guided_translation.py`. It also has some utility functions: - `nested_dict_keys` - gets a list of keys of a nested dictionary in dot-separated shallow format (e.g. a.b.c) - `create_locale` - adds a new locale to the lang.json file diff --git a/doc/i18n.md b/doc/i18n.md index 528f611b..57172464 100644 --- a/doc/i18n.md +++ b/doc/i18n.md @@ -1,6 +1,6 @@ -# CoinOS Internationalization +# coinos Internationalization -CoinOS can be translated into other languages by editing [JSON](https://www.json.org/json-en.html) files. You do not need programming knowledge to do this, or to use these instructions. Here are instructions on how to translate CoinOS: +coinos can be translated into other languages by editing [JSON](https://www.json.org/json-en.html) files. You do not need programming knowledge to do this, or to use these instructions. Here are instructions on how to translate coinos: _NOTE: This guide was written for people without a technical background. If you want more technical details, click [here](./i18n-technical.md)._ @@ -12,11 +12,11 @@ Last Updated: 2022-08-23 ### Language Codes -Before you can translate CoinOS, you need to know the [ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of your language. This is a standard two-letter code that your browser uses to refer to a language (for example, English is `en`, and Spanish is `es`). You can also add a dash and more letters to refer to a specific region (for example, American English is `en-US`, and British English is `en-GB`). A list of all codes can be found [here](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), and Firefox-based browsers show you the code when you are selecting your browser's language. +Before you can translate coinos, you need to know the [ISO 639-1 code](https://en.wikipedia.org/wiki/ISO_639-1) of your language. This is a standard two-letter code that your browser uses to refer to a language (for example, English is `en`, and Spanish is `es`). You can also add a dash and more letters to refer to a specific region (for example, American English is `en-US`, and British English is `en-GB`). A list of all codes can be found [here](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), and Firefox-based browsers show you the code when you are selecting your browser's language. ### Locale Files -Each translation of CoinOS is stored in a special _locale file_. These files can be found in the `src/locales` folder in the CoinOS directory. The name of these files is the language code plus "`.json`". A file might look something like this: +Each translation of coinos is stored in a special _locale file_. These files can be found in the `src/locales` folder in the coinos directory. The name of these files is the language code plus "`.json`". A file might look something like this: ```JSON { @@ -42,7 +42,7 @@ There is also a JSON file that controls which languages are understood. It is at } ``` -This file simply maps each language to its name. It is used both to get a list of languages and to get the name of each language for the language selector. If a translation is not in this file, CoinOS will not be able to see it. +This file simply maps each language to its name. It is used both to get a list of languages and to get the name of each language for the language selector. If a translation is not in this file, coinos will not be able to see it. ### JSON Sections @@ -62,7 +62,7 @@ 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 some text that is in a section, make sure the translated text 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 text is in CoinOS. This can be useful if you need context for some text. Here are some of these associations (`A.B` means section `B` is located inside `A`): +In the translation files, sections roughly correspond to where the the text is in coinos. This can be useful if you need context for some text. Here are some of these associations (`A.B` means section `B` is located inside `A`): | Section | Location | | ----------------- | ------------------------------------------------- | @@ -87,10 +87,10 @@ In the translation files, sections roughly correspond to where the the text is i 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: ```JSON -"p1": "<strong>CoinOS</strong> is an <strong>open source</strong> bitcoin web wallet, point of sale, ecommerce marketplace and exchange platform. Development started in Vancouver in September 2012 as a way to provide local merchants with a convenient way to accept bitcoin payments.", +"p1": "<strong>coinos</strong> is an <strong>open source</strong> bitcoin web wallet, point of sale, ecommerce marketplace and exchange platform. Development started in Vancouver in September 2012 as a way to provide local merchants with a convenient way to accept bitcoin payments.", ``` -These apply a certain style to the text between them. For example, the tags above will make "CoinOS" and "open source" bold, leaving the rest non-bold. +These apply a certain style to the text between them. For example, the tags above will make "coinos" and "open source" bold, leaving the rest non-bold. When translating strings containing tags, don't change the tags. Do translate the text between them, and don't be afraid to move them around - just make sure they contain the same part of the sentence, and that the one without the slash is always before the one with the slash. Not all of the localizable strings support HTML tags, so you shouldn't use them if they aren't in the original string you're translating. @@ -103,7 +103,7 @@ Follow these steps to create a new translation. You will need a GitHub account t  3. Copy the text from `en.json` into this new file. 4. Translate all of the pieces of text on the right. **Do not translate or alter in any way the pieces of text on the left, or any line that doesn't have two pieces of text!** - _NOTE: "CoinOS" is a feminine noun in languages with grammatical gender._ + _NOTE: "coinos" is a feminine noun in languages with grammatical gender._  5. Scroll down and use the green button to commit the file. 6. Go to the `src` folder again, then `lib`, then `translations`, then `lang.json`. @@ -121,7 +121,7 @@ Follow these steps to add to an existing translation. You will also need a GitHu 5. Use the pencil icon on the top-right to edit the file. 6. Add the whole line (both left and right parts) from step 3 to this file, in between the `{}` braces. Make sure the previous line has a comma at the end, and that it is in the same place as before (i.e. inside the same set of `{}` braces - if they don't exist, create them). 7. Translate the piece of text on the right, keeping the quotes surrounding it. **Do not translate or alter in any way the piece of text on the left, or any line that doesn't have two pieces of text!** - _NOTE: "CoinOS" is a feminine noun in languages with grammatical gender._ + _NOTE: "coinos" is a feminine noun in languages with grammatical gender._ 8. Repeat steps 3-7 for every piece of text you want to translate (you should probably open `en.json` in another tab, so that your changes from step 6 aren't erased). 9. Scroll down and use the green button to commit the file. @@ -134,4 +134,4 @@ There is also a program that helps you translate automatically - all you have to 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. +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. diff --git a/src/app.html b/src/app.html index 335772ac..ade9fa4b 100644 --- a/src/app.html +++ b/src/app.html @@ -6,7 +6,7 @@ <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="description" content="Easy to use bitcoin point of sale app and web wallet." /> <meta property="og:image" content="/icons/logo.svg" /> - <title>CoinOS</title> + <title>coinos</title> %sveltekit.head% </head> <body> diff --git a/src/locales/en.json b/src/locales/en.json index 726c47fc..f13c0b80 100644 --- a/src/locales/en.json +++ b/src/locales/en.json @@ -5,7 +5,7 @@ }, "about": { "header": "About", - "p1": "<strong>CoinOS</strong> is an <strong>open source</strong> bitcoin web wallet, point of sale, ecommerce marketplace and exchange platform. Development started in Vancouver in September 2012 as a way to provide local merchants with a convenient way to accept bitcoin payments.", + "p1": "<strong>coinos</strong> is an <strong>open source</strong> bitcoin web wallet, point of sale, ecommerce marketplace and exchange platform. Development started in Vancouver in September 2012 as a way to provide local merchants with a convenient way to accept bitcoin payments.", "p2": "The feature set has grown over the years to accomodate a wide variety of use cases with the goal of making it as easy as possible for anyone to get started using bitcoin quickly, cheaply, and securely.", "p3": "Anyone can download the source code and host their own instance of the platform backed by their own bitcoin, liquid or lightning nodes, or reach out and we'll gladly set this up for you.", "p4": "Intra-account transfers between custodial wallets of different users on our server are completely free, instant, and unlimited.", @@ -24,7 +24,7 @@ }, "locations": { "header": "Locations", - "description": "These are businesses that are accepting bitcoin using CoinOS point of sale. If you are using our application, please <a href=\"mailto:[email protected]\" class=\"underline underline-offset-4\">let us know!</a>" + "description": "These are businesses that are accepting bitcoin using coinos point of sale. If you are using our application, please <a href=\"mailto:[email protected]\" class=\"underline underline-offset-4\">let us know!</a>" } }, "error": { @@ -36,11 +36,11 @@ "header": "FAQ", "cost": { "question": "What does it cost?", - "answer": "CoinOS is free to use. You only pay a 1% fee if/when you withdraw your funds. Compare this to 3% typically charged by a credit card processor." + "answer": "coinos is free to use. You only pay a 1% fee if/when you withdraw your funds. Compare this to 3% typically charged by a credit card processor." }, "compatibility": { "question": "Do I need any special device or software?", - "answer": "No. CoinOS is web-based, so as long as you have an internet connection, you can use it on any device or hardware. Most merchants might use it on a phone or a tablet." + "answer": "No. coinos is web-based, so as long as you have an internet connection, you can use it on any device or hardware. Most merchants might use it on a phone or a tablet." }, "safety": { "question": "Are my funds safe?", @@ -80,7 +80,7 @@ "jobs": { "header": "Jobs", "subheader": "Current Openings", - "pitch1": "CoinOS is actively looking for developers to join our growing team (full-time or part-time, remote working OK).", + "pitch1": "coinos is actively looking for developers to join our growing team (full-time or part-time, remote working OK).", "pitch2": "Excited about working on open source bitcoin? Then take a look at our repositories on", "github": "GitHub", "pitch3": "If you think you can make an impact, we'd love to hear from you. Send us your resume to" @@ -97,7 +97,7 @@ "info2": { "title": "Simple to use, custodial by default", "description1": "Just enter an amount, share the QR code and you’re done.", - "description2": "CoinOS is custodial by default, which eliminates the need to understand how bitcoin/lightning works. We do all the heavy lifting so you can focus on your business.", + "description2": "coinos is custodial by default, which eliminates the need to understand how bitcoin/lightning works. We do all the heavy lifting so you can focus on your business.", "description3": "You always have the option of <span class=\"underline underline-offset-4\">taking custody</span> of your own keys." }, "info3": { @@ -162,7 +162,7 @@ "emailNotifications": "Email Notifications", "emailNotificationsDescription": "Get notified via email when a change occurs on your account or when people send you payments.", "smsNotifications": "SMS Notifications", - "smsNotificationsDescription": "CoinOS will send you text notifications when this is enabled.", + "smsNotificationsDescription": "coinos will send you text notifications when this is enabled.", "theme": "Color Theme", "themeDescription": "Select from the default color themes.", "localCurrency": "Local Currency", diff --git a/src/locales/fr.json b/src/locales/fr.json index ffa8a1f5..69fb6e18 100644 --- a/src/locales/fr.json +++ b/src/locales/fr.json @@ -5,7 +5,7 @@ }, "about": { "header": "À Propos", - "p1": "<strong>CoinOS</strong> est un portefeuille, point de vente, marché d'e-commerce et plateforme d'échange de bitcoin <strong>open source</strong>. Development a commencé en Vancouver le septembre de 2012 pour donner aux marchands du coin un façon pratique d'accepter des paiements en bitcoin.", + "p1": "<strong>coinos</strong> est un portefeuille, point de vente, marché d'e-commerce et plateforme d'échange de bitcoin <strong>open source</strong>. Development a commencé en Vancouver le septembre de 2012 pour donner aux marchands du coin un façon pratique d'accepter des paiements en bitcoin.", "p2": "Il a eu plus de fonctions au fil des ans pour satisfaire une grande variété de cas d'utilisation avec le but de rendre commencer utiliser bitcoin rapidement, à bas prix, et en sécurité aussi façile que possible pour n'importe qui.", "p3": "Tout le monde peux télécharger le code source et héberger leur propre instance de la plateforme soutenu par leur propres nœuds de bitcoin, liquid ou lightning, ou contactez-nous et nous l'installalons pour vous avec plaisir.", "p4": "Transferts entre comptes de garde d'utilisateurs différents en notre serveur sont complètement gratuits, instants et sans limites.", @@ -24,7 +24,7 @@ }, "locations": { "header": "Établissements", - "description": "Il y a des entreprises qui acceptent bitcoin utilisant le point de vente CoinOS. Si vous utilisez notre appli, s'il vous plait <a href=\"mailto:[email protected]\" class=\"underline underline-offset-4\">fais-le-nous savoir!</a>" + "description": "Il y a des entreprises qui acceptent bitcoin utilisant le point de vente coinos. Si vous utilisez notre appli, s'il vous plait <a href=\"mailto:[email protected]\" class=\"underline underline-offset-4\">fais-le-nous savoir!</a>" } }, "error": { @@ -36,11 +36,11 @@ "header": "FAQ", "cost": { "question": "Qu'est-ce que c'est le coût?", - "answer": "CoinOS est gratuit à utiliser. Vous seulment payez un prix 1% quand vous convertez vos fonds entre Bitcoin, Liquid et Lightning. Comparez-ça à les frais de dossir typiques 3% des cartes credit." + "answer": "coinos est gratuit à utiliser. Vous seulment payez un prix 1% quand vous convertez vos fonds entre Bitcoin, Liquid et Lightning. Comparez-ça à les frais de dossir typiques 3% des cartes credit." }, "compatibility": { "question": "Est-ce que j'ai besoin du logiciel ou appareil special?", - "answer": "Non. CoinOS est un site Web, alors vous pouvez l'utiliser sur n'importe quelle appareil tant que vous aves un connexion d'Internet. La plupart des marchands l'utilise sur un téléphone ou une tablette." + "answer": "Non. coinos est un site Web, alors vous pouvez l'utiliser sur n'importe quelle appareil tant que vous aves un connexion d'Internet. La plupart des marchands l'utilise sur un téléphone ou une tablette." }, "safety": { "question": "Sont mes fonds saufs?", @@ -121,7 +121,7 @@ "jobs": { "header": "Emplois", "subheader": "Postes disponibles actuels", - "pitch1": "CoinOS recherche pour des développeurs pour joindre notre équipe croissant (temps plein ou partiel, télétravail OK)", + "pitch1": "coinos recherche pour des développeurs pour joindre notre équipe croissant (temps plein ou partiel, télétravail OK)", "pitch2": "Avez-vous hâte de travailler sur bitcoin open source? Regardez sur nos dépôts sur", "github": "GitHub", "pitch3": "Si vous pensez que vous pouvez exercer une influence positive, nous voulons que vous contribuez. Envoyer votre CV à" diff --git a/src/locales/guided_translation.py b/src/locales/guided_translation.py index 20abfd83..2cc4d2ce 100644 --- a/src/locales/guided_translation.py +++ b/src/locales/guided_translation.py @@ -55,7 +55,7 @@ def localize_string(string_id, from_data, to_data): if __name__ == "__main__": # setup and parse commandline arguments - args_parser = argparse.ArgumentParser(description="guided translation of CoinOS") + args_parser = argparse.ArgumentParser(description="guided translation of coinos") args_parser.add_argument('from_locale', nargs='?', type=str, help="which locale to translate from") args_parser.add_argument('to_locale', nargs='?', type=str, |