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

[Old Uyghur] Initial submission of oui_ougr_143 keyboard #3104

Merged
merged 3 commits into from
Sep 24, 2024

Conversation

AmacsizBirKisi
Copy link
Contributor

Old Uyghur Keyboard using the Old Uyghur Abjad Script

@keyman-server
Copy link
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.

@LornaSIL
Copy link
Contributor

Thanks for your keyboard submission! It will be great to have an Old Uyghur keyboard in the repo. I will have a lot of feedback since this is your first submission. Please don't be discouraged. We want to have keyboards that are really useful and I think the changes I ask for will be helpful to keyboard users.

  • The copyright holder is not consistent. In various places it says abKAA© which doesn't seem like a valid copyright holder. In readme.htm it says Kadir Garip. That sounds like a more valid copyright name. Can you change it to the correct copyright holder in all of the following files:
    • LICENSE.md
    • oui_ougr_143.kmn
    • oui_ougr_143.kps (on the Details tab)
    • readme.htm (if that one is not accurate either)
  • In the .kmn file:
    • the name of the keyboard will not be understandable if someone doesn't have an appropriate font (I see square boxes). It might be best to include "Old Uyghur" in the keyboard name.
    • You are using the ALT key which is fine. However, I think people would have a better experience if you use RALT instead. Many computers will use ALT+c or ALT+v to copy and paste, etc. If you define your rules as RALT instead, they can continue to use those keyboard shortcuts. You would have to regenerate your On-Screen keyboard if you change the rules.
    • On the On-Screen keyboard I just see square boxes. I had to assign "Noto Serif Old Uyghur" in the Keyboard / Fonts dialog:
      image
    • Even then, there are square boxes on the shift layer because you are trying to support both Old Uyghur and some unusual Latin characters. It is unlikely that you would find a font that supports both. It would be best to just try to support the Old Uyghur script rather than trying to support a Latin orthography at the same time.
    • For the touch layout, the same issues with font are there. In addition, there are some issues with accessing the layers. You'll need to select the "Shift" key and then set "Next Layer" or the user won't be able to access the next layer. You'll need to do that for all of the Shift states.
  • In the .kps file you would be wise to add the "Noto Serif Old Uyghur" font to the list of files. If you have the keymanapp/keyboards repo cloned, you will find the font We have that font here: keyboards\release\shared\fonts\noto\Ougr
    • Then, on the Keyboards tab you should select the font under Keyboard font AND under Display font.
    • Under the Details tab you should change the name of the keyboard to something like "Old Uyghur" or whatever you chose for the .kmn name
    • Under Welcome file select welcome.htm
    • Please do fix the copyright and author. If you do not wish to include an author, that can be blank, but copyright cannot be blank.
  • In the welcome file we would recommend including more documentation on the keyboard layout. Usually people will go to the .kmn file, go to On screen, and click on Export. That allows you to include a graphic of the keyboard layout in the documentation. You would then need to include the graphic(s) in the welcome file. You would also need to include the graphic in the list of files in the .kps.

I have only done minimal testing of the keyboard. If you can address the above issues then I can check it again. Thanks!

@LornaSIL
Copy link
Contributor

Thanks for these updates. Some more comments.

  • The welcome.htm file is good.
  • The image.html file doesn't seem to contribute anything. You could delete it, but be very careful that the folder image_files does not get deleted. Then, remove image.html from the list of files in the .kps
  • You've listed image.html in the Details/Image file slot. That should actually be a graphic image if you want one. Some people want to include a special graphic to represent their company. If you don't want one, you can leave that blank. It needs to be a specific size. I think it should be 140x250. If you leave it blank it will be the Keyman banner.
    An example of where that image would be used is when you double-click on a .kmp you see this (the left Keyman image):

image

Somebody else wanted their own banner:
image

  • In the .kps file under Files you will need to add all the graphics from the image_files folder. That way the design of the keyboard will display properly.
  • Also in the .kps, under Details consider changing the name to "Old Uyghur" the way you did in the .kmn file:

image

  • About versioning, you don't need to bump the version every time you make a change on your computer. You can just bump the version when you submit a new PR. If we haven't accepted the PR yet, you can just leave the version the same.

  • On the touch layout,

    • On the default layer, you should select the Shift key and on Next Layout select shift instead of none. Also, you should change the ID from K_0 back to K_SHIFT.
    • On the shift layer, you should select the Shift key and on Next Layout select default instead of none.
    • On the alt layer, you should select the Shift key and on Next Layout select shift instead of none.
    • The Alt key always seems to be set correctly.
      touch
  • I have another question about the rules in your keyboard. You have a lot of rules outputting a space character. For example:
    + [K_I] > ' '
    Do you really wish to output a space? If you don't, you could write the rule like this:
    + [K_I] > nul
    And it wouldn't output anything. But, since I'm not familiar with Old Uyghur I don't know if this is what you want or not.

Thanks for fixing all the issues I mentioned yesterday!

@AmacsizBirKisi
Copy link
Contributor Author

AmacsizBirKisi commented Sep 22, 2024 via email

@LornaSIL
Copy link
Contributor

I'm also a little concerned about the use of the region code in both the BCP 47 tag and in the name of the keyboard. 143 seems to be for Moldova. Is that really what is wanted? The minimal tag could easily just be oui without a script or a region code. Normally a keyboard would be named something like old_uyghur as the ID and "Old Uyghur" for the name of the keyboard with a BCP 47 code of oui. Apparently ybe West Yugur also used the script so you could add ybe-Ougr to the list of languages the keyboard supports. That another reason we tend not to use IDs for the language tag because often the keyboard will support multiple languages.

If all of this is too much change, and if you are in agreement, I can take what you've done and do the final changing of the name and BCP47 codes on your behalf. You would still be the author.

@AmacsizBirKisi
Copy link
Contributor Author

AmacsizBirKisi commented Sep 24, 2024 via email

@LornaSIL
Copy link
Contributor

143 seems to be for Moldova.

Yes, you are right, it is for Central Asia. My google search was apparently for some other code, maybe telephone. Anyway, irrelevant.

I would still like to make the changes I was recommending. I'll let you know how it goes and if I have questions.

My first question is, are you saying this keyboard would not be suitable for ybe (West Yugur)?

@AmacsizBirKisi
Copy link
Contributor Author

AmacsizBirKisi commented Sep 24, 2024 via email

@LornaSIL LornaSIL merged commit 8bd91fd into keymanapp:master Sep 24, 2024
1 of 2 checks passed
@LornaSIL
Copy link
Contributor

The keyboard is now available online: https://keyman.com/keyboards/old_uyghur

I did not include the spreadsheets in the package, but I left them in the repo. We don't usually include that kind of file in a keyboard package.

Thanks for helping support this script!

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