Skip to content

My Hebrew Keyboard Layout - #4117

Open
CalebDHughes wants to merge 4 commits into
keymanapp:masterfrom
CalebDHughes:master
Open

CalebDHughes wants to merge 4 commits into
keymanapp:masterfrom
CalebDHughes:master

Conversation

@CalebDHughes

@CalebDHughes CalebDHughes commented Sep 5, 2026

Copy link
Copy Markdown

Attached in the Word Document is a layout of my Hebrew keyboard. In this Hebrew keyboard layout Hebrew letters appear under the English letters that make the same sound.

I plan to continue to update this keyboard as I learn more Hebrew. Please contact me for any suggestions on how I can further modify this keyboard layout.

Hebrew Keyboard Layout (1).docx

Add my hebrew layout
@keyman-server

Copy link
Copy Markdown
Collaborator

Thank you for your pull request. You'll see a "build failed" message until the Keyman team has reviewed the pull request and manually initiated the build process.

Every change committed to this branch will become part of this pull request. When you have finished submitting files and are ready for the Keyman team to review this pull request, please post a "Ready for review" comment.

@CalebDHughes

Copy link
Copy Markdown
Author

Ready for review

@LornaSIL

LornaSIL commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Thanks for your submission! I'll be submitting a whole lot of comments since this is your first pull request. Don't be discouraged.

  • Since the keyboard is obviously a work in progress I would like it to be moved to experimental/h rather than release/h
  • Again, because it's a work in progress, I prefer you not to use the ID of hebrew since that would indicate to people that is a recommended keyboard, and also, since we have a lot of Hebrew keyboards it would be good to call it something more distinguishable so people can easily choose. It seems you are developing this for your own use. I think the folder name and filenames should be something like hebrew_comprehensive or something like that. Then you'll need to change all the references to files called hebrew.* to hebrew_comprehensive.*.
  • In the root folder, the LICENSE.md must include a copyright line. Our structure won't build without that. The file could have:
The MIT License (MIT)

Copyright © 2026 Caleb D Hughes

Permission is hereby granted...

You need to give your name including last name.

  • In the .kmn
    • Call the keyboard something like "Hebrew Comprehensive", not "Hebrew - My version" which is obviously a name you were using while developing the keyboard.
    • Make sure to put "Caleb D Hughes", or whatever your copyright holder name is under the copyright field. Don't include the year this time though.
    • All the rules use CTRL or ALT. We find keyboards work better for uses to have the rules use RCTRL or LCTRL and RALT. Many applications have shortcut keys using CTRL and ALT and the keyboard will conflict with those shortcuts unless you change to using LCTRL and RALT. In addition, RALT works with macOS as AltGr, so that is a happier experience for those users.
    • On the touch layout, your shift state keys aren't going to the correct layer. For example, select K_SHIFT and off to the right, under Next layer you should have "Shift" selected. Do the same on the other layers. For some reason you have the ctrl and alt layers set correctly.
  • In the .kps
    • In the list of files, please remove hebrew.ico and hebrew.kmn. Those are source files which do not need to be distributed.
    • The name should be changed from "Hebrew" to "Hebrew Comprehensive" (or whatever name you end up choosing)
    • Make sure to include your copyright holder on the Details tab.
    • The description is a bit minimal. That will show up on the home page of the keyboard. It might be helpful to add more information so users will know if they want to use it.
    • Keyboards in experimental need much for documentation, but the minimal documentation you include will be acceptable for going into experimental.

I think that's it. I hope you are able to make these changes.

Renamed project to hebrew_comprehensive, updated LICENSE.md with copyright, fixed touch shift layers, and migrated modifiers to the visual keyboard file to keep the Design tab active.
Update README with user description and character layout tables
@CalebDHughes

Copy link
Copy Markdown
Author

Attached in the Word Document is a layout of my Hebrew keyboard. In this Hebrew keyboard layout Hebrew letters appear under the English letters that make the same sound.

I plan to continue to update this keyboard as I learn more Hebrew. Please contact me for any suggestions on how I can further modify this keyboard layout.

Update Notes:

  • Moved the layout folder track into experimental/h/hebrew_comprehensive.
  • Updated LICENSE.md with my complete copyright details (Caleb D Hughes).
  • Corrected the K_SHIFT touch layout target mappings to the shift layer.
  • Shifted desktop modifier rules to the visual keyboard framework to keep the graphic Design tab fully active.

Everything compiles successfully locally with zero warnings or errors. Ready for review!

Hebrew Keyboard Layout (2).docx

@LornaSIL

Copy link
Copy Markdown
Contributor

Can you rename the hebrew.kpj file to hebrew_comprehensive.kpj also?

  • Keyboards in release have a higher standard of documentation than ones in experimental. I see I didn't make that clear above. We'll require the welcome.htm to explain how to use the keyboard. You could include a graphic of the On-Screen keyboard layout which would be good documentation. (The Word file would not be acceptable documentation).
  • We'll also require an online help document if you keep the keyboard in release. An explanation of that is here: https://help.keyman.com/developer/keyboards/phphelpfile
  • We don't want any of the source files in the pull request. So, anything in the build folder should not be in the pull request. Also, the *.kmp is in the source folder and that should be removed.

Then I can check the keyboard.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants