Skip to content

TRANSLATING.md

Latest commit

 

History

History
59 lines (45 loc) · 2 KB

TRANSLATING.md

File metadata and controls

59 lines (45 loc) · 2 KB

Translating for Flock XR

How to Contribute

  1. Add the required import statements to "translation.js", replacing "es" which the code for the language being added:
import * as es esom "blockly/msg/es";
import esLocale esom "../locale/es.js"
  1. Add the language to "translations":
  es: esLocale,
  1. Extend the "applySavedLanguageTranslations" function:
  else if (currentLanguage === "es") {
    // Apply Blockly's LANGUAGE translations
    const esMessages = es.default || es;
    Object.keys(esMessages).forEach((key) => {
      if (typeof esMessages[key] === "string") {
        Blockly.Msg[key] = esMessages[key];
      }
    });
  }
  1. Modify the "setLanguage" function:
  else if (language === "es") {
    // Apply Blockly's LANGUAGE translations
    Object.keys(es).forEach((key) => {
      if (typeof es[key] === "string") {
        Blockly.Msg[key] = es[key];
      }
    });
    console.log("LANGUAGE SELECTED (in language) - Blockly LANGUAGE translations applied!");
  }

  1. Copy the "en.js" file in the "locale" directory and translate each message. Leave the keywords in English. This can be done either by a native speaker, or using AI, provided the translations are checked by a native speaker.

  2. Add the language option to "index.html"

  <li><a href="#" data-lang="es" role="menuitem" tabindex="-1">Español</a></li>

Configuring new text to use the translation system

  1. Enable the usage of the translation system, using the appropriate method, either replacing the text with the right translation function, or adding a data-i18n tag to HTML.

  2. Add the English versions to "en.js", remembering to add the right suffix to the key.

  3. Use AI to translate them into other languages, and add the translations to the other locale files.

  4. Create an issue on GitHub tagged with translation, and include in the description a request that people create sub-issues when they start translating/checking the new strings into a language.