From f3d15eca2def41b4874f1016e9569831f71db266 Mon Sep 17 00:00:00 2001 From: Joshua Horton Date: Tue, 18 Mar 2025 08:07:04 +0700 Subject: [PATCH] docs(web): improved doc on fat-finger correction paragraph --- web/docs/internal/keystroke-processing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/docs/internal/keystroke-processing.md b/web/docs/internal/keystroke-processing.md index 316830282f..008c118d93 100644 --- a/web/docs/internal/keystroke-processing.md +++ b/web/docs/internal/keystroke-processing.md @@ -6,7 +6,7 @@ In addition to handling keystroke events produced from hardware keyboards, Keyma Defined at [web/src/engine/keyboard/src/keyEvent.ts](https://github.com/keymanapp/keyman/blob/master/web/src/engine/keyboard/src/keyEvent.ts), the `KeyEvent` is used to represent incoming _and_ potential keystrokes. This type is what the JS-keyboard processor references when evaluating keyboard rules during its keystroke processing. For versions of the engine that support AltGr aliasing, such aliasing will be applied during generation of `KeyEvent` objects. -Note that for predictive-text's fat-finger correction functionality, the engine will also generate versions of this type for _unpressed_ keys _weren't_ into the keystroke processing engine as well. Each will be applied to a `Mock`-cloned copy of the active context-state. +Note that for predictive-text's fat-finger correction functionality, the engine will also generate versions of this type for nearby but _unpressed_ keys into the keystroke processing engine as well in order to facilitate predictions that follow context manipulations that could have resulted from specialized rules or reorders on neighboring keys. `Mock`-cloned copies of the active context-state will be leveraged to prevent unwanted manipulation of the true context source. ### `isSynthetic` `isSynthetic` should be set to `true` if generated through interaction with an on-screen-keyboard or for fat-finger simulation. It should only be set to `false` if sending the basic key-event data through to the destination, without rule processing, leads to default handling picking up the slack. Browsers provide default handling of keystrokes not directly defined within keyboards, but this is not available for keystrokes against the engine's OSK without internal support.