mirror of https://github.com/d0zingcat/rime_wanxiang.git synced 2026-05-13 15:10:03 +00:00

Files

2026-01-21 17:44:23 +08:00

9.1 KiB

Raw Permalink Blame History

Rime YAML Custom Patch 语法指南

patch是对方案文件前端配置文件做出补丁修改的最高权重配置文件权重排序为 custom.yaml > schema.yaml > default.yaml 我们修改方案功能要找准目标，例如修改wanxiang.schema.yaml则需要创建或者修改wanxiang.custom.yaml，dict.yaml是不能被patch的

知道了以上信息我们还要了解custom的工作逻辑，在编译的时候，文件将先处理本文件内的引用如：引用__include: 补丁__patch: 跟随__append: 因此当schema中如果涉及到__include等这些方法，那么你看到的则不是最终形态，最终形态可以在build文件夹中看到他递归整理后的样子，而我们custom patch就是对这个最终形态进行修改，所以我们不能patch一个__include段落就是这个缘故。同样在custom文件中我们为了简化也可以使用__include这样的命令，比如我们预设文件中引用了关系到双拼类型的转写文件，同样是先将这个文件对应的段落拿进来，再用这个段落替换schema原本的段落从而完成修改。

patch:
  speller/algebra:
    __patch:
      - wanxiang_algebra:/pro/自然码
      - wanxiang_algebra:/pro/直接辅助

知道了这些我们说一个极为重要的点：一个custom文件顶层必须只有一个patch:

在YAML语法中同一个段落内的内容必须按层级进行两个空格的缩进，依次4个、6个缩进下去，因此写在patch:下面的内容也不例外，那么能不能顶层再写东西了？答案是可以但不能插入到patch内容的中间，这将会截断整个patch段落，你可以将这些内容放在文件的最后，不干扰patch段落，就像万象携带的模糊音等段落。

1、引用__include

schema:
  __include: xxx

将顶层段落xxx下面的内容放在schema下面

schema:
__include: xxx

将顶层段落xxx下面的内容放在与schema同级的位置，注意看缩进的位置

  schema:
    __include: wanxiang_algebra:/xxx

将wanxiang_algebra.yaml文件中，顶层段落xxx下面的内容放在与schema下面

2、补丁__patch: 跟随__append:

在单个段落下功能用法等同于__include，几乎没什么区别，但他可以叠加使用，如：

patch:
  speller/algebra:
    __include: wanxiang_algebra:/mixed/通用派生规则
    __patch: wanxiang_algebra:/mixed/全拼

在使用了__include的下面我们可以继续使用__patch来让另一个段落继续跟过来，如果是两个__include摞起来是没用的但这也并非__patch自己完全的功劳，因为在转写段落跟随在一起的情况下我们还会在原段落加入跟随__append命令，形如：

patch:
  speller/algebra:
    __include: wanxiang_algebra:/mixed/通用派生规则
    __patch: wanxiang_algebra:/mixed/全拼
#另一个文件中
mixed:
  全拼:
    __append:
      - xxx
      - yyy

patch可单用于段落整合，也可用于表与表之间的内容拼接，拼接时叠加__append:跟随命令使得两个表段落拼接到一起共同作为上层段落的值

知道了以上几个命令我们大概率能完成本文件内“最终态”的认识，在这个基础上我们开始了对schema打补丁的操作。

在打补丁前我们可以将段落的上层认为是本层的key键，本层及其下面所有认为是上层的值value，在这个概念的加持下，我们学习一些patch语法如下：

语法表格

操作类型	语法	说明
新增	`key/+:`	在某个列表中追加值,自动加在末尾
删除	`key/-:`（错误示例不可用）	从列表中移除值（错误示例不可用）
全局替换	`key: new_value`	替换整个键的值
部分替换	`key/index/subkey: value`	修改列表中的特定项,不影响其他项
特定行替换	engine/filters/@12	替换列表中第13行的值
末尾行替换	engine/processors/@last	替换列表中最后一行的值
特定行追加	engine/filters/@before 5	在第6行插入新值，原值后移一行

注意：在进行有关特定行的操作时，请注意列表的计数是从0开始的。例如，如果想在第5行插入一个值，应该使用@before 4。如果要替换第5行的值，应该使用@4。

1. 新增值 (`/+`)

