diff --git a/webapp/locales/README.md b/webapp/locales/README.md index e86245863..b5e40ab2d 100644 --- a/webapp/locales/README.md +++ b/webapp/locales/README.md @@ -1,56 +1,24 @@ -# Primer on adding or updating a language file used in Human Connection +![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together") -## Get the current files as base for changes +There are basically two ways to translate the messages for the Human Connection +website: -* Checkout the current repository if you have not done yet +* The easier way for the so-called *regular users* with no programming knowledge + or even an understanding of version control system. + + [Guideline for volunteers using lokalise](lokalise-user/README.md) + +* The second way might be better suited for people with programming background. + Especially programmers might like this way to immediately update the messages + related to their source contributions. + + [Translate manually using the git repository](translate-manually/README.md) + +* In case you want to help maintain the translation environment on lokalise + you might want to read the following section to get an idea about those tasks. - git clone https://github.com/Human-Connection/Human-Connection.git + [Administrative tasks on lokalise for Human-Connection](lokalise-admin/README.md) -* Update an already existing repository to the most recent state - - git checkout master - git pull upstream master - -* Create a branch for your coming changes based on the language code for your language. - For a list of all the codes based on ISO-639 see [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - Use the two-letter code in column *639-1* like *en* or *de*. - - The branch name should help recognise what is happing in it. As a suggestion you could use the following pattern: - - * Start with _update_ for updates, _new_ for new languages - * One minus sign - * Your two-letter language code - * Optionally another minus sign and short details if needed. Maybe a date or a release number if appropriate. - * Do not use spaces in the branch name, replace them with underscores instead. - - For example: update-it-rev_1.2.3 - - git checkout -b update-it-rev_1.2.3 - -## Add a new language - - git add it.json - - blabla - -## Update an existing language file - - blabla - -## Release your changes - -* Upload your changes to the offical repository - - git push origin update-it-rev_1.2.3 - -* Create a pull request for your branch on GitHub by visiting the according link in your browser: - https://github.com/Human-Connection/Human-Connection/pull/new/update-it-rev_1.2.3 - - If everything goes well, the maintainers will accept your request. Otherwise they will - notify via the usual ways Github supports. Additionally all the messages appear on the above web site. - - After your Pull Request is accepted on merged into the official part you should move your - local repository back to master as well and delete the temporary branch: - - git checkout master - git branch -D update-it-rev_1.2.3 + If you still want to help out after reading everything ;-) visit the + [developer's chat at Discord](https://discordapp.com/invite/DFSjPaX). Introduce yourself by clicking + *#introduce-yourself* on the left and mention *@@Mentor* to get you onboard. diff --git a/webapp/locales/lokalise-admin/README.md b/webapp/locales/lokalise-admin/README.md index 6237df702..5556d19f0 100644 --- a/webapp/locales/lokalise-admin/README.md +++ b/webapp/locales/lokalise-admin/README.md @@ -1,2 +1,31 @@ +![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together") + # Administrative tasks on lokalise for Human-Connection +![Download translations from lokalise](lokalise-admin-download.png) + +![General settings part 1](lokalise-admin-generallower.png) + +![General settings part 2](lokalise-admin-generalupper.png) + +![Glossary for common expressions](lokalise-admin-glossary.png) + +![Integrations](lokalise-admin-integrations.png) + +![Edit integrations](lokalise-admin-integrationsedit.png) + +![Integrations sections](lokalise-admin-integrationsselect.png) + +![People](lokalise-admin-people.png) + +![Quality checks](lokalise-admin-qachecks.png) + +![Screeshots](lokalise-admin-screenshots.png) + +![Snapshot](lokalise-admin-snapshots.png) + +![Create a task](lokalise-admin-taskcreate.png) + +![Task options](lokalise-admin-taskoptions.png) + +![Task scope](lokalise-admin-taskscope.png) diff --git a/webapp/locales/lokalise-admin/lokalise-admin-download.png b/webapp/locales/lokalise-admin/lokalise-admin-download.png index 831a1aa71..c0c268fe3 100644 Binary files a/webapp/locales/lokalise-admin/lokalise-admin-download.png and b/webapp/locales/lokalise-admin/lokalise-admin-download.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-download.xcf b/webapp/locales/lokalise-admin/lokalise-admin-download.xcf new file mode 100644 index 000000000..6ea94ac6d Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-download.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-generallower.png b/webapp/locales/lokalise-admin/lokalise-admin-generallower.png new file mode 100644 index 000000000..019d86afc Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-generallower.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-generallower.xcf b/webapp/locales/lokalise-admin/lokalise-admin-generallower.xcf new file mode 100644 index 000000000..f6674eb51 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-generallower.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-generalupper.png b/webapp/locales/lokalise-admin/lokalise-admin-generalupper.png new file mode 100644 index 000000000..022db9c4f Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-generalupper.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-generalupper.xcf b/webapp/locales/lokalise-admin/lokalise-admin-generalupper.xcf new file mode 100644 index 000000000..4b9034e91 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-generalupper.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-glossary.png b/webapp/locales/lokalise-admin/lokalise-admin-glossary.png index 9fa4d33c6..236323caf 100644 Binary files a/webapp/locales/lokalise-admin/lokalise-admin-glossary.png and b/webapp/locales/lokalise-admin/lokalise-admin-glossary.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-glossary.xcf b/webapp/locales/lokalise-admin/lokalise-admin-glossary.xcf new file mode 100644 index 000000000..405e87750 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-glossary.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-integrations.png b/webapp/locales/lokalise-admin/lokalise-admin-integrations.png new file mode 100644 index 000000000..b0edf3516 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-integrations.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-integrations.xcf b/webapp/locales/lokalise-admin/lokalise-admin-integrations.xcf new file mode 100644 index 000000000..22c94f819 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-integrations.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-integrationsedit.png b/webapp/locales/lokalise-admin/lokalise-admin-integrationsedit.png new file mode 100644 index 000000000..c1c69fa72 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-integrationsedit.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-integrationsedit.xcf b/webapp/locales/lokalise-admin/lokalise-admin-integrationsedit.xcf new file mode 100644 index 000000000..baa899509 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-integrationsedit.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-integrationsselect.png b/webapp/locales/lokalise-admin/lokalise-admin-integrationsselect.png new file mode 100644 index 000000000..f25108610 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-integrationsselect.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-integrationsselect.xcf b/webapp/locales/lokalise-admin/lokalise-admin-integrationsselect.xcf new file mode 100644 index 000000000..31764080d Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-integrationsselect.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-people.png b/webapp/locales/lokalise-admin/lokalise-admin-people.png index fd3483ec2..fb97aa34e 100644 Binary files a/webapp/locales/lokalise-admin/lokalise-admin-people.png and b/webapp/locales/lokalise-admin/lokalise-admin-people.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-people.xcf b/webapp/locales/lokalise-admin/lokalise-admin-people.xcf new file mode 100644 index 000000000..1e0e03b1f Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-people.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-qachecks.png b/webapp/locales/lokalise-admin/lokalise-admin-qachecks.png new file mode 100644 index 000000000..6ea84704c Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-qachecks.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-qachecks.xcf b/webapp/locales/lokalise-admin/lokalise-admin-qachecks.xcf new file mode 100644 index 000000000..7a39d1818 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-qachecks.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-screenshots.png b/webapp/locales/lokalise-admin/lokalise-admin-screenshots.png index 95bf29459..ba5668f3a 100644 Binary files a/webapp/locales/lokalise-admin/lokalise-admin-screenshots.png and b/webapp/locales/lokalise-admin/lokalise-admin-screenshots.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-screenshots.xcf b/webapp/locales/lokalise-admin/lokalise-admin-screenshots.xcf new file mode 100644 index 000000000..ba2a2fcc1 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-screenshots.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-snapshots.png b/webapp/locales/lokalise-admin/lokalise-admin-snapshots.png new file mode 100644 index 000000000..92f3496d7 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-snapshots.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-snapshots.xcf b/webapp/locales/lokalise-admin/lokalise-admin-snapshots.xcf new file mode 100644 index 000000000..81e55ee94 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-snapshots.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-taskcreate.png b/webapp/locales/lokalise-admin/lokalise-admin-taskcreate.png index b8060273f..3cd56b05a 100644 Binary files a/webapp/locales/lokalise-admin/lokalise-admin-taskcreate.png and b/webapp/locales/lokalise-admin/lokalise-admin-taskcreate.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-taskcreate.xcf b/webapp/locales/lokalise-admin/lokalise-admin-taskcreate.xcf new file mode 100644 index 000000000..6d22d52ef Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-taskcreate.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-taskoptions.png b/webapp/locales/lokalise-admin/lokalise-admin-taskoptions.png index ea59eb944..c46374f73 100644 Binary files a/webapp/locales/lokalise-admin/lokalise-admin-taskoptions.png and b/webapp/locales/lokalise-admin/lokalise-admin-taskoptions.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-taskoptions.xcf b/webapp/locales/lokalise-admin/lokalise-admin-taskoptions.xcf new file mode 100644 index 000000000..cd63185f6 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-taskoptions.xcf differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-taskscope.png b/webapp/locales/lokalise-admin/lokalise-admin-taskscope.png index 4f317186f..c629d16bd 100644 Binary files a/webapp/locales/lokalise-admin/lokalise-admin-taskscope.png and b/webapp/locales/lokalise-admin/lokalise-admin-taskscope.png differ diff --git a/webapp/locales/lokalise-admin/lokalise-admin-taskscope.xcf b/webapp/locales/lokalise-admin/lokalise-admin-taskscope.xcf new file mode 100644 index 000000000..ef9f29ab6 Binary files /dev/null and b/webapp/locales/lokalise-admin/lokalise-admin-taskscope.xcf differ diff --git a/webapp/locales/lokalise-user/README.md b/webapp/locales/lokalise-user/README.md index 82c430723..8ebea2e13 100644 --- a/webapp/locales/lokalise-user/README.md +++ b/webapp/locales/lokalise-user/README.md @@ -1 +1,55 @@ -# Guideline for uses to help translate Human-Connection \ No newline at end of file +![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together") + +# Translating Human-Connection + +## Guideline for volunteers using lokalise + +If you don't already have an account, register yourself at +[lokalise.co](https://lokalise.co/signup). + +![Register account](lokalise-user-register.png "Register on lokalise.co") + +Lokalise is earning money by providing paid services, but to translate for +Human-Connection the free account is enough. After registration you get 30 days +of trial period for the professional services. After that time you get a notice +that your trial account expired. You can safely ignore this message as the free +account related to Human-Connection still continues. + +The next step is fill in some details. Usually you choose *translator* as role. +If you don't represent a company you can enter *myself* or something else you +find applicable. + +![Select your role](lokalise-user-role.png "Select your role") + +Once your new account is verified, you can join +[Human-Connection](https://lokalise.co/public/556252725c18dd752dd546.13222042/) + +![Join the Human-Connection project](lokalise-user-join.png "Join the Human-Connection project") + +After selecting *Join this project* you choose which language you want to translate to. + +If you are familiar with more than one language, you might choose *All*. So you can later +select any language to translate to or use as a reference language to translate from. +If you select only one language, you can at a later point let one of the adminstrators +add another languate to your personal pool. + +![Select your translation language(s)](lokalise-user-selectlang.png "Select your language(s)") + +When selecting a reference language you should keep in mind, that English is the projects main +language, to certain degree also German. All translations should mainly use these two as reference. +If you are familiar with anther language that had some time to mature, you could switch to maybe +get a better idea for tricky translations. + +If in doubt about the intended maining of an entry you should ask at the +[developer's chat at Discord](https://discordapp.com/invite/DFSjPaX). Introduce yourself by clicking +*#introduce-yourself* on the left and mention *@@Mentor* to get you onboard. + +After that you are ready to translate. + +![Translate simple entries](lokalise-user-translate.png "Translate simple entries") + +![Translation with a named variable](lokalise-user-translate-token.png "Translation with a named variable") + +![Translation with a link](lokalise-user-translate-link.png "Translation with a link") + +![Handle translation warnings](lokalise-user-translate-warning.png "Handle translation warnings") diff --git a/webapp/locales/lokalise-user/lokalise-user-join.png b/webapp/locales/lokalise-user/lokalise-user-join.png new file mode 100644 index 000000000..c14924485 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-join.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-join.xcf b/webapp/locales/lokalise-user/lokalise-user-join.xcf new file mode 100644 index 000000000..2ee96e69f Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-join.xcf differ diff --git a/webapp/locales/lokalise-user/lokalise-user-overview.png b/webapp/locales/lokalise-user/lokalise-user-overview.png new file mode 100644 index 000000000..bba49c942 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-overview.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-overview.xcf b/webapp/locales/lokalise-user/lokalise-user-overview.xcf new file mode 100644 index 000000000..0975e5457 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-overview.xcf differ diff --git a/webapp/locales/lokalise-user/lokalise-user-register.png b/webapp/locales/lokalise-user/lokalise-user-register.png new file mode 100644 index 000000000..586270344 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-register.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-register.xcf b/webapp/locales/lokalise-user/lokalise-user-register.xcf new file mode 100644 index 000000000..ce45637e6 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-register.xcf differ diff --git a/webapp/locales/lokalise-user/lokalise-user-role.png b/webapp/locales/lokalise-user/lokalise-user-role.png new file mode 100644 index 000000000..186a94f5b Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-role.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-role.xcf b/webapp/locales/lokalise-user/lokalise-user-role.xcf new file mode 100644 index 000000000..e77b8b0bf Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-role.xcf differ diff --git a/webapp/locales/lokalise-user/lokalise-user-selectlang.png b/webapp/locales/lokalise-user/lokalise-user-selectlang.png new file mode 100644 index 000000000..7918463e7 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-selectlang.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-selectlang.xcf b/webapp/locales/lokalise-user/lokalise-user-selectlang.xcf new file mode 100644 index 000000000..bc35d0ab7 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-selectlang.xcf differ diff --git a/webapp/locales/lokalise-user/lokalise-user-translate-link.png b/webapp/locales/lokalise-user/lokalise-user-translate-link.png new file mode 100644 index 000000000..515454ea3 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-translate-link.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-translate-link.xcf b/webapp/locales/lokalise-user/lokalise-user-translate-link.xcf new file mode 100644 index 000000000..e82b8a1b1 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-translate-link.xcf differ diff --git a/webapp/locales/lokalise-user/lokalise-user-translate-token.png b/webapp/locales/lokalise-user/lokalise-user-translate-token.png new file mode 100644 index 000000000..c0e5151ab Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-translate-token.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-translate-token.xcf b/webapp/locales/lokalise-user/lokalise-user-translate-token.xcf new file mode 100644 index 000000000..79ffda418 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-translate-token.xcf differ diff --git a/webapp/locales/lokalise-user/lokalise-user-translate-warning.png b/webapp/locales/lokalise-user/lokalise-user-translate-warning.png new file mode 100644 index 000000000..106f44812 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-translate-warning.png differ diff --git a/webapp/locales/lokalise-user/lokalise-user-translate-warning.xcf b/webapp/locales/lokalise-user/lokalise-user-translate-warning.xcf new file mode 100644 index 000000000..f80210fb0 Binary files /dev/null and b/webapp/locales/lokalise-user/lokalise-user-translate-warning.xcf differ diff --git a/webapp/locales/translate-manually/README.md b/webapp/locales/translate-manually/README.md new file mode 100644 index 000000000..922ecb2c0 --- /dev/null +++ b/webapp/locales/translate-manually/README.md @@ -0,0 +1,78 @@ +![Let's get together](https://raw.githubusercontent.com/Human-Connection/Human-Connection/master/.gitbook/assets/lets_get_together.png "Let's get together") + +# Translating Human-Connection using the git repository + +## Get the current files as base for changes + +* Checkout the current repository if you have not done yet + +```shell + git clone https://github.com/Human-Connection/Human-Connection.git +``` + +* Update an already existing repository to the most recent state + +```shell + git checkout master + git pull upstream master +``` + +* Create a branch for your coming changes based on the language code for your language. + For a list of all the codes based on ISO-639 see [Wikipedia](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). + Use the two-letter code in column *639-1* like *en* or *de*. + + The branch name should help recognise what is happing in it. As a suggestion you could use the following pattern: + + * Start with _update_ for updates, _new_ for new languages + * One minus sign + * Your two-letter language code + * Optionally another minus sign and short details if needed. Maybe a date or a release number if appropriate. + * Do not use spaces in the branch name, replace them with underscores instead. + + For example: update-it-rev_1.2.3 + +```shell + git checkout -b update-it-rev_1.2.3 +``` + +## Add a new language + +```shell + git add it.json +``` + + blabla + +## Update an existing language file + + blabla + +## Release your changes + +* Upload your changes to the offical repository + +```shell + git push origin update-it-rev_1.2.3 +``` + +* Create a pull request for your branch on GitHub by visiting the according link in your browser: + https://github.com/Human-Connection/Human-Connection/pull/new/update-it-rev_1.2.3 + + If everything goes well, the maintainers will accept your request. Otherwise they will + notify via the usual ways Github supports. Additionally all the messages appear on the above web site. + + After your Pull Request is accepted on merged into the official part you should move your + local repository back to master as well and delete the temporary branch: + +```shell + git checkout master + git branch -D update-it-rev_1.2.3 +``` + + If you get stuck between commits and pulls, thw following two commands force a return to + the most recent remote state: + +```shell + git fetch origin + git reset --hard origin/master +```