mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-04 16:05:31 +00:00
Page:
Home
Pages
ANSI Keyboard Scancodes, Keycodes and Virtual Key Visual Layout for Windows, MacOS, Linux
Analyse Unicode Output of Installed Desktop Keyboards
Backspace and cluster deletion
Capture Firefox log and Mozilla bisection
Coding with Cpp: Linker complains about missing global variable
Crowdin CLI
Debugging WASM code
Delphi Debugging Notes
Desktop app compatibility tests
Developers ‐ websites ‐ setting up xdebug for profiling
Diagnosing deployment failures for keyboards
Epic feature branches
FAQ: Why do we not have a forward‐looking context?
HOWTO: cleanup if a release build trigger fails
Home
How to downgrade to latest stable version of Keyman for Linux
How to fully uninstall and remove Keyman for Linux
How to install IBus and Keyman on Arch Linux and derivatives
How to install nightly packages of Keyman for Linux
How to resolve failed release build trigger
How to setup conventional commits git commit msg hook
How to test artifacts from pull requests for Keyman for Linux
How to uninstall Keyman for macOS for testing
How to upload libcef.dll.pdb symbols to downloads.keyman.com for a new CEF build
Internal APIs for Web's app‐browser artifact
KMP Metadata File (kmp.inf and kmp.json)
Keyboard Processor API reference
Keyboard bundles build on demand
Keyman 13.0 to 14.0 Migration
Keyman 15.0 New Functionality
Keyman 16.0 Release Notes
Keyman 17.0 Release Notes
Keyman 18.0 Release Notes
Keyman 19.0 Release Notes
Keyman Code Style Guide
Keyman Developer testing page (Web and Mobile Targets)
Keyman Glossary ‐ Windows Platform
Keyman Glossary
Keyman Keyboard Installation on Windows
Keyman Project Scopes
Keyman State Machine
Keyman Windows FAQs
Keyman for Linux serialized output notes
Linux Build Agent Setup
Making sense of the Windows Layout Registration
Mobile app compatibility tests
Mobile app ‐ app webview API
Monitoring Keyman Community Site and Social Pages
Notes on preparing history files
One way to refresh a long‐lived staging branch on keyboards (or any) repo
Permalinks for keyboards
Platform Acceptance Test for Android
Platform Acceptance Test for Developer
Platform Acceptance Test for Linux
Platform Acceptance Test for Mac
Platform Acceptance Test for Predictive‐Text
Platform Acceptance Test for Web
Platform Acceptance Test for Windows
Platform Acceptance Test for iOS
Principles of Keyman Code Changes
Profiling Keyman for Windows using VTune
Pull Request and Commit workflow notes
Release workflow
Re‐prioritizing issues
Sentry Windows integration TODO list
Sentry workflow
Setting up windbg for debugging Windows Developer
Shared infrastructure for Keyman sites
Unit Tests
Updating Desktop and Developer for Unicode Releases
User Testing Baseline Configurations
User Testing Workflows
Windows Build Agent Setup
[Deprecated] How to set up a local IIS web server for the Keyman web pages
api.keyman.com keyboard model package version API
downloads.keyman.com history API
downloads.keyman.com keyboard API
downloads.keyman.com model API
downloads.keyman.com version API
history.md format
iOS: manual symbolication
macOS Build Agent Setup
note(windows): kmtip and keyman32 interactions
s.keyman.com kmwversion API
No results
51
Home
rc-swag edited this page 2026-02-16 10:09:47 +10:00
Welcome to the keyman wiki! This wiki contains information for programmers and testers working on the Keyman project. For Keyman documentation, see https://help.keyman.com/
Some shortcuts to pages in this wiki:
API documentation
Glossary
Testing
- How to test artifacts from pull requests for Keyman for Linux
- How to downgrade to latest stable version of Keyman for Linux
- How to fully uninstall and remove Keyman for Linux
- How to uninstall Keyman for macOS for testing
User testing
Platform acceptance tests
Compatibility tests
Documentation for Developers
- Keyman Code Style Guide
- Keyman Project Scopes
- Principles of Keyman Code Changes
- Pull Request and Commit workflow notes
- User Testing
- Unit Test Files and Locations
Documentation should be found in the following four locations:
- Keyman repository /docs: preferred location for good quality notes; should be kept reasonably up-to-date (in Markdown).
- This Keyman wiki: rough notes (in Markdown)
- Help website: public-facing documentation, API documentation, etc. (Some in HTML, moving to Markdown)
- Google Drive: architecture, planning, and design docs, Google Docs and various formats. Generally these should move to Keyman Repository /docs as we implement.
Setup
- How to set up a local web server for the Keyman web pages
- How to setup conventional commits git commit msg hook
- Linux Build Agent Setup
- macOS Build Agent Setup
- Windows Build Agent Setup
Troubleshooting/Debugging
- Crowdin CLI
- Making sense of the Windows Layout Registration
- Keyman Keyboard Installation on Windows
- kmtip and keyman32 interactions
- Delphi Debugging kmshell
- Test Installed desktop Keyboards with Keyman Developer Test Page -including TSF
- Keyman for Windows architecture FAQs
- Keyman keyboard with"application" mangles output(cluster deletion)
- Capture Firefox log and Mozilla bicection
- Coding with Cpp: Linker complains about missing global variable
Workflow
- Notes on preparing history files
- Release workflow
- Sentry workflow
- Updating Desktop and Developer for Unicode Releases
- Monitoring Keyman Community Site and Social Pages
Release Notes
- Keyman 19.0 Release Notes
- Keyman 18.0 Release Notes
- Keyman 17.0 Release Notes
- Keyman 16.0 Release Notes
- Keyman 15.0 New Functionality
- Keyman 13.0 to 14.0 Migration