jyutcitzi-RIME

Recipe: ℞ jyutcitzi/jyutcitzi-RIME

Other READMEs: HK Cantonese（Honzi, Honzi-Jyutcitzi）| English

RIME keyboard for realizing the Honzi-Jyutcitzi mixed script in Hong Kong Cantonese.
Thanks for supporting this Jyutcitzi keyboard and font project! The following sections contains the installation instruction for Mac and Windows, as well as some words on how to use the keyboard itself, and concludes with a FAQ section:

1. Installation Instructions
2. File Descriptions
3. Keyboard Features
4. Frequently Asked Questions
5. Software Updates

Installation Instructions

For further questions regarding installation please ask at https://t.me/jyutzigoigaak.

Step 1: Install RIME and RIME Cantonese

Please follow instructions at https://github.com/rime/rime-cantonese/wiki and https://github.com/rime/rime-cantonese/wiki/新手安裝教程
In a nutshell, download and install using the following files:
Mac: mac-2021.05.16-installer.pkg
Windows: windows-sfx-2021.05.16-installer.exe
Linux: Download and run ibus-install.sh
Please check to ensure that RIME Cantonese is properly installed before proceeding to Step 3.

Step 2: Install the Jyutcitizi font

1. Download Jyutcitzi fonts at https://github.com/jyutcitzi/jyutcitzi-fonts
2. Install the fonts:
   For Mac: Open the TTF file using Font Book, and click “install”
   For Windows: Right-click on the TTF file and select install
   For Linux: Google "how to install font on your linux distribution"

This step is required in order to render the Jyutcitzi characters. In terms of fonts, PMingLiU (Regular), SourceHanSerifTC (all weights) and SourceHanSansHC (all weights) have all been augmented with Jyutcitzi characters. SourceHanSansHWHC (all weights) has also been included in the set of fonts, though it only contains Jyutcitzi characters.

Step 3: Install the Jyutcitzi keyboards (web and font version)

For Mac:

a. Switch to “Squirrel” on the language tab at the top of the screen
b. Click “Settings...”. A new Finder window should appear
c. Copy and paste the YAML files to the Rime folder
d. Under the language tab, having Squirrel selected, click “Deploy”
e. Wait for the keyboards to load (please be patient!)
f. Hit F4 or CTRL + ` to switch to either:
i. “粵切字 (禾旡·比`·版)” (web version of the keyboard), or
ii. “粵切字 (夫干·天`·版)” (font version of the keyboard)
g. Start typing!

For Windows:

a. Press Windows Key + R, enter %AppData%\Rime and press ENTER. A new window should appear
b. Copy and paste the YAML files to the Rime folder
c. Press "All Applications" > "RIME Weasel" > "[Weasel]Deploy"
d. Wait for the keyboards to load (please be patient!)
e. Hit F4 or CTRL + ` to switch to either:
i. “粵切字 (禾旡·比`·版)” (web version of the keyboard), or
ii. “粵切字 (夫干·天`·版)” (font version of the keyboard)
f. Start typing!

File Descriptions

• default.custom.yaml - config file for specifying the list of RIME keyboards to use (i.e. RIME Cantonese and Jyutcitzi keyboard)
• squirrel.custom.yaml - config file for specifying the font used in the RIME interface, notably used for rendering the Jyutcitzis listed in the list of options when typing
• jyutcitzi_font.schema.yaml - config file for the Jyutcitzi font keyboard
• jyutcitzi_web.schema.yaml - config file for the Jyutcitzi web keyboard
• jyutcitzi_font.dict.yaml - main dictionary for the Jyutcitzi font keyboard, and contains a wide selection of monosyllables rendered using font-based Jyutcitzi characters
• jyutcitzi_web.dict.yaml - main dictionary for the Jyutcitzi web keyboard, and contains a wide selection of monosyllables rendered using web-based Jyutcitzi characters
• jyutcitzi_core.lettered.dict.yaml - dictionary containing the original list of Latin-containing compounds from jyut6ping3.lettered.dict.yaml
• jyutcitzi_font.lettered.dict.yaml - dictionary containing Latin-containing compounds, which are rendered using font-based Jyutcitzi characters
• jyutcitzi_web.lettered.dict.yaml - dictionary containing Latin-containing compounds, which are rendered using web-based Jyutcitzi characters
• jyutcitzi_font.compound.dict.yaml - dictionary containing Honzi compounds, which are rendered using font-based Jyutcitzi characters
• jyutcitzi_web.compound.dict.yaml - dictionary containing Honzi compounds, which are rendered using web-based Jyutcitzi characters
• jyutcitzi_font.phrase.dict.yaml - dictionary containing Cantonese phrases, which are rendered using font-based Jyutcitzi characters
• jyutcitzi_web.phrase.dict.yaml - dictionary containing Cantonese phrases, which are rendered using web-based Jyutcitzi characters
• jyutcitzi.jyutcit_phrases.dict.yaml - dictionary containing a selection of phrases from existing Jyutcitzi literature
• mapping.txt - a list containing the Unicode values for newly-created Jyutcitzi and 改革漢字 characters

Apart from these files, the keyboard also relies on jyut6ping3.dict.yaml and jyut6ping3.phrase.dict.yaml from RIME Cantonese, which is why that has to be installed.

Keyboard Features

Like RIME Cantonese, the keyboard has the following useful features:

0. Hit CTRL + OPTION + ` to redeploy RIME if it bugs out. Restart the computer if necessary.

1. Hit F4 or CTRL + ` (the backward tick next to the escape button) to switch between RIME keyboards via the arrow and enter key.

2. Hitting the SHIFT or CAPS LOCK key allows one to switch between Latin (A) and Jyutping (中)

3. Tones is optional when typing, add tones as follows:
   
   The extended Jyutcitzi alphabet also contains two additional tone marks:
   
   On the account of aesthetics, some will prefer the use of ' and " over ‒ and = for marking tones 1 and 4 when marking tones in Cantonese. To change this preference, please select setting 2 instead of setting 1 in the files jyutcitzi_font.schema.yaml and jyutcitzi_web.schema.yaml.

4. The single quote character ' can be used to separate characters in a string of Jyutping. This character is needed in order to disambiguate the way in which the keyboard splits the string of letters, e.g. use song'kyun instead of songk yun:
   

5. The repeat character 々 is automatically used for known compounds:
   

6. The Jyutcitzi keyboards also has the following key bindings:
   Q ⇒ ̄，W ⇒ ́，E ⇒ `，A ⇒ =，S ⇒ ̋，D ⇒ ﾞ，R⇒々

7. The Jyutcitzi keyboards appropriately provide both toneful and toneless Jyutcitzi as output options. To add pitch to other monosyllables with no toneful option manually use the key bindings!

Warning: Try not to type too many characters in one go, it'll lag the computer a lot!

Frequently Asked Questions

Q: The keyboard stopped working!
A: Try redeploying it under the language tab, or perhaps try restarting your computer.

Q: I can't type a specific monosyllable, e.g. schweis!
A: This Jyutcitzi keyboard is meant to only cover monosyllabic combinations that are likely to be used in English and Cantonese. If you think it is really essential to add a certain monosyllable to the keyboard, feel free to suggest it by opening a new issue!

Q: Where does the keyboard's lexicon come from?
A: It directly comes from the lexicon used in RIME Cantonese (a version from Feb-Mar 2020 to be exact)

Software Updates

Version 2.0

1. Due to aesthetic issues with Suzhou numerals not fitting into the square box, Jyutcitzi now uses tone marks at the glyph's top-right corner instead when marking tones.
2. The repeat glyph 々 can be toned, e.g. Rv ⇒ 々 ̄:
   
3. A sufficient amount of initial consonant cluster-containing Jyutcitzis were added, such as “shwaang” (厶亾禾生), “fwoe” (夫禾居) and “jyue” (央仒旡):
   
4. Numerous tone-free combinations relating to consonant clusters were also added. Examples include “soecj” and “witcj” (English “search” and “which”):
   
5. The keyboard also allows one to transcribe English, Mandarin, Japanese, Taiwanese Hokkien and Taiwanese Hakka in Jyutcitzi. To do this, the following novel components are added:
   a. 圭(⿰) for v- (used in Taiwanese Hakka and English)
   b. ㄖ (⿰) or the consonant cluster wl- 禾力 (⿰) for English/Mandarin r-
   c. 止 for Mandarin -i and Early Cantonese -i
   d. 亇for Mandarin Pinyin -e and English shwa sound
   e. 艮 for Mandarin Pinyin -en
   f. ㄦ for Mandarin Pinyin er
   

Version 1.1:

1. Added 尼 as an entry for 'ne1'
2. Fixed bug where typing 'best' in the font keyboard gave the font equivalent of 比旡·乃力·
3. Adopted ⺍ instead of ` for consonant or vowel only Jyutcitzi characters in the Jyutcitzi font