Vietnamese keyboard: TELEX convention with minor restrictions #9589

weijiuqiao · 2022-10-04T05:21:26Z

This PR adds a modified version of the Vietnamese TELEX IME.

Based on info found at:

Said restrictions:

Letters composed by 2 strokes (đ, ă, â, ô, ê, ư, ơ) must be entered in one go. For example, while a "full" TELEX IME allows dad for entering 'đa', this one only allows dda.
No tone overriding. Entering multiple tone marks to have only the last one take effect is not supported.
No syllable-tone limitation considered. So you can enter syllables with tones that do not actually exist in the language.
Other minor inconsistencies.

Why it's not so bad:

Tones can however still be entered at the end of a word.

The current set-up follows what's recommended from the first linked reference above:

...if you have asked if it’s possible to defer the “breve” on top of the "a" till finishing the whole word ... the answer is yes. It’s possible ... However, this type of deferral is not used by many people and is also not recommended for the reason that it may actually slow you down. ... In addition, since ă ... is part of the Vietnamese Alphabet, it makes sense that we type it as one single unit.

(on deferring tone input) ...In fact many Vietnamese use this second way of typing the accent mark after completing the alphabet (word).

As I do not speak the language or have any Vietnamese friend yet, it would be great to get some help in testing it from native or proficient users.

This change is

poire-z · 2022-10-04T07:13:14Z

As I do not speak the language or have any Vietnamese friend yet, it would be great to get some help in testing it from native or proficient users.

