crowdin.yml

#
# Your Crowdin credentials: ID and token are provided through GitHub Action secrets.
#
"project_id_env" : "CROWDIN_PROJECT_ID"
"api_token_env" : "CROWDIN_PERSONAL_TOKEN"
"base_path" : "."
"base_url" : "https://api.crowdin.com"

#
# Choose file structure in Crowdin
# e.g. true or false
#
"preserve_hierarchy": true

#
# Files configuration
#
files: [
 {
  #
  # Source files filter
  # e.g. "/resources/en/*.json"
  #
  "source" : "/catroid/src/main/res/values/strings.xml",

  #
  # Where translations will be placed
  # e.g. "/resources/%two_letters_code%/%original_file_name%"
  #
  "translation" : "/catroid/src/main/res/values-%android_code%/strings.xml",

  #
  # Files or directories for ignore
  # e.g. ["/**/?.txt", "/**/[0-9].txt", "/**/*\?*.txt"]
  #
  #"ignore" : [],

  #
  # The dest allows you to specify a file name in Crowdin
  # e.g. "/messages.json"
  #
  "dest" : "/catroid/src/main/res/values/strings.xml",

  #
  # File type
  # e.g. "json"
  #
  "type" : "xml",

  #
  # The parameter "update_option" is optional. If it is not set, after the files update the translations for changed
  # strings will be removed. Use to fix typos and for minor changes in the source strings
  # e.g. "update_as_unapproved" or "update_without_changes"
  #
  "update_option" : "update_as_unapproved",

  #
  # Start block (for XML only)
  #

  #
  # Defines whether to translate tags attributes.
  # e.g. 0 or 1  (Default is 1)
  #
   "translate_attributes" : 0,

  #
  # Defines whether to translate texts placed inside the tags.
  # e.g. 0 or 1 (Default is 1)
  #
   "translate_content" : 1,

  #
  # This is an array of strings, where each item is the XPaths to DOM element that should be imported
  # e.g. ["/content/text", "/content/text[@value]"]
  #
  # "translatable_elements" : [],

  #
  # Defines whether to split long texts into smaller text segments
  # e.g. 0 or 1 (Default is 1)
  #
  # "content_segmentation" : 1,

  #
  # End block (for XML only)
  #

  #
  # Start .properties block
  #

  #
  # Defines whether single quote should be escaped by another single quote or backslash in exported translations
  # e.g. 0 or 1 or 2 or 3 (Default is 3)
  # 0 - do not escape single quote;
  # 1 - escape single quote by another single quote;
  # 2 - escape single quote by backslash;
  # 3 - escape single quote by another single quote only in strings containing variables ( {0} ).
  #
  # "escape_quotes" : 3,

  #
  # Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.
  # e.g. 0 or 1 (Default is 0)
  # 0 - do not escape special characters
  # 1 - escape special characters by a backslash
  #
  # "escape_special_characters": 0
  #

  #
  # End .properties block
  #

  #
  # Often software projects have custom names for the directories where translations are placed. crowdin-cli allows you
  # to map your own languages to be understandable by Crowdin.
  #
  "languages_mapping" : {
    "android_code" : {
          "af" : "af",
          "ar" : "ar",
          "az" : "az",
          "bg" : "bg",
          "bn" : "bn",
          "bs" : "bs",
          "ca" : "ca",
          "chr" : "chr",
          "cs" : "cs",
          "da" : "da",
          "de" : "de",
          "el" : "el",
          "es-ES": "es",
          "fa-AF": "fa",
          "fi": "fi",
          "fr": "fr",
          "gl": "gl",
          "gu-IN": "gu",
          "ha": "ha",
          "hi": "hi",
          "hr": "hr",
          "hu": "hu",
          "ig": "ig",
          "id": "in",
          "it": "it",
          "he": "iw",
          "ja": "ja",
          "kab": "kab",
          "ka": "ka",
          "kk": "kk",
          "kn": "kn",
          "ko": "ko",
          "lt": "lt",
          "mk": "mk",
          "ml": "ml",
          "ms": "ms",
          "nl": "nl",
          "no": "no",
          "pl": "pl",
          "ps": "ps",
          "pt-PT": "pt",
          "ro": "ro",
          "ru": "ru",
          "sd": "sd",
          "si-LK": "si",
          "sk": "sk",
          "sl": "sl",
          "sq": "sq",
          "sv-SE": "sv",
          "sw": "sw",
          "ta": "ta",
          "te": "te",
          "th": "th",
          "tl": "tl",
          "tr": "tr",
          "tw": "tw",
          "uk": "uk",
          "ur-PK": "ur",
          "uz": "uz",
          "vi": "vi",
     }
  },

  #
  # Does the first line contain header?
  # e.g. true or false
  #
  #"first_line_contains_header" : true,

  #
  # for spreadsheets
  # e.g. "identifier,source_phrase,context,uk,ru,fr"
  #
  # "scheme" : "",
 }
]