Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(developer): Add kmc module to generate help documentation charts of all "gesture" keys #11792

Open
5 tasks
darcywong00 opened this issue Jun 15, 2024 · 0 comments

Comments

@darcywong00
Copy link
Contributor

darcywong00 commented Jun 15, 2024

To address keymanapp/keyboards#2213, a prototype was started in keymanapp/keyboards#2594

I'll recap the review comments from the PR here:

  • move the tool from keymanapp/gestureChart to keymanapp/keyman, and ideally we will integrate this into kmc as a kmc module. Then we could merge it in 18.0.
  • TouchLayoutFileReader should be used to read the keyman touch layout file because that does validation and normalization of content
  • For handling vertical line character, we want to use escapeMarkdownChar function in Developer
  • Can cleanup console warnings about not handling T_ keys in the touch layout (not needed) 🔗 chore: Ignore T_ keys gestureChart#1
  • 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).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

2 participants