|
|
Welcome,
|
|
|
|
|
|
Thanks for your help in translating the [Equipd Bible](https://equipd.me) app!
|
|
|
|
|
|
This project centralises the strings for a number of languages, organised in folders based on the language code:
|
|
|
|
|
|
**Completed and live on the App Store:**
|
|
|
|
|
|
* **da** - Danish / Dansk
|
|
|
* **de** - German / Deutsch ([Heiko](https://gitlab.com/u/Farmway))
|
|
|
* **el** - Greek / Ελληνική
|
|
|
* **en** - English (US) ([iMatt](https://gitlab.com/u/iMatt))
|
|
|
* **en-GB** - English (British) ([iMatt](https://gitlab.com/u/iMatt))
|
|
|
* **es** - Spanish / español ([Tony](https://gitlab.com/u/toniotj))
|
|
|
* **fi** - Finnish / Suomi ([Esko](https://gitlab.com/u/eskoarff))
|
|
|
* **fr** - French / Français
|
|
|
* **it** - Italian / Italiano
|
|
|
* **ja** - Japanese / 日本語
|
|
|
* **ko** - Korean / 한국어 ([SangEun](https://gitlab.com/u/xmoonju))
|
|
|
* **nl** - Dutch / Nederlands ([Dave](https://gitlab.com/u/reytan))
|
|
|
* **pl** - Polish / polski ([Jarek](https://gitlab.com/u/PLMan))
|
|
|
* **pt** - Portuguese (Brazil) ([Pedro](https://gitlab.com/u/pedro.prata))
|
|
|
* **pt-PT** - Portuguese (Portugal) ([Pedro](https://gitlab.com/u/pedro.prata))
|
|
|
* **ru** - Russian / русский ([Eugene](https://gitlab.com/u/fursjohn))
|
|
|
* **sv** - Swedish / Svenska ([Simon](https://gitlab.com/u/linderborg))
|
|
|
* **th** - Thai / ไทย ([Benjamas](https://gitlab.com/u/Bbkit))
|
|
|
* **zh-Hans** - Chinese (Simplified) / 汉语
|
|
|
* **zh-Hant** - Chinese (Traditional) / 漢語
|
|
|
|
|
|
**Work in Progress:**
|
|
|
|
|
|
*
|
|
|
|
|
|
## What files need translating?
|
|
|
|
|
|
Translation files are organised into folders named using the correct [ISO 639 language code](https://www.localeplanet.com/icu/iso639.html).
|
|
|
|
|
|
Inside each language folder there are a few files types that can to be translated:
|
|
|
|
|
|
* **strings.json** - contains all the words and sentences shown in the interface in Equipd Bible, for example on the buttons, labels, and alerts.
|
|
|
|
|
|
* **appstore.md** - contains the text detailing Equipd Bible features on the App Store.
|
|
|
|
|
|
* **appstore-keywords.md** - contains the keywords used to help searches on the App Store.
|
|
|
|
|
|
* **appstore-subtitle.md** - contains the short subtitle shown on the App Store under the app name.
|
|
|
|
|
|
* **version-###.md** - contains the upgrade notes shown on the App Store for a new version X.
|
|
|
|
|
|
> The main file to be translated is `strings.json`. I do not typically add the other files until all strings are translated and the language is ready for final testing and to "go live" on the App Store.
|
|
|
|
|
|
## What if my language folder is missing?
|
|
|
|
|
|
Please [email me](mailto:support@equipd.me) to add the language folder and starting files for you.
|
|
|
|
|
|
## How do I test my translations?
|
|
|
|
|
|
I will use [TestFlight](https://testflight.apple.com/) from Apple to provide beta versions of the app to translators.
|
|
|
|
|
|
In order to join the beta testers you will need to email me your GitLab username. Once I see you have edited the translation files, then I will invite you to join the TestFlight beta program.
|
|
|
|
|
|
*PS: Beta versions will only be supplied when a new version of the app is being prepared for the App Store, which could be several days or even weeks after your translation efforts. I will endeavour to enable translation testing as soon as is realistic in the bigger picture.*
|
|
|
|
|
|
## So how do I get started?
|
|
|
|
|
|
1. You need a free GitLab account. [Sign in to GitLab here.](https://gitlab.com/users/sign_in/)
|
|
|
2. You need to Request Access to edit files in this project. Please [go to the main project page here](https://gitlab.com/imatt/sp/i18n), and click the "Request access" button, as shown in the screenshot...
|
|
|
|
|
|
![iMatt_Solutions___ServicePlanner___i18n___GitLab](uploads/eadaf1e5bc2f91bf5bdba18ab26d6245/iMatt_Solutions___ServicePlanner___i18n___GitLab.png)
|
|
|
|
|
|
Otherwise you can [email me](mailto:support@equipd.me) with your GitLab username.
|
|
|
|
|
|
> **Note:** Once you have requested access, you will need to wait for me to receive your request and to grant permission for you to access this project. You will receive an email informing you that you have been given access.
|
|
|
|
|
|
## I have access. How do I edit the files?
|
|
|
|
|
|
Once you have met the above requirements, then it is time to start editing files!
|
|
|
|
|
|
GitLab is all about working with [Git Version Control](https://docs.gitlab.com/ee/gitlab-basics/). So if you know how to use Git to pull/push files from your local computer, then that is certainly an option for you.
|
|
|
|
|
|
Most users will probably find it easiest to edit the files directly here in GitLab.
|
|
|
|
|
|
**Let's begin:**
|
|
|
|
|
|
1. Go to the [Project Files](https://gitlab.com/imatt/equipd/i18n/tree/master).
|
|
|
|
|
|
2. Click on the folder name for the language you will translate. The folder names are based on the language codes listed above.
|
|
|
|
|
|
3. Click on a file name to translate, for example `strings.json`. The file will load.
|
|
|
|
|
|
4. On the top/right of the file contents is a series of buttons - you should see one labelled "Edit". Click this button.
|
|
|
> If you don't see the "Edit" button, then you likely missed the initial requirement to Request Access to the project (see [above section](#so-how-do-i-get-started)).
|
|
|
|
|
|
5. You can now edit the file right here in your browser. Note the tips on editing `.json` files below.
|
|
|
|
|
|
6. To save your work go to the bottom of the screen and:
|
|
|
1. In the "Commit Message" put in a short comment of what you worked on and how much progress you made etc. Your comment becomes viewable in the history of the file changes and makes it easier to go back in time and see what was done, by whom, and when.
|
|
|
2. Hit the "Commit Changes" button. This will save your changes and you are done!
|
|
|
|
|
|
The beauty of using GitLab is that I will be notified when changes are made, and I can easily see a full history of changes and manage the process.
|
|
|
|
|
|
|
|
|
### Any tips on how to edit the json file?
|
|
|
|
|
|
Definitely! Here is an example of what the json can look like:
|
|
|
|
|
|
```json
|
|
|
{
|
|
|
"section": {
|
|
|
"button": "Button Label",
|
|
|
"alert": "Thanks for your help %1$s.\n\nIt is much appreciated."
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
Some things to keep in mind:
|
|
|
|
|
|
* **Each line has two sections. The first one is the field name that must not be changed (eg `"button"`) and the second section is the string to translate (eg `"Button Label"`)**
|
|
|
|
|
|
* It is important that the structure retains the same - the parentheses `{` and `}`, the double-quotes `"`, and the commas `,` all need to be retained otherwise the file will break. Don't panic though! I can easily fix anything that gets broken.
|
|
|
|
|
|
* As a general guideline please try to keep the translated strings to either the **same string length** as the English version, **or shorter**. Buttons and labels on smaller devices only have a certain width, so we need to make sure the text fits.
|
|
|
|
|
|
* Please do not reorder any of the strings in the file. Each string is on the same line number across all languages.
|
|
|
|
|
|
* If you encounter strings like `%1$s` then please retain these in the sentence. This is a placeholder where a word gets inserted. In the example json shown above you can see where a persons name gets inserted for example - so it would become "Thanks for your help Matthew" where `%1$s` gets replaced with `Matthew`.
|
|
|
|
|
|
* If you encounter a `\n` then this is a “new line break” - please leave it in if possible.
|
|
|
|
|
|
* To view the original English strings again, for comparison, go into the [/en/strings.json](https://gitlab.com/imatt/equipd/i18n/blob/translators/en/master.json) file.
|
|
|
|
|
|
* Under the section "time" is a subsection called "format". These strings contain special codes that dictate how the date and time is formatted. You can see a list of all these [date and time formatting codes](https://gitlab.com/imatt/equipd/i18n/wikis/date-formats) here.
|
|
|
|
|
|
## Thank you
|
|
|
|
|
|
Thanks again for your help - I am sure users in your language will appreciate your efforts!
|
|
|
|
|
|
Any questions feel free to [email me](mailto:support@equipd.me), or **ideally create a new issue on the [Issue Tracker](https://gitlab.com/imatt/equipd/i18n/issues)** and then others can refer to them in the future.
|
|
|
|
|
|
Matthew |
|
|
\ No newline at end of file |