Skip to content

Latest commit

 

History

History
159 lines (87 loc) · 7.97 KB

LOCALIZE.md

File metadata and controls

159 lines (87 loc) · 7.97 KB
Raw

How to Localize the Software

Currently Supported Languages

See INSTALL.md

Adding Support for a New Language

See https://github.com/elimu-ai/wiki/blob/main/LOCALIZATION.md

Adding Educational Content

The examples below use the Xhosa language as an example. If you will adding content using another language, simply replace xho in the URL with your language of choice.

Adding Audio Recordings 🎶🎙️

Follow these steps to add a new audio file to the webapp's database:

  1. Go to https://xho.elimu.ai/content/multimedia/audio/list

  2. Press the "Add audio" button.

  3. If the audio recording is a word, the title should match the transcription:

  4. However, if the audio recording is longer than a single word (e.g. a storybook paragraph), the title should be something other than the transcription:

  5. If you copied the audio file from somewhere, make sure to include the license used on the website where you downloaded the file, as well as a link to the website. If, however, you recorded the audio file yourself, you can select which license to use. We recommend using Creative Commons CC BY:

  6. Remove silence before/after the audio, if any. This is to make sure that a child does not experience any delays while interacting with the software. We recommend using Audacity for editing audio recordings:

  7. Then select the audio file, and press the "Add" button. If you want to provide any additional details about your contribution, you can do so in the "Comment" field:

Adding Audio Recording via Another Page

Note that there are two other ways you can add audio recordings: 1) via the word edit page, and 2) via the storybook paragraph edit page:

Via the word edit page

  1. At https://xho.elimu.ai/content/word/list you can find a list of words. While editing a word, you will see a warning saying "This word has no corresponding audio." if an audio recording with a matching transcription does not already exist:

  2. Then, if you press the "Add audio" link, you will be redirected to the page for uploading an audio file, and the title and the transcription of the audio will be auto-filled:

Via the storybook paragraph edit page

  1. While editing a storybook paragrah, you'll find an "Add audio" link at the bottom:

  2. If you press the "Add audio" link, you will be redirected to the page for uploading an audio file, and the title and the transcription of the audio will be auto-filled to match the content of the paragraph:

  3. If you add an audio recording this way, remember to go back to the paragraph edit page after uploading the audio file, and select the corresponding audio in the drop-down:

Adding Words

Follow these steps to add a new word to the webapp's database:

  1. Go to https://xho.elimu.ai/content/word/list

  2. Press the "Add word" button:

  3. Type the word's text:

  4. Select the word's letter-sound correspondences:

    If the letter-sound correspondence you want to use does not exist in the drop-down, press the "Add letter-sound correspondence" link. Then select the sound corresponding to the letter(s):

  5. Select the Spelling consistency, according to how well the letters match the sounds. If you are unsure about this step, leave it unselected.

  6. Select the word type (adjective, adverb, noun, etc) if it exists in the drop-down. Then press the "Add" button:

Adding Word via Another Page

One strategy is to add words used in a particular storybook:

  1. Go to https://xho.elimu.ai/content/storybook/list and open a storybook that you want to add words for.

  2. In the sidebar you'll see a word frequency list:

  3. Then, press the "Add word" link if you want to create it.

  4. You will then be redirected for the page for adding a word, with the word's text auto-filled:

  5. Then, proceed as described above in "Adding Words".

Another strategy for adding words is to go to the "Words Pending" page, where you can find a list of the most used words across all storybooks:

  1. Go to https://xho.elimu.ai/content/word/pending

  2. Here you can also choose the word to add by pressing the "Add word" link, which will redirect you to the page for adding a new word (with its text auto-filled):

  3. Then, proceed as described above in "Adding Words".

elimu.ai - Free open-source learning software for out-of-school children ✨🚀

Website 🌐  •  Wiki 📃  •  Projects 👩🏽‍💻  •  Milestones 🎯  •  Community 👋🏽  •  Support 💜