patch:
  schema_list/+: 
    - luna_pinyin      # 这是正确的例子：追加这个方案列表为启用状态，多个值列表即可
  schema_list/-: wubi  # 这是一个错误的例子：/-不可被使用
  engine/filters/-:
    - lua_filter@*en_spacer #这是一个错误的例子：/-不可被使用
  menu/page_size: 10   # 这是正确的例子：单独替换最下层具体的值 page_size 值，不影响其他值

  
  更多方式参考rime文档

Rime YAML Patch 机制解析

我们看到可以基于层级使用/依次代表下一层的路径，也可以:换行空两格代表，但是在patch中这个事情确整出了差别，如下：

为什么 `menu/page_size: 10` 和 `menu: { page_size: 10 }` 结果不同？

在 Rime YAML Patch 机制 下，menu/page_size: 10 和 menu: { page_size: 10 } 看似等价，但 行为是不同的，主要原因在于 Patch 机制的覆盖策略。

menu/page_size: 10 仅修改 menu 下的 page_size，不会影响 menu 里的其他键值。
menu: { page_size: 10 } 会直接覆盖 menu，即 清空 menu 下原有的所有内容，只留下 page_size。

假设一个段落：

menu:
  page_size: 10
  settings:
    font_size: 14
    color: blue

正确写法（不会删除 settings）就是局部修改值：

patch:
  menu/page_size: 10

错误写法（会删除 settings）就是全局替换：

patch:
  menu:
    - page_size: 10

以下是常用的三种情况：

#整体替换
patch:
  engine:
    translators:
      - table_translator@custom_phrase  #此例会替换整个engine模块的值，只保留translators下的table_translator@custom_phrase，其他值全部删除

#部分替换
patch:
  engine/translators:
    - table_translator@custom_phrase  #此例只会替换engine下的translators模块的值为table_translator@custom_phrase，translators模块的其他值全部删除，而engine其他模块的值不受影响

#追加新的内容
patch:
  engine/translators/+:
    - table_translator@custom_phrase  #此例只在engine下的translators模块下新增table_translator@custom_phrase，translators模块的其他值不变，engine其他模块的值也不受影响

也就是说不能用/-，如果想要删除某一行

下面再用两个实际的例子来巩固一下：

#由于下面列表值，所以你想删除某一行只能在这里注释掉，还要观察主方案是否提供了新的值，删除某一个单独的值确实是个难点
patch:
  engine/filters:
    - lua_filter@*chars_filter                     
    - lua_filter@*cold_word_drop.filter
    - lua_filter@*assist_sort                       
    - lua_filter@*autocap_filter                    
    - reverse_lookup_filter@radical_reverse_lookup  
    - lua_filter@*pro_preedit_format                
    - simplifier@emoji                            
    - simplifier@traditionalize                     
    - simplifier@mars                               
    - simplifier@chinese_english                    
    - simplifier@zrm_chaifen                        
    - lua_filter@*search@radical_pinyin            
    #- lua_filter@*en_spacer                         
    - lua_filter@*pro_comment_format                
    - uniquifier

#但是如果你想删除某一行携带值的整行，有办法了，用如下的表示即可，将现有的值清空，部署的时候整行也就不会生效了，这一行就不存在了
patch:
  custom_phrase/user_dict:
  custom_phrase/initial_quality:

最后还要注意一点，非常重要：

在engine模块下面的选项是有顺序的，所以想要新增一个行，需要判断添加到末尾是否可用，如果是一个引导器就不能下面这样添加，这会导致这一行排列在最后，导致功能不能使用

#追加新的内容
patch:
  engine/translators/+:   #这种方式将把新增值自动加在列表末尾，导致功能失效
    - table_translator@custom_phrase

应该使用特定行追加 engine/translator/@before 5 意思就是放到translator下面的第6行，而原来第6行的值会移到第7行，其他的依次后移

patch:
  engine/translator/@before 5:  #这种方式将在第5行后面新增一行，后面的行后移
    table_translator@custom_phrase   #注意前面不能加短线了，这样才是一个值，而不是一个表
  engine/translator/@5:    #这种方式将替换第6行的值
    table_translator@custom_phrase   #注意前面不能加短线了，这样才是一个值，而不是一个表

9.1 KiB Raw Permalink Blame History Unescape Escape