Pinging @yukari186 (#8202).
Pinging @vietchovui (#8041).

(@weijiuqiao : less lucky granchildren :)

vietchovui · 2022-10-04T13:09:44Z

I don't know how to test it :( . Could you instruct me? I use koreader on kobo forma

weijiuqiao · 2022-10-04T14:00:01Z

I suppose you can see the KOReader root folder? If so, download the following zip file and replace files according to the unzipped folder names.
vi_keyboard.zip

You should first backup your old files by renaming them something else. Then move the new files into your device. In case of crash, delete the new files and restore the old files' names.

TranHHoang · 2022-10-06T02:20:20Z

Thanks for your hard work! I tested it on the emulator and found an issue: typing awt should produces ăt, but current it is ăwt. Also, IMO there is a minor annoyance when it comes to deleting a letter composed by two strokes with/or a tone mark: you have to delete it multiple times. Normally I can press delete and be done with it.

NiLuJe · 2022-10-06T03:22:59Z

frontend/ui/data/keyboardlayouts/vi_keyboard.lua

+        -- Wrap all of the navigation and non-single-character-input keys with
+        -- a callback to clear the tap window, but pass through to the
+        -- original function.


I added a dedicated method for the Delete key in #9586 (delNextChar) ;).

Good to know! Luckily we don't really care what's behind (next) when using zh_ime so no need to hook it :) Also I copied the comment from another keyboard file and it's not exactly accurate here, so I made a little update.

weijiuqiao · 2022-10-06T08:55:06Z

Thanks for testing it @TranHHoang and finding the error! I did let that extra "w" slip through. Have fixed it and double checked the others, seems no problem now.

IMO there is a minor annoyance when it comes to deleting a letter composed by two strokes with/or a tone mark: you have to delete it multiple times. Normally I can press delete and be done with it.

As to this, it'll be a bit of a hassle to implement. So how about we instead view it as a feature ;)
Now you don't have to delete the whole letter and compose from the start but can just delete a part of it! Since I don't know maybe it's more likely that you mistyped one key (say ấ aas for ẫ aax) than a whole letter?

poire-z · 2022-10-06T18:56:18Z

Conflicts, as base with your change to utf8proc has already been bumped.
Also, IME: ?! I, me think about your grandchildren (sorry for insisting :)

NiLuJe · 2022-10-06T20:01:07Z

Input Method Engine?

(I don't particularly feel offended by that one, given the context, FWIW ;o).

poire-z · 2022-10-06T20:38:58Z

(There's no context given, that's my point :) Give some and I'm fine: Chinese IME..., Chinese keyboard: IME... as first commit is about the Chinese keyboard - the 2nd commit is adequately titled.)

weijiuqiao · 2022-10-07T00:28:10Z

It's because the first commit is not necessarily about the Chinese keyboard but more about a general capacity of the engine (auto separate when input key is unique). But I did change one method name resulting in the changes in zh_keyboard. How about I make this clearer in the commit message?

poire-z · 2022-10-07T07:18:25Z

How about I make this clearer in the commit message?

I'm all about making things clearer :)

It's because the first commit is not necessarily about the Chinese keyboard but more about a general capacity of the engine

Many things are clear to you, as you're fully into this code. You can title your commits as you work on them as quickly/short/dumb as you wish (see @NiLuJe PRs :)
But when merged into master, they will get a title for eternity, and they are mixed with many others which are about other topics.
IME bump: supports auto seperation when code is unique is all very clear for you who has worked on a Chinese IME. But not for other devs/watchers who didn't follow this with you: they'll wonder and will have to look at the code to get what "IME" means and see it's only about the Chinese keyboard and they can skip being interested in this commit.
Also, all very clear to you as you just done it, and I didn't even notice until you said it: this Chinese IME is used by the Vietnamese keyboard: put this in the commit message of the Vietnamese commit, to make it known (ok, we can see it in the code, but let it be known to people reading commits, may be us later when bissecting, etc...).
Also, all very clear to you as you've just done it, there is only one IME, THE IME, your IME that you named IME. But for me, it's THE Chinese IME :) it is still named zh_ime.lua (and we have a Korean IME that is not named "ime" but just "helper").
(If this zh_ime.lua is really generic enough and planned to be used by many other xy_keyboard, you should rename it to generic_ime.lua - and then, you'll be allowed to name it Generic keyboad IME: supports separation... :)

I don't mind your commits titles when you do a single topic PR, as we can tweak the single commit title when "squashing" them all, and I don't mind doing it (ie. all your Vocabulary builder: PRs :) but when you do a multi topics PR like this one, I can't do it for you :)
(sorry for being insistent, but you're not alone - many times plugin authors forgot to mention the plugin name in their PRs title - they just go with "Fixed this" :)

weijiuqiao · 2022-10-11T16:52:06Z

If this zh_ime.lua is really generic enough and planned to be used by many other xy_keyboard, you should rename it to generic_ime.lua - and then, you'll be allowed to name it Generic keyboad IME: supports separation... :)

Done as suggested :)

poire-z · 2022-10-11T17:34:38Z

frontend/ui/data/keyboardlayouts/generic_ime.lua

    switch_char = "下一字", -- default
    separator = "分隔",  -- default


Should these stay in a generic IME ?
Does the vietnamese keyboard show them ?

The Vietnamese keyboard doesn't show them or use their functionality. I can change them to some other strings but that would mean rebase and force push yet again! Can I open a PR after if this one is merged? (Will stick to single PRs from now on...)

that would mean rebase and force push yet again!

Nothing wrong with that, we all do that and many times per PR when we have multiple topic commits.
But as you wish.

If that's the case, then let me force push again. I just thought the many not-so-meaningful push records might be too distracting.

poire-z · 2022-10-11T17:36:47Z

That wasn't really a suggestion :) I was just making a point as to why you should prefix with "Chinese keyboard/IME".
But well, ok :) (Having look at it, it indeed "looks" generic.)

poire-z · 2022-10-12T06:43:11Z

frontend/ui/data/keyboardlayouts/generic_ime.lua

+---------------------------------
+-- Generic input method engine --
+---------------------------------


(We don't usually have this kind of boxed comments.)

NiLuJe · 2022-10-12T21:55:20Z

frontend/ui/data/keyboardlayouts/zh_keyboard.lua

    W = W -- has wildcard function
 }

 local wrappedAddChars = function(inputbox, char)
    ime:wrappedAddChars(inputbox, char)
 end

-local function wrappedSeparate(inputbox)
-    ime:wrappedSeparate(inputbox)
+local function seperate(inputbox)


nit for a followup: separate ;).

