From 7f83732dff3df64bb5907f76a49d6e889ac4eede Mon Sep 17 00:00:00 2001 From: Witalij Berdinskich Date: Sun, 19 Feb 2023 16:30:01 +0000 Subject: [PATCH] Initial commit --- .gitignore | 2 + LICENSE | 201 ++++++++++++++++++++++++++++++++++++++ NOTICE | 14 +++ changelog.md | 8 ++ contributing.md | 30 ++++++ linux/xkb/symbols/latynka | 77 +++++++++++++++ readme.md | 99 +++++++++++++++++++ 7 files changed, 431 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 NOTICE create mode 100644 changelog.md create mode 100644 contributing.md create mode 100644 linux/xkb/symbols/latynka create mode 100644 readme.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f54eb28 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*~ +\#*# diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4c4fea4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2023 Witalij Berdinskich + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..e2798cd --- /dev/null +++ b/NOTICE @@ -0,0 +1,14 @@ +latynka-kbd +Copyright 2023 Witalij Berdinskich + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/changelog.md b/changelog.md new file mode 100644 index 0000000..715c79e --- /dev/null +++ b/changelog.md @@ -0,0 +1,8 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] \ No newline at end of file diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..138398c --- /dev/null +++ b/contributing.md @@ -0,0 +1,30 @@ +# Contributing to The Ukrainian Latin keyboard + +**The Ukrainian Latin keyboard** is an open-source project and all contributions are welcome to assist with its +development and maintenance. + +## Issues (bug and feature tracker) + +Please report any bugs found, feature requests or other issues on +**Ukrainian Latynka keyboard** [GitLab tracker][gitlab-issues] +or [GitHub tracker][github-issues]. + +When creating a new issue, try following [necolas's guidelines][issue-guidelines]. + +## Fork, patch and contribute code + +Feel free to fork **Ukrainian Latynka keyboard**'s repository at [GitLab][bot-gitlab] +or [GitHub][bot-github] for your own use and updates. + +Contribute your fixes and new features back to the main codebase using +[GitLab merge requests][gitlab-merge-requests] +and [GitHub pull requests][github-pull-requests]. + +[gitlab-issues]: https://gitlab.com/radio_rogal/latynka-kbd/-/issues +[github-issues]: https://github.com/radio-rogal/latynka-kbd/issues +[issue-guidelines]: http://github.com/necolas/issue-guidelines/#readme +[bot-gitlab]: https://gitlab.com/radio_rogal/latynka-kbd/ +[bot-github]: https://github.com/radio-rogal/latynka-kbd/ +[gitlab-merge-requests]: https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html +[github-pull-requests]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request + diff --git a/linux/xkb/symbols/latynka b/linux/xkb/symbols/latynka new file mode 100644 index 0000000..0405963 --- /dev/null +++ b/linux/xkb/symbols/latynka @@ -0,0 +1,77 @@ +// Witalij Berdinskich + +default partial alphanumeric_keys +xkb_symbols "latynka" { + + // Based on latynka of Maxym Prudeus, see https://cutt.ly/latynka + + include "us" + + name[Group1]= "Ukrainian (latynka)"; + + key {[ apostrophe, asciitilde, grave ]}; // ' ~ ` + key {[ NoSymbol, numerosign, numbersign, section ]}; // № # § + key {[ NoSymbol, U20B4, dollar, sterling ]}; // ₴ $ £ + key {[ NoSymbol, NoSymbol, NoSymbol, degree ]}; // € ° + key {[ NoSymbol, NoSymbol, endash, emdash ]}; // – — + key {[ NoSymbol, NoSymbol, notequal, plusminus ]}; // ≠ ± + key {[ gcircumflex, Gcircumflex, q, Q ]}; // ĝ Ĝ q Q + key {[ scaron, Scaron, w, W ]}; // š Š w W + key {[ NoSymbol, NoSymbol, registered, U20B9 ]}; // ® ₹ + key {[ NoSymbol, NoSymbol, trademark ]}; // ™ + key {[ NoSymbol, NoSymbol, yen ]}; // ¥ + key {[ NoSymbol, NoSymbol, U20BA, U20AA ]}; // ₺ ₪ + key {[ ccaron, Ccaron ]}; // č Č + key {[ NoSymbol, NoSymbol, doublelowquotemark, leftdoublequotemark ]}; // „ “ + key {[ zcaron, Zcaron, x, X ]}; // ž Ž x X + key {[ NoSymbol, NoSymbol, copyright, currency ]}; // © ¤ + key {[ NoSymbol, semicolon, guillemotleft, less ]}; // ; « < + key {[ NoSymbol, colon, guillemotright, greater ]}; // : » > + key {[ NoSymbol, NoSymbol, ellipsis ]}; // … + key {[ space, space, nobreakspace, nobreakspace ]}; + + include "kpdl(comma)" + + include "eurosign(5)" + + include "eurosign(e)" + + include "level3(ralt_switch)" + +}; + +partial alphanumeric_keys +xkb_symbols "coder" { + + // Programmer keyboard. Based on the US layout with accented Ukrainian letters. + + include "us" + + name[Group1]= "Ukrainian (latynka, coder)"; + + key {[ NoSymbol, NoSymbol, numerosign, section ]}; // № § + key {[ NoSymbol, NoSymbol, U20B4, sterling ]}; // ₴ £ + key {[ NoSymbol, NoSymbol, NoSymbol, degree ]}; // € ° + key {[ NoSymbol, NoSymbol, endash, emdash ]}; // – — + key {[ NoSymbol, NoSymbol, U20B9 ]}; // ₹ + key {[ NoSymbol, NoSymbol, scaron, Scaron ]}; // š Š + key {[ NoSymbol, NoSymbol, gcircumflex, Gcircumflex ]}; // ĝ Ĝ + key {[ NoSymbol, NoSymbol, yen ]}; // ¥ + key {[ NoSymbol, NoSymbol, U20BA, U20AA ]}; // ₺ ₪ + key {[ NoSymbol, NoSymbol, doublelowquotemark, leftdoublequotemark ]}; // „ “ + key {[ NoSymbol, NoSymbol, zcaron, Zcaron ]}; // ž Ž + key {[ NoSymbol, NoSymbol, ccaron, Ccaron ]}; // č Č + key {[ NoSymbol, NoSymbol, guillemotleft ]}; // « + key {[ NoSymbol, NoSymbol, guillemotright ]}; // » + key {[ NoSymbol, NoSymbol, ellipsis ]}; // … + key {[ space, space, nobreakspace, nobreakspace ]}; + + include "kpdl(dot)" + + include "eurosign(5)" + + include "eurosign(e)" + + include "level3(ralt_switch)" + +}; diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..618123c --- /dev/null +++ b/readme.md @@ -0,0 +1,99 @@ +# The Ukrainian Latin keyboard + +This is a keyboard to implement the Ukrainian Latin alphabet. + +First and default keymap is proposed by Maxym Prudeus, further watch in [Ukrainian Latynka (Latin alphabet): all the "pros" and "cons"][latynka]. + +``` +┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┲━━━━━━━━━┓ +│ ~ │ ! │ " │ № § │ ₴ £ │ % ° │ ^ │ & │ * │ ( ̣ │ ) │ _ — │ + ± ┃ ⌫ Back ┃ +│ ' ` │ 1 │ 2 @ │ 3 # │ 4 $ │ 5 € │ 6 │ 7 │ 8 │ 9 │ 0 │ - – │ = ≠ ┃ space ┃ +┢━━━━━┷━┱───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┺━┳━━━━━━━┫ +┃ ┃ Ĝ Q │ Š W │ E │ R ₹ │ T │ Y │ U │ I │ O │ P │ { │ } ┃ Enter ┃ +┃Tab ↹ ┃ ĝ q │ š w │ e € │ r ® │ t ™ │ y ¥ │ u │ i │ o │ p │ [ │ ] ┃ ⏎ ┃ +┣━━━━━━━┻┱────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┺┓ ┃ +┃ ┃ A │ S │ D │ F │ G │ H │ J │ K │ L ₪ │ Č │ " “ │ | ┃ ┃ +┃Caps ⇬ ┃ a │ s │ d │ f │ g │ h │ j │ k │ l ₺ │ č │ ' „ │ \ ┃ ┃ +┣━━━━━━━━┹────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┲┷━━━━━┻━━━━━━┫ +┃ │ Z │ Ž X │ C ¤ │ V │ B │ N │ M │ ; < │ : > │ ? ┃ ┃ +┃Shift ⇧ │ z │ ž x │ c © │ v │ b │ n │ m │ , « │ . » │ / … ┃Shift ⇧ ┃ +┣━━━━━━━┳━━━━━┷━┳━━━┷━━━┱─┴─────┴─────┴─────┴─────┴─────┴───┲━┷━━━━━╈━━━━━┻━┳━━━━━━━┳━━━┛ +┃ ┃ ┃ ┃ ␣ ⍽ ┃ ┃ ┃ ┃ +┃Ctrl ┃Meta ┃Alt ┃ ␣ Space ⍽ ┃AltGr ⇮┃Menu ┃Ctrl ┃ +┗━━━━━━━┻━━━━━━━┻━━━━━━━┹───────────────────────────────────┺━━━━━━━┻━━━━━━━┻━━━━━━━┛ +``` + +Second keymap is based on 'us' with accented Ukrainian letters. This keymap is named `coder` and suitable for programmers. + +``` +┌─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┬─────┲━━━━━━━━━┓ +│ ~ │ ! │ " │ # § │ $ £ │ % ° │ ^ │ & │ * │ ( ̣ │ ) │ _ — │ + ┃ ⌫ Back ┃ +│ ` │ 1 │ 2 @ │ 3 № │ 4 ₴ │ 5 € │ 6 │ 7 │ 8 │ 9 │ 0 │ - – │ = ┃ space ┃ +┢━━━━━┷━┱───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┴─┬───┺━┳━━━━━━━┫ +┃ ┃ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ { │ } ┃ Enter ┃ +┃Tab ↹ ┃ q │ w │ e € │ r ₹ │ t │ y ¥ │ u │ i │ o │ p │ [ │ ] ┃ ⏎ ┃ +┣━━━━━━━┻┱────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┴┬────┺┓ ┃ +┃ ┃ A │ S Š │ D │ F │ G Ĝ │ H │ J │ K │ L ₪ │ : │ " “ │ | ┃ ┃ +┃Caps ⇬ ┃ a │ s š │ d │ f │ g ĝ │ h │ j │ k │ l ₺ │ ; │ ' „ │ \ ┃ ┃ +┣━━━━━━━━┹────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┬┴────┲┷━━━━━┻━━━━━━┫ +┃ │ Z Ž │ X │ C Č │ V │ B │ N │ M │ < │ > │ ? ┃ ┃ +┃Shift ⇧ │ z ž │ x │ c č │ v │ b │ n │ m │ , « │ . » │ / … ┃Shift ⇧ ┃ +┣━━━━━━━┳━━━━━┷━┳━━━┷━━━┱─┴─────┴─────┴─────┴─────┴─────┴───┲━┷━━━━━╈━━━━━┻━┳━━━━━━━┳━━━┛ +┃ ┃ ┃ ┃ ␣ ⍽ ┃ ┃ ┃ ┃ +┃Ctrl ┃Meta ┃Alt ┃ ␣ Space ⍽ ┃AltGr ⇮┃Menu ┃Ctrl ┃ +┗━━━━━━━┻━━━━━━━┻━━━━━━━┹───────────────────────────────────┺━━━━━━━┻━━━━━━━┻━━━━━━━┛ +``` + +## Installation + +### Arch/Manjaro Linux + +To install from **AUR** run + +```bash +paru -S latynka-kbd +``` + +or use your favorite helper with the [latynka-kbd][latynka-kbd-aur] package. + +### macOS + +TODO: Describe the installation process + +## Usage + +The `latynka-kbd` is not a part of [xkeyboard-config][]: you cannot use `localectl`. But you can use `setxkbmap` or configure it manually. + +Some examples: + +### Sway + +``` +input * { + xkb_layout "latynka,ua,latynka" + xkb_variant "coder,unicode," + xkb_options "grp:win_space_toggle" + xkb_model "pc105" +} +``` + +## Contributing + +Please read [Contributing](contributing.md) for details on our code of conduct, and the process for submitting pull requests to us. + +## History + +See [ChangeLog](changelog.md) + +## Credits + +TODO: Write credits + +## License + +[Apache License v2.0](LICENSE) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0.html) + +[latynka]: https://cutt.ly/latynka "Українська латинка: усі \"за\" та \"проти\" | Кирилиця чи латиниця | Абетка та розкладка клавіатури" +[latynka-kbd-aur]: https://aur.archlinux.org/packages/latynka-kbd +[xkeyboard-config]: https://github.com/freedesktop/xkeyboard-config "X Keyboard Extension" \ No newline at end of file