Skip to content

配置覆写和定制

定制很好理解,薄荷输入法基于Rime输入法框架,实际就是一套Rime输入法配置;不同的Rime客户端都有大量的个性化配置,虽然薄荷输入法已经进行了大量的设置,但是还有很多配置并没有激活;用户可以根据自己的喜好进行配置

至于覆写,就是薄荷输入法已经对Rime输入法的客户端进行了配置,但是可能不符合你的喜好,那么你可以对其进行覆写

Rime的个性配置文件

Rime的配置总体分为两种:

  • 输入法的应用配置: 一般是设置客户端的外观,每个客户端可能有所不一样。比如: macOS(鼠须管) 和 Windows(小狼毫) 上设置输入法的外观和纵向输入等。
  • 输入法方案配置: 设置输入法的方案内部的配置;比如: 设置在半角的情况下输入句号的形式、输入法翻页快捷键等。

一般来讲,如果是想自定义外观展示的,那么就设置「输入法的应用配置」,macOS上就是squirrel.yamlsquirrel.custom.yaml;而Windows上就是weasel.yamlweasel.custom.yaml

如果想覆写输入的内容和方式,那么就是设置「输入法方案配置」,这个又分为「全局输入设置(default)」和「输入方案设置(scheme)」;同样,作为设置也有带custom的自定义文件和不带custom的schema文件

为什么都有带custom不带custom的两种呢?

其实,不带custom的是配置的定制,用于实现配置带custom的则是配置的覆写,用于覆写不带custom的某些配置;其他内容继承不带custom配置

输入法的应用配置

首先,我们看看应用的配置。方便我们把输入法的外观进行修改。

以薄荷输入法为例,我们已经安装了薄荷输入法,如果在macOS上,可以打开squirrel.yaml这个文件。薄荷输入法已经基于官方的配置: 鼠须管源码内的配置

如果你的项目里没有squirrel.yaml这个文件,那么就会使用官方的配置。同理,如果你在Windows上,没有weasel.yaml这个文件,那么就是使用: 小狼毫源码内的配置

内容参考(squirrel.yaml文件节选参考):

yaml
style:
  # 选择皮肤,亮色与暗色主题
  color_scheme: mint_light_blue
  color_scheme_dark: mint_dark_blue
  
  # 预设选项。如果皮肤没写,则使用这些属性;如果皮肤写了,使用皮肤的。
  text_orientation: horizontal  # horizontal | vertical
  andidate_list_layout: stacked # stacked | linear  候选项排列方向(如果你想调整为横屏,可以调整这个)
  
  # 内嵌预编辑
  inline_preedit: true
  # 选中框 圆角半径
  hilited_corner_radius: 0
  # 窗口边界高度,大于圆角半径才生效
  border_height: 0
  # 窗口边界宽度,大于圆角半径才生效
  border_width: 0
  # 外边框 圆角半径
  corner_radius: 10
  # 色彩空间: srgb | display_p3
  color_space: srgb
  line_spacing: 5
  spacing: 10
  #candidate_format: '%c. %@'
  #base_offset: 6
  # 全局字体及大小
  font_face: "PingFang SC"
  font_point: 16
  # 序号字体及大小
  label_font_face: "PingFang SC"
  label_font_point: 16
  # 注字体及大小
  comment_font_face: "PingFang SC"
  comment_font_point: 14

内部都有完善的注释,感兴趣可以按注释进行参考。

你可以直接更改这个文件后,重新部署。也可以修改custom文件(如果没有,那么可以自行在不带custom的同级目录创建)。

如果你想修改custom文件,需要注意:

  • 开头需要使用patch进行描述;
  • 覆写某些内容时,需要使用""指向到具体的内容。

举例: 修改鼠须管的布局为横向布局,那么squirrel.custom.yaml可以这样写:

yaml
patch:
  "style/horizontal": false

反例:

yaml
patch:
  style:
    # 这样会把style内部的内容清空,只有一个horizontal配置
    horizontal: false

输入法方案配置

接下来,我们看看「输入法方案配置」,方案的全局配置是default.yamldefalut.custom.yaml;对于局部,以薄荷输入法为例:

  • rime_mint.schema.yaml就是一个局部配置。rime_mint.schema.yaml内可以覆写default.yaml的配置。
  • 创建rime_mint.custom.yaml文件,优先级高于rime_mint.schema.yaml。可以覆写rime_mint.schema.yaml的配置。

所以,优先级是:

null

