Mirrored_Repos/AppFlowy
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2024-08-30 18:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add translation guide doc

Browse Source
This commit is contained in:
Irfan Backer 2021-12-10 23:31:30 +05:30
parent d283d29202
commit b73f35b18c
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
doc/TRANSLATION.md Normal file
View File

@ -0,0 +1,29 @@
# TRANSLATION
You can help Appflowy in supporting various languages by contributing. Follow the steps below sequentially to contribute translations.
**NOTE: Translation files SHOULD be** `json` **files named in the format** `<lang_code>-<country_code>.json` **or just** `<lang_code>.json`**. eg:**`en.json`**,** `en-UK.json`
## Steps to add new language support
1. Add language key-value json file to `frontend/app_flowy/assets/translations/`. Refer `en.json` for format and keys.
2. Run `flutter pub run easy_localization:generate -S assets/translations/`.
3. Run `flutter pub run easy_localization:generate -f keys -o locale_keys.g.dart -S assets/translations`.
4. Add locale of the language (eg: `Locale('en', 'IN')`, `Locale('en')`) in `supportedLocales` list under `EasyLocalization` wrapper for flutter to support it.
This is located in `frontend/app_flowy/lib/startup/tasks/application_widget.dart` under `AppWidgetTask` class as shown below:
```dart
runApp(
EasyLocalization(
supportedLocales: const [ Locale('en') ], // <---- Add locale to this list
path: 'assets/translations',
fallbackLocale: const Locale('en'),
child: app),
);
```
## Steps to modify translations
1. Modify the specific translation file.
2. Run `flutter pub run easy_localization:generate -S assets/translations/`.
3. Run `flutter pub run easy_localization:generate -f keys -o locale_keys.g.dart -S assets/translations`.