Skip to content

tfnalgonquin keyboard (Timiskaming First Nation - Algonquin)#3786

Merged
LornaSIL merged 25 commits into
keymanapp:masterfrom
thohahente:master
Nov 20, 2025
Merged

tfnalgonquin keyboard (Timiskaming First Nation - Algonquin)#3786
LornaSIL merged 25 commits into
keymanapp:masterfrom
thohahente:master

Conversation

@thohahente
Copy link
Copy Markdown
Contributor

This pull request adds the tfnalgonquin keyboard for the Algonquin language (Temiskaming First Nation).

• Keyboard ID: tfnalgonquin
• Language: Algonquin (ISO 639-3: alq)
• Created by Temiskaming First Nation
• Version: 1.1 (initial internal version 1.0 created 2025-06-12)
• License: MIT (LICENSE.md included)

The keyboard supports:
Windows, macOS, Linux, Web, iPhone, iPad, Android phone/tablet, mobile, desktop.

Algonquin language keyboard for the distinct variety of Algonquins of Temiskaming First Nation
@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.

@thohahente
Copy link
Copy Markdown
Contributor Author

Ready for review

@LornaSIL
Copy link
Copy Markdown
Contributor

Thanks for your submission!
I haven't tested the keyboard yet, but we'll need some changes made first. Our build system requires a very strict file structure. Right now all your files are in release\t. You should:

  • Create a folder within t called tfnalgonquin so you'll end up with release\t\tfnalgonquin
  • Copy all your files into that folder.
  • Then create a source folder and copy all the files EXCEPT for the following into the source folder
    • HISTORY.md
    • LICENSE.md
    • README.md
    • I don't see a tfnalgonquin.kpj file. You'll need that file to be added.
  • In the end you should have:
release\t\tfnalgonquin\HISTORY.md
release\t\tfnalgonquin\README.md
release\t\tfnalgonquin\LICENSE.md
release\t\tfnalgonquin\tfnalgonquin.kpj
release\t\tfnalgonquin\source\tfnalgonquin.kmn
release\t\tfnalgonquin\source\tfnalgonquin.kvks
release\t\tfnalgonquin\source\tfnalgonquin.kps
release\t\tfnalgonquin\source\tfnalgonquin.keyman-touch-layout
release\t\tfnalgonquin\source\welcome.htm
release\t\tfnalgonquin\source\readme.htm
release\t\tfnalgonquin\source\atfn_logo_1.png
  • In LICENSE.md the year should just be 2025. We don't want to go into the future until the future is here. Next time you update the keyboard you would extend the dates to that year.
    • You can delete the copyright years everywhere else: in the .kmn and .kps.
  • You can delete tfnalgonquin-help.htm since it's an empty file.
    • Delete the reference to that file in tfnalgonquin.kmn AND in tfnalgonquin.kps
  • In the .kps file we expect a description of the keyboard. That's on the Details tab. That information will show up on the home page of the keyboard. At a minimum you could say: "Keyboard for the Algonquin language."
  • For any keyboard in the release stream we expect some documentation in the welcome.htm file. At a minimum you could add a paragraph that says: "This keyboard package has an On-Screen keyboard which shows which keys to access. For example, pressing the el key produces ō."
  • We also require a help file which is used in our online help. You should:
    • Create a help folder within source. And create a file called tfnalgonquin.php. You'll end up with this:
    • release\t\tfnalgonquin\source\help\tfnalgonquin.php
    • Open that file and paste the following text in it:
<?php 
  $pagename = 'TFN Algonquin Keyboard Help';
  $pagetitle = $pagename;
  require_once('header.php');
?>
<p>Keyboard for the Algonquin language.</p>

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

If you don't want to update the documentation, we would be willing to accept the keyboard in the experimental section. However, all the other structural changes must still be made.

Thanks. Hope it's not too confusing.

Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Remove old tfnalgonquin layout
Add final tfnalgonquin keyboard folder structure per SIL reviewal tfnalgonquin keyboard folder structure per SIL review
@thohahente
Copy link
Copy Markdown
Contributor Author

All requested changes have been implemented.

  • Correct folder structure (release/t/tfnalgonquin)
  • Added source/ with required files
  • Added help/tfnalgonquin.php
  • Fixed LICENSE year
  • Removed empty tfnalgonquin-help.htm and references
  • Updated welcome.htm and readme.htm
  • Added correct .kpj file
  • Cleaned copyright metadata

Ready for re-review.

@thohahente
Copy link
Copy Markdown
Contributor Author

Ready for Review

@LornaSIL
Copy link
Copy Markdown
Contributor

  • Could you rename this image keyboard small.png to use an underscore and not a space? You'll then need to update the references in the welcome.htm and in the .kps
  • Could you move this image atfn_logo_1.png to the sources folder? You'll then need to update the reference in the .kps

After that I'll test the keyboard

Post review edit to fix reference to  keyboard_small.png
…in/source/atfn_logo_1.png

Move atfn_logo_1.png into source/
I’ve updated the .kps file for correct relative paths and removed the old tfnalgonquin-help.htm reference. There is no reference to keyboard_small.png in the .kps.
@thohahente
Copy link
Copy Markdown
Contributor Author

Ready for Review

Remove parenthetical comment.
Change target to `any`
Include graphics for welcome.htm
Fix h1 and paragraphs and add graphics
Change so different layers are accessible.
Copy link
Copy Markdown
Contributor

@LornaSIL LornaSIL left a comment

Choose a reason for hiding this comment

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

I did make some changes, so you should pull the current files before you begin updating the keyboard again.
Otherwise, LGTM.

@LornaSIL LornaSIL merged commit c07fcf1 into keymanapp:master Nov 20, 2025
2 checks passed
@thohahente
Copy link
Copy Markdown
Contributor Author

Niá:wen kówa. I appreciate the help to get the premier release up and available to the Temiskaming community.

@thohahente thohahente changed the title tfnalgonquin keyboard (Temiskaming First Nation - Algonquin) tfnalgonquin keyboard (Timiskaming First Nation - Algonquin) Nov 20, 2025
@thohahente
Copy link
Copy Markdown
Contributor Author

ready for review

@LornaSIL
Copy link
Copy Markdown
Contributor

LornaSIL commented Nov 24, 2025

ready for review

This PR was already merged.

@thohahente
Copy link
Copy Markdown
Contributor Author

thohahente commented Nov 24, 2025 via email

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