Add screenshots of input modes to the documentation.

#codehealth PiperOrigin-RevId: 678939469
fcitx · Sep 26, 2024 · 2ff5397 · 2ff5397
1 parent 5a07019
commit 2ff5397
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/docs/configurations.md b/docs/configurations.md
@@ -44,13 +44,15 @@ Full customization is also available.
 *   Precomposition: Mode to type Hiragana characters, but no character is typed
     yet.
 *   Composition: Mode to type Hiragana characters.
-*   Suggestion: Sub-mode of Composition. Some word suggestions have appeared.
+*   Suggestion: Sub-mode of Composition. Some word suggestions have appeared,
+    but no candidate is focused.
 *   Conversion: Mode to select words (in Kanji). Candidate words are generated
     by exact-match (by Space key).
 *   Prediction: Sub-mode of Conversion. Candidate words are generated by
     prefix-match (by Tab key).
 
-![Input modes](input_modes.svg)
+![Diagram of input modes](input_modes.svg)
+![Screenshots of input modes](input_modes.png)
 
 ## Configuration path
 

diff --git a/docs/input_modes.png b/docs/input_modes.png
diff --git a/src/data/keymap/README.md b/src/data/keymap/README.md
@@ -30,12 +30,14 @@ Shortcut keys are configurable from the preferences dialog GUI.
 *   Composition
     +   Mode to type Hiragana characters.
 *   Suggestion
-    +   Sub-mode of Composition. Some word suggestions are appeared.
+    +   Sub-mode of Composition. Some word suggestions have appeared, but no
+        candidate is focused.
 *   Conversion
     +   Mode to select words (in Kanji). Candidate words are generated by
         exact-match (by Space key).
 *   Prediction
     +   Sub-mode of Conversion. Candidate words are generated by prefix-match
         (by Tab key).
 
-![Input modes](../../../docs/input_modes.svg)
+![Diagram of input modes](../../../docs/input_modes.svg)
+![Screenshots of input modes](../../../docs/input_modes.png)