search

rime / home

Rime::Home is home to Rime users and developers
https://rime.im
4.23k stars 230 forks source link

Where can I find the documentation on the key "speller/initials"? #1607

Open rodrigomorales1 opened 2 months ago

rodrigomorales1 commented 2 months ago

I'm not a Chinese native speaker, but I'm learning Chinese and I like using RIME.

I want to create my own custom schema, so I'm looking at some schemas that the community have created so that I can better understand how RIME schemas are created.

I have noticed that many schemas define the key initials. In bopomofo.schema.yaml,initials is set as shown below (link):

(...omitted lines...)
speller:
  alphabet: '1qaz2wsxedcrfv5tgbyhnujm8ik,9ol.0p;/- 6347'
  initials: '1qaz2wsxedcrfv5tgbyhnujm8ik,9ol.0p;/-'
  finals: " 6347"
  delimiter: "'"
(...omitted lines...)

In double_pinyin_mspy.schema.yaml , initials is set as shown below (link):

(...omitted lines...)
speller:
  alphabet: zyxwvutsrqponmlkjihgfedcba;
  initials: zyxwvutsrqponmlkjihgfedcba
  delimiter: " '"
  algebra:
(...omitted lines...)

So, my question is: Where can I find the documentation on the key "initials"?

I know of the existence of https://github.com/rime/home/wiki/RimeWithSchemata , but that page doesn't contain documentation on the key initials.

LEOYoon-Tsaw commented 2 months ago

Initials means the letters that a code can start with. For example, if alphabet is "abc", and initials only include "ab", then bac is valid code while cab is not.