feat: Add tool to generate gesture table #2594
Conversation
| text = id.substring(2); | ||
| } else { | ||
| text = `[${id}]`; | ||
| console.warn(`id ${id} doesn't start with U_`); |
There was a problem hiding this comment.
Looking up text from a [T_XXXX] key in the .js keyboard file is an extra complexity
There was a problem hiding this comment.
It's also not needed -- we don't support inferring text for T_ keys in the touch layout 😁 -- so this is the correct approach I think
There was a problem hiding this comment.
This is a useful tool. However, we don't want to start putting tooling into the keyboards repository, because this is really a Developer tool.
So, we need to move the tool to keymanapp/keyman, and ideally we will integrate this into kmc as a kmc module. Then we could merge it in 18.0.
If that sounds like too much work for now, then feel free to put it into its own repo -- just we shouldn't keep it in keyboards repo.
One other challenge is that while this tool generates Markdown, we don't currently support Markdown in keyboard documentation welcome.htm, which is where this content belongs (not just on help.keyman.com).
The whole Markdown documentation proposal can be followed in keymanapp/keyman#9477
| if (key.text.startsWith('|')) { | ||
| // Handle vertical line character | ||
| text += key.text.replaceAll('|', '|'); |
There was a problem hiding this comment.
This will not work with x| or things like that. Nor |*. We need to do replacements on the whole string. There's actually a escapeMarkdownChar function in Developer which should do what is needed:
| text = id.substring(2); | ||
| } else { | ||
| text = `[${id}]`; | ||
| console.warn(`id ${id} doesn't start with U_`); |
There was a problem hiding this comment.
It's also not needed -- we don't support inferring text for T_ keys in the touch layout 😁 -- so this is the correct approach I think
|
One other small note, if we do move to keyman repo, then |
Understood. For now, I'll move this to its own repo (so I can continue to use on an individual keyboard basis). |
|
This is moved to a separate repo (keymanapp/gestureChart) and comments to be resolved in keymanapp/keyman#10965 |
|
Sounds great! I like this tool, and it's going to be helpful in our updated documentation approach in the future too |
Addresses #2213
This adds a gestureChart tool to document gestures in a touch layout as a Markdown table. Future TODO is incorporating the Markdown table into the welcome.htm / .php help docs. If we sync the .md file along with the .php help, the site could render it as
As of 17.0, gestures can be:
Usage
Sample outputs:
Current sil_ipa gestures (on master)
sil_ipa-tablet (current).md
sil_ipa incorporating gestures from #2521
sil_ipa-tablet.md
rawang from #2554
rawang-tablet.md