目前,薄荷输入法已经实现了default.yaml配置。在使用薄荷配置的时候,会自动覆盖 rime 客户端(鼠须管、小狼毫等)系统自带的default.yaml

所以:

  • 如果你想自定义全局样式,推荐使用default.custom.yaml文件覆写default.yaml
  • 如果你想修改薄荷输入法的配置,推荐使用rime_mint.custom.yaml文件进行覆写。

举例: 覆写全局的输入方案配置,设置候选为6个:

yaml
patch:
  "menu/page_size": 6

反例:

yaml
patch:
  menu:
    # 这样会把 menu 内容清空,只有一个page_size配置
    page_size: 6

没事,接下来本章节还有更多的例子,可以参考。

修改薄荷输入法的配置

薄荷内自带了很多的配置,但是可能不符合你的喜好。那么,你可以根据自己的喜好,进行覆写。

我们以「薄荷拼音」为例,我们想开启它的模糊拼音应该怎么操作呢?

它的配置文件是rime_mint.schema.yaml。我有时候更新时候,会修改这个文件,如果你想覆盖更新,如果不使用 Git 进行管理,可能会产生冲突。

所以,推荐使用rime_mint.custom.yaml文件进行覆写。这样,即使更新了,你也可以直接覆盖同名文件,不会影响你的配置。

综上所述,我们可以这样操作:

  1. 打开或创建rime_mint.custom.yaml文件;
  2. 根据后文 模糊拼音 章节,我们知道是需要覆写speller/algebra模块,使用patch进行覆写,

rime_mint.custom.yaml文件内容:

yaml
# Rime schema
# encoding: utf-8

patch:
  speller/algebra:
    - erase/^xx$/ # 首选保留
    ## 模糊拼音
    - derive/^([zcs])h/$1/ # zh, ch, sh => z, c, s
    - derive/^([zcs])([^h])/$1h$2/ # z, c, s => zh, ch, sh
    - derive/([aei])n$/$1ng/ # en => eng, in => ing
    - derive/([aei])ng$/$1n/ # eng => en, ing => in
    - derive/([iu])an$/$lan/ # ian => iang, uan => uang
    - derive/([iu])ang$/$lan/ # iang => ian, uang => uan
    - derive/([aeiou])ng$/$1gn/        # dagn => dang
    - derive/([dtngkhrzcs])o(u|ng)$/$1o/  # zho => zhong|zhou
    - derive/ong$/on/                  # zhonguo => zhong guo
    - abbrev/^([a-z])[a-z]*$/$1/       # 简拼(首字母)
    - abbrev/^([zcs]h).+$/$1/          # 简拼(zh, ch, sh)
     ### 自动纠错
    # 有些规则对全拼简拼混输有副作用:如「x'ai 喜爱」被纠错为「xia 下」
    # zh、ch、sh
    - derive/([zcs])h(a|e|i|u|ai|ei|an|en|ou|uo|ua|un|ui|uan|uai|uang|ang|eng|ong)$/h$1$2/  # hzi → zhi
    - derive/([zcs])h([aeiu])$/$1$2h/  # zih → zhi
    # ai
    - derive/^([wghk])ai$/$1ia/  # wia → wai
    # ia
    - derive/([qjx])ia$/$1ai/  # qai → qia
    # ei
    - derive/([wtfghkz])ei$/$1ie/
    # ie
    - derive/([jqx])ie$/$1ei/
    # ao
    - derive/([rtypsdghklzcbnm])ao$/$1oa/
    # ou
    - derive/([ypfm])ou$/$1uo/
    # uo(无)
    # an
    - derive/([wrtypsdfghklzcbnm])an$/$1na/
    # en
    - derive/([wrpsdfghklzcbnm])en$/$1ne/
    # ang
    - derive/([wrtypsdfghklzcbnm])ang$/$1nag/
    - derive/([wrtypsdfghklzcbnm])ang$/$1agn/
    # eng
    - derive/([wrtpsdfghklzcbnm])eng$/$1neg/
    - derive/([wrtpsdfghklzcbnm])eng$/$1egn/
    # ing
    - derive/([qtypdjlxbnm])ing$/$1nig/
    - derive/([qtypdjlxbnm])ing$/$1ign/
    # ong
    - derive/([rtysdghklzcn])ong$/$1nog/
    - derive/([rtysdghklzcn])ong$/$1ogn/
    # iao
    - derive/([qtpdjlxbnm])iao$/$1ioa/
    - derive/([qtpdjlxbnm])iao$/$1oia/
    # ui
    - derive/([rtsghkzc])ui$/$1iu/
    # iu
    - derive/([qjlxnm])iu$/$1ui/
    # ian
    - derive/([qtpdjlxbnm])ian$/$1ain/
    # - derive/([qtpdjlxbnm])ian$/$1ina/ # 和「李娜、蒂娜、缉拿」等常用词有冲突
    # in
    - derive/([qypjlxbnm])in$/$1ni/
    # iang
    - derive/([qjlxn])iang$/$1aing/
    - derive/([qjlxn])iang$/$1inag/
    # ua
    - derive/([g|k|h|zh|sh])ua$/$1au/
    # uai
    - derive/([g|h|k|zh|ch|sh])uai$/$1aui/
    - derive/([g|h|k|zh|ch|sh])uai$/$1uia/
    # uan
    - derive/([qrtysdghjklzxcn])uan$/$1aun/
    # - derive/([qrtysdghjklzxcn])uan$/$1una/ # 和「去哪、露娜」等常用词有冲突
    # un
    - derive/([qrtysdghjklzxc])un$/$1nu/
    # ue
    - derive/([nlyjqx])ue$/$1eu/
    # uang
    - derive/([g|h|k|zh|ch|sh])uang$/$1aung/
    - derive/([g|h|k|zh|ch|sh])uang$/$1uagn/
    - derive/([g|h|k|zh|ch|sh])uang$/$1unag/
    - derive/([g|h|k|zh|ch|sh])uang$/$1augn/
    # iong
    - derive/([jqx])iong$/$1inog/
    - derive/([jqx])iong$/$1oing/
    - derive/([jqx])iong$/$1iogn/
    - derive/([jqx])iong$/$1oign/
    # 其他
    - derive/([rtsdghkzc])o(u|ng)$/$1o/ # do → dou|dong
    - derive/ong$/on/ # lon → long
    - derive/([tl])eng$/$1en/ # ten → teng
    - derive/([qwrtypsdfghjklzxcbnm])([aeio])ng$/$1ng/ # lng → lang、leng、ling、long

