I'm unsure if it is best to raise this issue here, or here: https://github.com/fujiwarat/ibus-anthy
First, I am a long time user of ibus-anthy on Linux -- literally as long as I can remember. (The original "phuang" repo has file timestamps from 18 years ago!) It is amazing, and I use it daily. Thank you to all who help.
From the ibus-anthy Preferences dialog, then Key Binding tab, there is no help for either "Shortcut Type", nor the GTK TreeView (multi-column listbox). I think I found the source code for these options here: https://github.com/ibus/ibus-anthy/blob/main/engine/python3/engine.py#L2166
Example: def __cmd_on_off()
I assume that function corresponds to the key binding command "on_off".
The number of key binding commands is huge, and confusing for many users. It would be great if we could add some docs. Also, I am willing to help to write the docs.
My first thought was to add classic GTK tooltips for the "Shortcut Type" combobox and "Command/Shortcut" treeview. However, upon further thinking I have a better idea: Add a single "Help" pushbutton to the tab (top right, bottom left, bottom right are all OK). This button would redirect (using the GTK system default webbrowser) to an language-specific GitHub-hosted Wiki page. Example, we could have a GitHub-hosted Wiki page called: "Preferences - Key Bindings (en)" and "Preferences - Key Bindings (jp)". Depending upon the users "gettext()" locale settings, the correct URL would be constructed, then opened in a web browser.
Why a Wiki page on GitHub? This would dramatically reduce the friction for all (technical and non-technical) users to contribute to the help docs for key bindings. A Wiki (or anything HTML) would also be better than a classic GTK tooltip because docs can include images and screenshots. For example, many Japanese language learners have never seen a standard JIS Japanese keyboard. A small photo displaying special keys with explanations would be helpful. (It may also be helpful to native Japanese speakers who are learning to use a JIS Japanese keyboard!)
Please let me know your thoughts. I am happy to contribute a patch, and write some of the Wiki help page.
I'm unsure if it is best to raise this issue here, or here: https://github.com/fujiwarat/ibus-anthy
First, I am a long time user of ibus-anthy on Linux -- literally as long as I can remember. (The original "phuang" repo has file timestamps from 18 years ago!) It is amazing, and I use it daily. Thank you to all who help.
From the ibus-anthy Preferences dialog, then Key Binding tab, there is no help for either "Shortcut Type", nor the GTK TreeView (multi-column listbox). I think I found the source code for these options here: https://github.com/ibus/ibus-anthy/blob/main/engine/python3/engine.py#L2166
Example: def __cmd_on_off()
I assume that function corresponds to the key binding command "on_off".
The number of key binding commands is huge, and confusing for many users. It would be great if we could add some docs. Also, I am willing to help to write the docs.
My first thought was to add classic GTK tooltips for the "Shortcut Type" combobox and "Command/Shortcut" treeview. However, upon further thinking I have a better idea: Add a single "Help" pushbutton to the tab (top right, bottom left, bottom right are all OK). This button would redirect (using the GTK system default webbrowser) to an language-specific GitHub-hosted Wiki page. Example, we could have a GitHub-hosted Wiki page called: "Preferences - Key Bindings (en)" and "Preferences - Key Bindings (jp)". Depending upon the users "gettext()" locale settings, the correct URL would be constructed, then opened in a web browser.
Why a Wiki page on GitHub? This would dramatically reduce the friction for all (technical and non-technical) users to contribute to the help docs for key bindings. A Wiki (or anything HTML) would also be better than a classic GTK tooltip because docs can include images and screenshots. For example, many Japanese language learners have never seen a standard JIS Japanese keyboard. A small photo displaying special keys with explanations would be helpful. (It may also be helpful to native Japanese speakers who are learning to use a JIS Japanese keyboard!)
Please let me know your thoughts. I am happy to contribute a patch, and write some of the Wiki help page.