Skip to content

Add Shughni language#4023

Open
sharukhhhan wants to merge 2 commits into
keymanapp:masterfrom
sharukhhhan:feat/add-shughni-language
Open

Add Shughni language#4023
sharukhhhan wants to merge 2 commits into
keymanapp:masterfrom
sharukhhhan:feat/add-shughni-language

Conversation

@sharukhhhan

@sharukhhhan sharukhhhan commented Jun 11, 2026

Copy link
Copy Markdown

This pull request is for adding the Shughni language (one of the Pamiri ones) to the Keyman database of languages

@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.

@sharukhhhan

Copy link
Copy Markdown
Author

Ready for review

@LornaSIL

Copy link
Copy Markdown
Contributor

Thanks for your Pull Request. I do have some things that need fixing up before we can accept it.

  • We need a copyright holder. That needs to be added in various places, the LICENSE.md, shughni.kmn, shughni.kps are essential, but anywhere else you've included a copyright where it's empty should be deleted or add the copyright holder. If you do not wish to be the copyright holder, you may assign the copyright to SIL Global.
  • The name of the language has various spellings in your documents. It would be good to standardize on "Shughni".
  • The shughni.kvks file is empty.
    • You can go to the .kmn and select the On-Screen tab and select Auto-fill underlying layer (bottom right) and then click on Fill from Layout (top left). That way the On-Screen keyboard will function.
    • I was surprised that the desktop keyboard has no rules for all the special keys you have in the touch layout. So, it seems the desktop will not be useful to your users. You should add the rules for special characters to the desktop keyboard as well. We expect the character repertoire to match between desktop and mobile.
  • In the .kps file
    • the language tag should be sgh-Latn. sgh represents using Shughni with Cyrillic script.
    • You can remove shughni-keyman-touch-layout from the list of files in the .kps. That is the source file but we don't need it distributed through the .kps. The shughni.js file is the compiled version.
  • We really like any keyboard that is in the release folder to have graphics in the welcome.htm or else document what keystrokes to use. You can export from the On-Screen keyboard graphics. Click on Export, select Save As png, and have it put the graphic in the same folder as the welcome.htm file. Then, edit the welcome.htm file to use the graphics. (Wait to do this until you've added the rules for the special characters.
  • Any keyboard in release also needs an online help file.
    • Create a help folder within source.
    • Create a file in the help folder called shughni.php
    • Add the following text to the shughni.php file
<?php
	$pagename = 'Shughni Keyboard Help' ;
	$pagetitle = $pagename ;
	// Header we will tidy up later
	require_once( 'header.php' ) ;
?>

<p>
	This keyboard is designed for the Shughni language, using the Latin script.
</p>

<h2>Desktop Keyboard Layout</h2>
<div id='osk' data-states='default shift'>
</div>

<h2>Phone Keyboard Layout</h2>
<div id='osk-phone' data-states='default shift numeric'>
</div>

When you add the desktop rules, we may have to modify what is included here.

I know this is a lot. But, for a first time contributor I'm very please that all the files are in the right place!

@LornaSIL

LornaSIL commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

@sharukhhhan do you need help with this pull request?

@sharukhhhan

Copy link
Copy Markdown
Author

Hi @LornaSIL!
Sorry, been out of work place for some time. Now I am here and looking forward to your any further feedback!

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