对比一下rime_mint.custom.yamlrime_mint.schema.yaml

对比

举例: 输入法横向输入

如果你想在macOS上,将输入法的布局改为横向输入,那么可以这样操作:

  1. 打开或创建squirrel.custom.yaml文件;
  2. 使用patch进行覆写,将candidate_list_layout改为linear

可能的内容:

yaml
patch:
  # stacked | linear | tabled 候选项排列方向(如果希望水平,设置linear)
  style/candidate_list_layout: linear

警告

如果你的输入法皮肤里设置有candidate_list_layout: stacked,根据局部配置大于全局配置的原因,那么这个设置可能会失效。

同时,目前candidate_list_layout的配置优先级大于horizontal: true的优先级,不过如果candidate_list_layout设置无效,也可以尝试horizontal: true

举例: 自定义输词库

如果你想自定义词库,那么可以这样操作,以薄荷输入法内的「薄荷拼音-全拼输入」为例:

  1. 打开或创建rime_mint.custom.yaml文件;
  2. 使用patch进行覆写,将translator/dictionary改为你的自定义词库;

可能的内容:

yaml
patch:
  # 设置「薄荷拼音-全拼输入」的词典,使用 rime_mint.custom.dict.yaml 文件
  translator/dictionary: rime_mint.custom

同时,可以看到,我们这里定位到rime_mint.custom.dict.yaml文件,那么我们可以创建这个文件,然后在这个文件内写入我们的词库。建议把薄荷自带的词库拷贝一份,然后进行修改:

yaml
---
name: rime_mint.custom                  # 注意name和文件名一致
version: "2024.02.11"
sort: by_weight
# 此处为 输入法所用到的词库,既补充拓展词库的地方
# 雾凇拼音词库,由Github Robot自动更新
import_tables:
  - dicts/custom_simple          # 自定义
  - dicts/rime_ice.8105          # 霧凇拼音 常用字集合
  - dicts/rime_ice.41448         # 霧凇拼音 完整字集合
  - dicts/rime_ice.base          # 雾凇拼音 基础词库
  - dicts/rime_ice.ext           # 雾凇拼音 扩展词库
  - dicts/other_kaomoji          # 颜文字表情(按`vv`呼出)
  - dicts/other_emoji            # Emoji(仅仅作为补充,实际使用一般是OpenCC生效)
  - dicts/rime_ice.others        # 雾凇拼音 others词库(用于自动纠错)
  - dicts/yourCustomDict         # 你的自定义词典
...