docs: the input modes as they now are, in one piece

The paragraphs on candidates, keys, and searches had grown by patches;
they read as three: Japanese, Korean, and the searches.
This commit is contained in:
2026-08-17 02:01:02 +09:00
parent b979afc3f7
commit 82cb07eba2

View File

@@ -1,8 +1,9 @@
# strans # strans
strans is a small, single-user input method for Korean, Japanese, English, strans is a small, single-user input method for Korean, Japanese, English,
emoji, and symbols. It provides one engine for IBus, XIM, and GTK 3. emoji, and symbols. It provides one engine for IBus (which GTK 4 and
Vietnamese Telex is also available as a compatibility mode. Qt use), XIM, and GTK 3. Vietnamese Telex is also available as a
compatibility mode.
## Input modes ## Input modes
@@ -18,38 +19,44 @@ Vietnamese Telex is also available as a compatibility mode.
A Korean keyboard's 한/영 key toggles Korean and English, and its 한자 key A Korean keyboard's 한/영 key toggles Korean and English, and its 한자 key
is `Ctrl+H`; a Japanese keyboard's 半角/全角 toggles Japanese and English, is `Ctrl+H`; a Japanese keyboard's 半角/全角 toggles Japanese and English,
ひらがな/カタカナ switches between the two kana modes, 変換 turns Japanese on ひらがな/カタカナ switches between the two kana modes, 変換 turns Japanese
and then converts like `Space`, and 無変換 turns it off. Only a plain `Ctrl` chord is a strans key: with `Shift`, `Alt`, on and then converts like `Space`, and 無変換 turns it off. Only a plain
or `Super` held it commits what is pending and goes to the application, so `Ctrl` chord is a strans key: with `Shift`, `Alt`, or `Super` held it
`Ctrl+Shift+V` still pastes. commits what is pending and goes to the application, so `Ctrl+Shift+V`
still pastes.
A complete Japanese reading shows its Kanji candidates with none chosen. Hiragana mode composes a complete reading, then shows its Kanji candidates
`Space` or `Tab` chooses the first and then steps on, wrapping (with with none chosen: the exact readings of the dictionary, then the verbs and
`Shift`, back); `Up`/`Down` and `PageUp`/`PageDown` move without wrapping. adjectives SKK keys by stem and okurigana (かく offers 確 and 書く), and
An unmodified `1`-`9` commits that row of the current page. `Enter` under `Space` the reading in Katakana last, so a word the dictionary lacks
commits the chosen candidate, or the reading when none is chosen, as `0` converts to Katakana with one `Space`. `Space` or `Tab` chooses the first
always does; so does typing on, or any key that ends the composition. candidate and then steps on, wrapping (with `Shift`, back); `Up`/`Down` and
`Backspace` deletes the last kana shown. `PageUp`/`PageDown` move without wrapping. An unmodified `1`-`9` commits
Japanese consumes the confirming key; Korean and Vietnamese pass it on to that row of the current page. `Enter` commits the chosen candidate, or the
the application. `Space` adds the reading in Katakana as the last reading when none is chosen, as `0` always does; so does typing on, or any
candidate, so a word the dictionary lacks converts to Katakana with one key that ends the composition. `Backspace` deletes the last kana shown;
`Space`. `Backspace` and `Esc` on a chosen candidate go back to the romaji that made no kana stays in the reading as typed until it is mended.
reading. In a temporary Emoji or Hanja search, `Enter` or `Space` commits the `Backspace` and `Esc` on a chosen candidate go back to the reading, and
highlighted result and `Tab`/`Shift-Tab` wrap through the results. Leaving `Esc` on the reading cancels it. Katakana mode does not perform Kanji
the field or clicking elsewhere commits what is pending. `Esc` cancels a conversion.
Japanese reading or a search; in Korean and Vietnamese it commits the
syllable and goes on to the application, so it still leaves insert mode.
Hiragana mode composes a complete reading before offering Kanji candidates. Korean composes one syllable at a time; `Enter`, `Tab`, `Esc`, and any key
Katakana mode does not perform Kanji conversion. Emoji and Hanja searches that is not a jamo commit the syllable and go on to the application, so
return to the previous mode after use; switching language during a search `Esc` still leaves insert mode. Two lone consonants join into the compound
commits the shown query; `Esc` in a Hanja search gives the syllable back final they make (rt → ㄳ) and a vowel typed before its consonant is
to the composition. A search with nothing typed yet shows ☺ or 漢 in the reordered under it (kr → 가), as in libhangul.
popup. The Emoji search matches the typed keys, and what
they spell in the current language, against a prefix of every emoji's Emoji and Hanja searches take over the keys until `Enter`, `Space`, or a
CLDR name and keywords in English, Korean, and Japanese, and against ASCII digit picks a result or `Esc` cancels; they return to the previous mode
symbol aliases such as `->` and `<=`. `Ctrl+H` takes the syllable being composed as its after use, and switching language during a search commits the shown
query; the Hanja dictionary lists one modern Hangul syllable at a time. query. `Tab`/`Shift-Tab` wrap through the results, and a search with
nothing typed yet shows ☺ or 漢 in the popup. The Emoji search matches the
typed keys, and what they spell in the current language, against a prefix
of every emoji's CLDR name and keywords in English, Korean, and Japanese,
and against ASCII symbol aliases such as `->` and `<=`. `Ctrl+H` takes the
syllable being composed as its query and composes on from it; `Esc` gives
the syllable back; the Hanja dictionary lists one modern Hangul syllable at
a time. Leaving the field or clicking elsewhere commits what is pending.
## Preedit and candidates ## Preedit and candidates