"* 必需项"
"~ 推荐项"
"? 未使用"

/**
 * JSON 格式
 * 实际调整可参考内置的 APIs
 */
{
  *"id": "google", // 翻译源 ID，不可重复，创建后不建议修改
  ~"name": "Google", // 翻译源的名称，字符随意，例如： "网易·有道"
  ?"icon": "", // base64 图片数据，当前未在程序中使用

  // 翻译源地址，主要用于提供变量，不用的话可省略
  ~"host": "https://translate.google.com",

  // 定义一些响应内容的设置
  ~"response": {
    ~"type": "json" // or "text", response data type
  },

  // 查询对象
  *"query": {
    // 文本翻译的请求
    *"text": {
      ~"method": "GET", // 请求方式，GET 或者 POST，默认为 GET

      // 如果 "method" 为 POST, 可以自定义一个常规的"请求头"
      // @see https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers
      // 请求头必须是一个对象字面量
      // 留空默认: { 'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8' }
      ~"header": {},

      // 请求地址，变量 {{host}} 获取 "host": "https://translate.google.com"
      // 如果 "method" 为 GET 的话，可以只提供查询地址 "url": "url?[,param]"
      *"url": "{{host}}/translate_a/single",

      // 查询参数，"method" 为 GET 的话支持字符串形式 "q={{q}}&from={{from}}&..."
      // 此外只支持二位数组，[,[key, value]]
      ~*"params": [
        ["q", "{{q}}"], // {{q}} 获取需要翻译的文本
        ["sl", "{{from}}"], // {{from}} 为源语言的 code
        ["tl", "{{to}}"], // {{to}} 为目标语言的 code

        // 如果存在多条键名相同，可使用数组作为 "value"
        ["test", ["foo", "bar"]],

        // 无限制数量，不过尽量只添加需要的参数
        ["other", "param"]
      ]
    },

    // 发音的请求，不必使用同一翻译源的发音服务，可以搭配其它服务源的
    ~"audio": {
      ?"method": "GET", // 默认 GET，当前未支持 POST
      ?"header": {}, // 当前未支持

      // 发音请求地址
      *"url": "{{host}}/translate_tts",

      // 与文本翻译部分类似
      ~*"params": [
        ["q", "{{q}}"], // 获取发音文本

        // 获取发音源语言，根据服务源的情况可能不稳定，
        // 可以不使用变量来固定某一语言的发音
        ["tl", "{{from}}"]
      ]
    }
  },

  // 翻译结果解析，实例以 google translate api 为例
  // 为了避免安全审核问题，现在采用的是占位字符来解析获取对应结果
  // 当前版本只有演示的四个关键字可用
  *"parser": {
    // 这里返回的 json 结果中 'sentences' 是一个对象数组，需要
    // 内容 'trans' 在对象内部，通过圆括号来索引所有数组元素中对象属性
    *"translation": "sentences(trans)",

    // '$' 为索引 'sentences' 这个数组的倒数第一个元素
    // 类似的，通过 '$$' 两个 $ 来索引倒数第二个，以此类推
    // 当然可以这样 'sentences.0.translit' 数字索引正常顺序的元素
    ~"phonetic_src": "sentences.$.src_translit", // 源音标
    ~"phonetic_dest": "sentences.$.translit", // 目标音标

    // 这里的 `(pos, terms)` 类似于 'translation'，但是它可以获取更多
    // 的键值，可以使用任何 "." 点字符以外符号替代 ", " 来作为结果的分隔符
    // 例如：" " 空格、"&"、"/"，"////" 四个正斜杠可以作为 "\n" 换行符
    ~"explain": "dict(pos, terms)"
    ~?"explain": "dict(,)" // 可以只使用符号
    ~"explain": "dict.foobar(pos.0.foo, terms.1.bar)" // 支持用点操作符深度索引
  }

  // [源语言, 目标语言]
  // 此项可选，但非常建议使用，如果未提供此项的话，默认两者都是语言列表的首个
  ~*"fromto": ["en", "zh-cn"],
  
  // @see `[repo]/src/api/languages.json` 这里是默认支持的语言列表
  // "include" 用于只包含一些语言，建议使用，因为默认载入所有的语言会造成轻微的启动迟缓
  ~*"include": ["en", "zh-cn", "ja"], // 数组形式，推荐使用
  // also
  ~"include": "en/zh-cn/ja", // 字符串形式，使用 '/' 来分隔

  // 通常各个翻译源的语言码并不统一，需要对应修改，比如 'ja' -> 'jp'
  // 使用 `:>` 字符来在编译时对应修改成正确的语言码
  ~*"include": ["en", "zh-cn:>zh-CHS", "ja:>jp"],
  ~"include": "en/zh-cn:>zh-CHS/ja:>jp",

  // 使用方法和 "include" 类似，如果使用此项将忽略 "include" 的配置内容
  ~"exclude": ["fr", "zh"],

  // 如果默认的语言列表未包含所需语言，或者想要自定义语言列表（使用 "include": [] 来屏蔽所有默认语言)
  // 可以用下面的形式来定制
  // 提示：如果定制语言，无需再额外将它们的语言码添加到 "include" 中
  ~"languages": [{
    *"code": "zh", // 语言码
    *"name": "Chinese", // 语言名称
    ~*"locale": "中文" // 语言名称翻译
  }, {
    *"code": "jp",
    *"name": "Japanese",
    ~*"locale": "日文"
  }]
}

// 使用数组来定义继承配置，数组的最后一个对象元素为新的配置，它们会被深度
// 覆盖到前面的父级配置中
[
  // 父级 API 的 ID
  *"google",
  {
    *"id": "google_cn", // 新配置的 ID，不可与其它配置相同

    // 需要覆盖的项
    ~"url": "https://translate.google.cn",
    ~"include": ["en", "ja:>jp"]
    // 更多
  }
]