Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed jp-JP, ko-KO, sv-SV. #24

Merged
merged 1 commit into from
Mar 29, 2021
+242 −45
Merged

Renamed jp-JP, ko-KO, sv-SV. #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
287 changes: 242 additions & 45 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@
# learnosity-i18n
This repository contains Learnosity internationalization language bundles. You can see these bundles in action in our [internationalization demo](https://demos.learnosity.com/assessment/activities-i18n.php).
This repository contains Learnosity internationalization language bundles originally put together as POC for customers to see how the APIs can be translated. You can see these bundles in action in our [internationalization demo](https://demos.learnosity.com/assessment/activities-i18n.php).

Please refer to this [knowledge base article](https://help.learnosity.com/hc/en-us/articles/360002918818-Translating-the-Learnosity-user-interface-with-label-bundles) for more information about translating the Learnosity user interface.

## Translations
If you would like to translate our APIs into another language, please make a pull request by adding `languages/label_bundles/<language>/<api>.json`.
Each file in this repository corresponds to the RFC-5646 locale code for each language. This contains the language and region separated by a dash, e.g. en-US, de-DE, or ar-EG.

The default language in all Learnosity APIs is en-US.

## Purpose
The purpose of these files is to show how the Learnosity Authoring, Assessment, and Reporting APIs can be translated or adjusted to suit individual needs. These are **not officially supported** by Learnosity but can serve as a solid base for any customer interested to translate the user interface.

### What label bundles cover

Our label bundles translate user-interface elements, such as buttons, dialogs, and labels. This means that customers will need to translate their question content (eg the question stems), this gives you the flexibility to pick and choose which UI elements to localize. For example, you might typically localize a student's assessment player (assess-api.json, and possibly portions of questions-api.json, depending on what they want to use). But you may only have to add translations for the specific reports you intend to use if any (reports-api.json).


## Custom translations
If you would like to translate our APIs into another language, please make a pull request by adding `languages/label_bundles/<language>-<region>/<api>.json`.

For example:

Expand All @@ -16,22 +28,155 @@ For example:
├── README.md
```

## Note: not comprehensive
Please note that most of these translations are a partial translation for demonstration purposes only, to show an example of translation in the [internationalization demo](https://demos.learnosity.com/assessment/activities-i18n.php). Most of these do not provide a full translation of the English text in the product.
## Structure
Each language contains 4 _possible_ folders:

* author_assets
* label_bundles
* qe\_custom\_types
* qe\_template\_thumbnails

### author_assets
The Author API has an image that contains an English string. This is used when the item list is empty (either no items exist, or the search returned no results). See pt-PT for a sample of how this can be used to replace the default image.

### label_bundles
This is the main folder containing a JSON file for each of the APIs that support translations:

* assess-api.json
* author-api.json
* questioneditor-api.json
* questions-api.json
* reports-api.json

#### Sample initialization
##### Assessment
To override labels for the Items API (Learnosity's primary assessment API) you can use the following initialization object, note there are 2 locations to pass translations:

1. the assessment player (*assess-api.json*) in `config.labelBundle`
2. individual question types (*questions-api.json*) in `config.questions_api_init_options.labelBundle`:

```
{
"activity_id": "[YOUR-ACTIVITY-ID]",
"name": "[YOUR-ASSESSMENT-NAME]",
"rendering_type": "assess",
"type": "submit_practice",
"session_id": "[YOUR-SESSION-ID]",
"user_id": "[YOUR-ASSESSMENT-USER]",
"config": {
"labelBundle": {
},
"questions_api_init_options": {
"labelBundle": {
}
}
}
}
```

##### Authoring
To override labels for the Author API (Learnosity's primary authoring API) you can use the following initialization object, note there are 3 locations to pass translations:

1. the authoring wrapper (*author-api.json*) in `config.label_bundle`
2. the question editing layer (*questioneditor-api.json*) in `config.dependencies.question_editor_api.init_options.label_bundle`
3. where question types are rendered in `config.dependencies.questions_api.init_options.labelBundle`

**Note:** that there is a discrepancy between the Assessment and Authoring APIs around the format of the label bundle attribute. Assessment uses `labelBundle` while Authoring uses `label_bundle`. This is due to a later decision in Authoring to standardize using snake_case.


```
{
"mode": "item_list",
"config": {
"label_bundle": {
},
"dependencies": {
"question_editor_api": {
"init_options": {
"group_defaults": true,
"question_type_groups": [
],
"question_type_templates": {
},
"label_bundle": {
}
}
},
"questions_api": {
"init_options": {
"labelBundle": {
}
}
}
}
},
"user": {
"id": "demos-site",
"firstname": "demos",
"lastname": "User"
}
}
```


##### Reporting
To override labels for the Reports API you can use the following initialization object:

```
{
"reports": [
],
"label_bundle": {
}
}
```

### qe\_custom\_types
This folder can contain 2 files for Question Editor API custom [groups](https://help.learnosity.com/hc/en-us/articles/360000755178-Customizing-the-Tile-View-With-Author-API) and [templates](https://help.learnosity.com/hc/en-us/articles/360000758097-Customizing-Question-Attributes-and-Templates):

* question\_type\_groups.json
* question\_type\_templates.json

Question Type Groups can be used to localize the categories of question types available to authors in the left-hand sidebar.

Question Type Templates define the collection of JSON attributes shown (along with localized default values) to authors when editing a question type.

**Language Codes:**
We use language codes to support dialects within each top level language. English (United States) is the default language used in our APIs.

**Supported Language List:**
### qe\_template\_thumbnails
When creating questions, authors can select which question type template they want to use. This UI displays a series of thumbnail images that preview a sample of how the question type will render, allowing authors to make the right decision.

Ideally, these static images would be refreshed with new (translated) content. This is a location you can choose to store these thumbnails.

## Language List
The following table summarizes the language files available to try:

<table>
<thead>
<tr>
<th width="320">Language</th>
<th width="130">Code</th>
<th width="130">Assess API</th>
<th width="130">Author API</th>
<th width="130">Question Editor API</th>
<th width="130">Questions API</th>
<th colspan="2">&nbsp;</th>
<th colspan="2">Authoring</th>
<th colspan="2">Assessment</th>
<th>Reporting</th>
</tr>
<tr>
<th>Language</th>
<th width="60">Code</th>
<th>Author API</th>
<th>Question Editor API</th>
<th>Assess API</th>
<th>Questions API</th>
<th>Reports API</th>
</tr>
</thead>
<tbody>
Expand All @@ -42,61 +187,96 @@ We use language codes to support dialects within each top level language. Englis
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>N</td>
</tr>
<tr>
<td>Chinese (Simplified)</td>
<td>zh-CN</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Dutch (Netherlands)</td>
<td>nl-NL</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>English (United Kingdom)</td>
<td>en-GB</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>N</td>
</tr>
<tr>
<td>English (United States) - Default</td>
<td>English (United States) - <em>Default</em></td>
<td>en-US</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>French</td>
<td>fr-FR</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>German</td>
<td>de-DE</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Hindi</td>
<td>hi-IN</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Italian</td>
<td>it-IT</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Japanese</td>
<td>jp-JP</td>
<td>N</td>
<td>N</td>
<td>N</td>
<td>ja-JP</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Korean</td>
<td>ko-KR</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
Expand All @@ -106,40 +286,57 @@ We use language codes to support dialects within each top level language. Englis
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Russian</td>
<td>ru-RU</td>
<td>Y (Full, 210 labels)</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y (partial)</td>
<td>N</td>
<td>Y (MVP, 13 labels)</td>
</tr>
<tr>
<td>Spanish</td>
<td>es-ES</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Swedish</td>
<td>sv-SE</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Tagalog</td>
<td>tl-PH</td>
<td>Y</td>
<td>N</td>
<td>N</td>
<td>N</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
<tr>
<td>Vietnamese</td>
<td>vi-VN</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
<td>Y</td>
</tr>
</tbody>
</table>

For the Code column, the first lower-case two-letter codes is a valid ISO Language Code. These codes are defined by ISO-639. When picking your language code, please use the correct code from the 639-1 column [here](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). The upper-case two-letter codes is a valid ISO Country Code. These codes are defined by ISO-3166. When picking your country code, please use the correct code from the Alpha-2 code column [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
For the Code column, the first lower-case two-letter code is a valid ISO Language Code. These codes are defined by ISO-639. When picking your language code, please use the correct code from the 639-1 column [here](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). The upper-case two-letter code is a valid ISO Country Code. These codes are defined by ISO-3166. When picking your country code, please use the correct code from the Alpha-2 code column [here](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## Upcoming
Add support for:
* Portuguese (Reports API)
* Spanish
0 ...uages/jp-JP/label_bundles/assess-api.json → ...uages/ja-JP/label_bundles/assess-api.json
View file
Open in desktop
File renamed without changes.
0 ...uages/jp-JP/label_bundles/author-api.json → ...uages/ja-JP/label_bundles/author-api.json
View file
Open in desktop
File renamed without changes.
0 ...-JP/label_bundles/questioneditor-api.json → ...-JP/label_bundles/questioneditor-api.json
View file
Open in desktop
File renamed without changes.
0 ...es/jp-JP/label_bundles/questions-api.json → ...es/ja-JP/label_bundles/questions-api.json
View file
Open in desktop
File renamed without changes.
0 ...ages/jp-JP/label_bundles/reports-api.json → ...ages/ja-JP/label_bundles/reports-api.json
View file
Open in desktop
File renamed without changes.
0 languages/jp-JP/qe_custom_types/.gitkeep → languages/ja-JP/qe_custom_types/.gitkeep
View file
Open in desktop
File renamed without changes.
0 ...ges/jp-JP/qe_template_thumbnails/.gitkeep → ...ges/ja-JP/qe_template_thumbnails/.gitkeep
View file
Open in desktop
File renamed without changes.
Binary file removed languages/jp-JP/.DS_Store
View file
Open in desktop
Binary file not shown.
0 languages/ko-KO/author_assets/.gitkeep → languages/ko-KR/author_assets/.gitkeep
View file
Open in desktop
File renamed without changes.
0 ...uages/ko-KO/label_bundles/assess-api.json → ...uages/ko-KR/label_bundles/assess-api.json
View file
Open in desktop
File renamed without changes.
0 ...uages/ko-KO/label_bundles/author-api.json → ...uages/ko-KR/label_bundles/author-api.json
View file
Open in desktop
File renamed without changes.
0 ...-KO/label_bundles/questioneditor-api.json → ...-KR/label_bundles/questioneditor-api.json
View file
Open in desktop
File renamed without changes.
0 ...es/ko-KO/label_bundles/questions-api.json → ...es/ko-KR/label_bundles/questions-api.json
View file
Open in desktop
File renamed without changes.
0 ...ages/ko-KO/label_bundles/reports-api.json → ...ages/ko-KR/label_bundles/reports-api.json
View file
Open in desktop
File renamed without changes.
0 languages/ko-KO/qe_custom_types/.gitkeep → languages/ko-KR/qe_custom_types/.gitkeep
View file
Open in desktop
File renamed without changes.
0 ...ges/ko-KO/qe_template_thumbnails/.gitkeep → ...ges/ko-KR/qe_template_thumbnails/.gitkeep
View file
Open in desktop
File renamed without changes.
0 languages/sv-SV/author_assets/.gitkeep → languages/sv-SE/author_assets/.gitkeep
View file
Open in desktop
File renamed without changes.
0 ...uages/sv-SV/label_bundles/assess-api.json → ...uages/sv-SE/label_bundles/assess-api.json
View file
Open in desktop
File renamed without changes.
0 ...uages/sv-SV/label_bundles/author-api.json → ...uages/sv-SE/label_bundles/author-api.json
View file
Open in desktop
File renamed without changes.
0 ...-SV/label_bundles/questioneditor-api.json → ...-SE/label_bundles/questioneditor-api.json
View file
Open in desktop
File renamed without changes.
0 ...es/sv-SV/label_bundles/questions-api.json → ...es/sv-SE/label_bundles/questions-api.json
View file
Open in desktop
File renamed without changes.
0 ...ages/sv-SV/label_bundles/reports-api.json → ...ages/sv-SE/label_bundles/reports-api.json
View file
Open in desktop
File renamed without changes.
0 languages/sv-SV/qe_custom_types/.gitkeep → languages/sv-SE/qe_custom_types/.gitkeep
View file
Open in desktop
File renamed without changes.
0 ...ges/sv-SV/qe_template_thumbnails/.gitkeep → ...ges/sv-SE/qe_template_thumbnails/.gitkeep
View file
Open in desktop
File renamed without changes.