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

[sgaw_karen] Initial submission of sgaw_karen keyboard #2752

Open
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

Jcturner12
Copy link

No description provided.

@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

@LornaSIL
Copy link
Contributor

Thanks for your keyboard submission! There are a few things that need fixing up in the files.

  • In the sgaw_karen folder (the root), we need you to add the LICENSE.md, README.md, and HISTORY.md files. You can look at other keyboards to see what goes in those files. I would have expected them to be created at the same time you created the keyboard so maybe they are there and just didn't get committed.
  • In the source folder the sgaw_karen_final.kmn filename needs renamed to sgaw_karen.kmn.
  • In the source folder the sgaw_karen_final.kvks filename needs renamed to sgaw_karen.kvks.
  • In the source folder the sgaw_karen_final.keyman-touch-layout filename needs renamed to sgaw_karen.keyman-touch-layout.

Unfortunately, the references to these files will need fixing up in the .kmn file and the .kps files.

I see in the .kpj file references to the welcome.htm and readme.htm files. Those files and any associated graphics need to be committed as well. They also should be added to the files included in the .kps file.

Please do make sure your .kmn compiles AND the .kps compiles before recommitting. In the .kpj I can see that there are references to files that are not part of this pull request. The path seems like it's seeing other keyboards. Any other keyboard should not be associated with this keyboard.

@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

Copy link
Author

@Jcturner12 Jcturner12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made the requested changes. Please let me know if there is anything else I need to fix. Thanks!

@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

@LornaSIL LornaSIL added this to In progress in Keyboards May 17, 2024
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

@LornaSIL
Copy link
Contributor

Please delete

  • the build folder and all the files in the build folder from this Pull Request. Keyman does the build on our server so we only want the source files.
  • sgaw_karen_final.kmn
  • sgaw_karen_final.kvks
  • sgaw_karen_final.keyman-touch-layout

@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

@Jcturner12
Copy link
Author

Thanks for the information! We deleted the build folder as well as the 'final' files. Please let us know if there is anything else we need to change.

@LornaSIL
Copy link
Contributor

Thank you! At the moment we are now waiting for the Keyman 17 build system to be updated on here. At the point we may find a few more changes are needed, but until then we cannot accept any pull requests. We'll get to it as soon as we can.

@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

Delete unnecessary .user file.
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

@LornaSIL
Copy link
Contributor

We're ready to begin doing keyboard review again. Unfortunately, because of the changes to Keyman 17, we are requiring all new keyboards to follow the Keyman 17 conventions.
For you, this means:

  • You will need to use Keyman Developer 17.0
  • When you open the .kpj in Keyman Developer, agree to switch to the Keyman 17 format.
  • Include LICENSE.md in the .kps (on the Details tab.)
  • Include welcome.htm in the .kps (on the Details tab.)

In addition, there are other changes:

  • Make sure to add the version number of the keyboard to your .kmn file. HISTORY.md indicates this should be version 1.0.
  • Delete the version number (1.1) AND the copyright year (2024) from the README.md file. This will reduce the places you have to keep track of for the version number and copyright year.
  • In the .kps file you've chosen ksw-Kali-MM as the language tag which is for the Kayah Li script. However, the keyboard is not for Kayah Li, it is Myanmar. So, the language tag should be set to ksw instead. (That is the shortest language tag for ksw using the Myanmar script.)
  • Any keyboard that goes into our release section needs to have a help file.
    • Please create a folder called help within the source folder. You should then have release/s/sgaw_karen/source/help
    • Within the help folder create a file called sgaw_karen.php. Edit that file and put the following in the contents.
<?php 
  $pagename = '>ကညီကျိာ် S'gaw Karen Keyboard Help';
  $pagetitle = $pagename;
  require_once('header.php');
?>
<p>
    A Unicode keyboard for the S'gaw Karen language. 
</p>
<h2>Desktop Keyboard Layout</h2>
<div id='osk' data-states='default shift ctrl'>
</div>


I hope this will be straightforward for you. Thanks for your patience. The good news is once this is done, there are fewer places to maintain some of this information.

Remove copyright date and version number.
Add keyboard name to header.
Remove MIT info from copyright.
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

1 similar comment
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

Add version number to .kmn
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

Keyboard currently only supports desktop and web. Not mobile, so I changed `any` to `web desktop`.
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

1 similar comment
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

Change target back to `any` and add the header statement to include the touch layout.
Add actions to shift state so it will change layers.
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

Add `.js` file back into list of files since I found the mobile layout.
@keyman-server
Copy link
Collaborator

Thank you for your pull request. The Keyman keyboard review team have been notified of your pull request and will review it and build it shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Keyboards
  
In progress
Development

Successfully merging this pull request may close these issues.

None yet

3 participants