kiwix/kiwix-android
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-android.git synced 2025-08-03 02:36:24 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merged STRING_RESOURCES.md with README.md

Browse Source
This commit is contained in:
MohitMaliFtechiz 2023-05-08 18:52:41 +05:30 committed by Emmanuel Engelhart
parent 005c134e78
commit 4306491ae7
No known key found for this signature in database
GPG Key ID: 120B30D020B553D3
3 changed files with 24 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -58,10 +58,6 @@ If you wish to rebase you should be following the [Golden Rule](https://www.atla
For an overview of how to make design changes to Kiwix Android, check out [DESIGN.md](https://github.com/kiwix/kiwix-android/blob/develop/DESIGN.md).
### Adding new string resources
To add a new string resource see [STRING_RESOURCES.md](https://github.com/kiwix/kiwix-android/blob/develop/STRING_RESOURCES.md).
### Building
The Kiwix app is split into 3 modules

25
README.md
View File

@ -77,7 +77,30 @@ guidelines. Pull requests not matching the style will be rejected.
Kiwix Android is available in multiple languages and managed by Translatewiki.
When adding new string resources, contributors are required to provide additional context on how and where the new string will be used.
This helps translators to understand the context and translate accurately.
Before adding new string resources, please read the [STRING_RESOURCES](https://github.com/kiwix/kiwix-android/blob/develop/STRING_RESOURCES.md) carefully.
### String resources
All user visible strings in an Android application should be listed in strings.xml files to allow for easy translation, replacement and modification.
Newly added string resources are imported by translatewiki and are then manually translated.
After translations are complete the translations are merged with Kiwix Android.
#### How do I add a new string resource?
Start by adding your new string resource `new_string` to `values/strings.xml` in English. That is:
```
...
<string name="new_string">New String</string>
...
```
You will now have to describe the string in `values-qq/strings.xml` with where and how the new string is used. E.x. for the string `<string name="on">On</string>`:
`values-qq/strings.xml:`
```
...
<string name="on">This is used in the settings screen to turn on the night mode.</string>
...
```
- The values in `values/strings.xml` are the strings that are going to be displayed in the Kiwix application to the user.
- The values in `values-qq/strings.xml` are only visible to the translator and are only there to help them make a correct translation.
## Communication

20
STRING_RESOURCES.md
View File

@ -1,20 +0,0 @@
# String resources
All user visible strings in an Android application should be listed in strings.xml files to allow for easy translation, replacement and modification. Newly added string resources are imported by translatewiki and are then manually translated. After translations are complete the translations are merged with Kiwix Android.
## How do I add a new string resource?
Start by adding your new string resource `new_string` to `values/strings.xml` in English. That is:
```
...
<string name="new_string">New String</string>
...
```
You will now have to describe the string in `values-qq/strings.xml` with where and how the new string is used. E.x. for the string `<string name="on">On</string>`:
`values-qq/strings.xml:`
```
...
<string name="on">This is used in the settings screen to turn on the night mode.</string>
...
```
- The values in `values/strings.xml` are the strings that are going to be displayed in the Kiwix application to the user.
- The values in `values-qq/strings.xml` are only visible to the translator and are only there to help them make a correct translation.