weijiuqiao force-pushed the chinese_keyboard branch 3 times, most recently from 0b67d8a to 33cbe3c Compare October 4, 2022 07:00

NiLuJe reviewed Oct 6, 2022

View reviewed changes

weijiuqiao force-pushed the chinese_keyboard branch from 33cbe3c to 83944b8 Compare October 6, 2022 08:26

weijiuqiao force-pushed the chinese_keyboard branch from 83944b8 to 1c56cd0 Compare October 6, 2022 15:06

weijiuqiao force-pushed the chinese_keyboard branch 2 times, most recently from 1e0ec42 to e460e4e Compare October 7, 2022 04:56

weijiuqiao force-pushed the chinese_keyboard branch 3 times, most recently from 04963f3 to 1912469 Compare October 11, 2022 16:50

poire-z reviewed Oct 11, 2022

View reviewed changes

poire-z added this to the 2022.10 milestone Oct 11, 2022

weijiuqiao added 2 commits October 12, 2022 13:11

Generic keyboard IME bump: supports auto seperation when code is unique

86c2795

Vietnamese keyboard: TELEX method backed by generic_ime

99693be

weijiuqiao force-pushed the chinese_keyboard branch from 1912469 to 99693be Compare October 12, 2022 05:15

poire-z approved these changes Oct 12, 2022

View reviewed changes

poire-z merged commit ae8156f into koreader:master Oct 12, 2022

This was referenced Oct 12, 2022

FR: Vietnamese input method #8041

Closed

Add vietnamese keyboard #8294

Closed

NiLuJe reviewed Oct 12, 2022

View reviewed changes

weijiuqiao mentioned this pull request Oct 13, 2022

zh_keyboard: fix misspelling #9633

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Vietnamese keyboard: TELEX convention with minor restrictions #9589

Vietnamese keyboard: TELEX convention with minor restrictions #9589

weijiuqiao commented Oct 4, 2022 •

edited

poire-z commented Oct 4, 2022

vietchovui commented Oct 4, 2022

weijiuqiao commented Oct 4, 2022

TranHHoang commented Oct 6, 2022

NiLuJe Oct 6, 2022

weijiuqiao Oct 6, 2022

weijiuqiao commented Oct 6, 2022

poire-z commented Oct 6, 2022

NiLuJe commented Oct 6, 2022

poire-z commented Oct 6, 2022

weijiuqiao commented Oct 7, 2022

poire-z commented Oct 7, 2022

weijiuqiao commented Oct 11, 2022

poire-z Oct 11, 2022

weijiuqiao Oct 11, 2022

poire-z Oct 11, 2022

weijiuqiao Oct 12, 2022

poire-z commented Oct 11, 2022

poire-z Oct 12, 2022

NiLuJe Oct 12, 2022

		switch_char = "下一字", -- default
		separator = "分隔", -- default

Vietnamese keyboard: TELEX convention with minor restrictions #9589

Vietnamese keyboard: TELEX convention with minor restrictions #9589

Conversation

weijiuqiao commented Oct 4, 2022 • edited

poire-z commented Oct 4, 2022

vietchovui commented Oct 4, 2022

weijiuqiao commented Oct 4, 2022

TranHHoang commented Oct 6, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weijiuqiao commented Oct 6, 2022

poire-z commented Oct 6, 2022

NiLuJe commented Oct 6, 2022

poire-z commented Oct 6, 2022

weijiuqiao commented Oct 7, 2022

poire-z commented Oct 7, 2022

weijiuqiao commented Oct 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

poire-z commented Oct 11, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weijiuqiao commented Oct 4, 2022 •

edited