github
/
nocodb
mirror of https://github.com/nocodb/nocodb
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

refactor : docs 

Signed-off-by: Naveen MR <oof1lab@gmail.com>
pull/1153/head
Naveen MR 3 years ago
parent
902a3afc76
commit
3939ef4487
1 changed files with 32 additions and 44 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 76
      packages/noco-docs/content/en/engineering/translation.md

76
packages/noco-docs/content/en/engineering/translation.md
Unescape View File

@ -1,66 +1,54 @@
--- ---
title: "Language support" title: "i18n"
description: "i18n: support for local/regional languages" description: "Contribute to NocoDB's i18n translation"
position: 2000 position: 2000
category: "Engineering" category: "Engineering"
menuTitle: "Localization: i18n" menuTitle: "i18n"
--- ---
NocoDB supports tool localization & relies on Google translation for first version. We understand, Google translation would not always provide correct transaltion for the context. We accept PR for subsequent corrections from Open source enthusiasts and contributors worldwide. Any such corrections over-ride Google translation & are recorded in Master i18n spreadsheet. NocoDB supports many foreign languages & we welcome community contributions via an easy to use [google-spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172).
Your help in fixing i18n goes a long way supporting NocoDB. Please follow below simple procedure to request corrections to existing translation errors.
> **Resource Links** ## How to contribute ? (for community members)
> [Master i18n spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172)
> [Google language code](https://developers.google.com/admin-sdk/directory/v1/languages)
## For Application User ### 1. How to change a string value ?
- Make a copy of [Google spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172)
<img width="995" alt="Screenshot 2022-02-10 at 1 47 06 PM" src="https://user-images.githubusercontent.com/86527202/153368423-d1d898ef-bdcb-48c4-a772-b75e2c66566d.png">
- Find your language code [here](https://developers.google.com/admin-sdk/directory/v1/languages)
- Go to the column containing your language code. Make necessary changes. Origin text in ENGLISH can be found in `Column B` of master spreadsheet.
- Create a new [issue in Github] with a link to publicly accessible change details (https://github.com/nocodb/nocodb/issues/new?assignees=dstala&labels=i18n+translation&template=i18n-translation-request.md&title=%5Bi18n%5D+Language+support+extension-+%3Clanguage+code%3E) request with a link to your spreadsheet from Step-1 (for us to verify & update master spreadsheet).
- NocoDB Maintainers will take changes and merge it.
### 1. Changing `existing language` translation text
Your help in identifying language translation anomalies & helping it fix helps in big way building/scaling NocoDB to next level. Please follow below simple procedure to request corrections to existing translation errors.
- Make a copy of [Google spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172)
<img width="995" alt="Screenshot 2022-02-10 at 1 47 06 PM" src="https://user-images.githubusercontent.com/86527202/153368423-d1d898ef-bdcb-48c4-a772-b75e2c66566d.png">
- Find your language code [here](https://developers.google.com/admin-sdk/directory/v1/languages) ### 2. How to add a new language ?
- Go to the column containing your language code derived above. Make changes as you find appropriate for various items listed. Origin text in ENGLISH can be found in `Column B` of master spreadsheet.
- Download spreadsheet as .csv (`File > Download > Comma-seperated values (.csv)`).
<img width="995" alt="Screenshot 2022-02-10 at 1 45 05 PM" src="https://user-images.githubusercontent.com/86527202/153368518-8e51ad7b-2577-4756-82f3-d9ad6683ad5e.png">
- Create new [issue](https://github.com/nocodb/nocodb/issues/new?assignees=dstala&labels=i18n+translation&template=i18n-translation-request.md&title=%5Bi18n%5D+Language+support+extension-+%3Clanguage+code%3E) request with a link to your spreadsheet from Step-1 (for us to verify & update master spreadsheet).
### 2. Requesting support for a `new language`
Your native language not in list, we will be glad to support with your help! Please follow below steps Your native language not in list, we will be glad to support with your help! Please follow below steps
- Make a copy of [Google spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172) - Make a copy of [Google spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172)
<img width="995" alt="Screenshot 2022-02-10 at 1 47 06 PM" src="https://user-images.githubusercontent.com/86527202/153368423-d1d898ef-bdcb-48c4-a772-b75e2c66566d.png"> <img width="995" alt="Screenshot 2022-02-10 at 1 47 06 PM" src="https://user-images.githubusercontent.com/86527202/153368423-d1d898ef-bdcb-48c4-a772-b75e2c66566d.png">
- Find your language code [here](https://developers.google.com/admin-sdk/directory/v1/languages)
- Find your language code [here](https://developers.google.com/admin-sdk/directory/v1/languages) - Replace cell $AB$1 (rightmost, containing text `en`) with language code obtained above.
- Replace cell $AB$1 (rightmost, containing text `en`) with language code obtained above. - Google will generate first version translation in column AB. Review. Make changes as you find appropriate for various items listed. Origin text in ENGLISH can be found in `Column B` of master spreadsheet.
- Google will generate first version translation in column AB. Review. Make changes as you find appropriate for various items listed. Origin text in ENGLISH can be found in `Column B` of master spreadsheet. - Create new [issue](https://github.com/nocodb/nocodb/issues/new?assignees=dstala&labels=i18n+translation&template=i18n-translation-request.md&title=%5Bi18n%5D+Language+support+extension-+%3Clanguage+code%3E) request with a link to your spreadsheet from Step-1 (for us to verify & update master spreadsheet).
- Download spreadsheet as .csv (`File > Download > Comma-seperated values (.csv)`).
<img width="995" alt="Screenshot 2022-02-10 at 1 45 05 PM" src="https://user-images.githubusercontent.com/86527202/153368518-8e51ad7b-2577-4756-82f3-d9ad6683ad5e.png">
- Create new [issue](https://github.com/nocodb/nocodb/issues/new?assignees=dstala&labels=i18n+translation&template=i18n-translation-request.md&title=%5Bi18n%5D+Language+support+extension-+%3Clanguage+code%3E) request with a link to your spreadsheet from Step-1 (for us to verify & update master spreadsheet).
--- ---
## For NocoDB Moderators ## How to accept i18n contributions ? (for NocoDB maintainers)
> **_This is exclusive to NocoDB team members/ moderators only_**
### 1. Adding/ updating KEY.STRING
- Open master [Spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172) > _This is exclusive to NocoDB maintainers only_
- For the string/ text under consideration, look-up in existing sheet if it exists already
- [New string already exists] Consider re-using it; align string key if required
- [New string need to be inserted] Insert a new record into appropriate categories as defined below
- Download spreadsheet as .csv (File > Download > Comma-seperated values (.csv, current sheet)
- Use noco-i18n-from-cli to generate new language JSON file
- Copy respective i18n/\*.json files to `nocodb/packages/nc-gui/lang`
### 2. String KEY Categories ### 1. Adding / Updating a string
- Open master [Spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172)
- For the string/ text under consideration, look-up in existing sheet if it exists already
- [New string already exists] Consider re-using it; align string key if required
- [New string need to be inserted] Insert a new record into appropriate categories as defined below
- Download spreadsheet as .csv (File > Download > Comma-seperated values (.csv, current sheet)
- Use noco-i18n-from-cli to generate new language JSON file
- Copy respective i18n/\*.json files to `nocodb/packages/nc-gui/lang`
### 2. String Categories
- **General**: simple & common tokens (save, cancel, submit, open, close, home, and such) - **General**: simple & common tokens (save, cancel, submit, open, close, home, and such)
- **Objects**: objects from NocoDB POV (project, table, field, column, view, page, and such) - **Objects**: objects from NocoDB POV (project, table, field, column, view, page, and such)
- **Title**: screen headers (compact) (menu headers, modal headers) - **Title**: screen headers (compact) (menu headers, modal headers)
@ -73,4 +61,4 @@ Your native language not in list, we will be glad to support with your help! Ple
- Error: warnings & errors - Error: warnings & errors
- Toast: pop-up toast messages - Toast: pop-up toast messages
> Note: Mark String KEY name in `camelCase`. Use above list as priority order in case of ambiguity. > Note: string name should be in camelCase. Use above list as priority order in case of ambiguity.

Write Preview
Loading…
Cancel
Save