Skip to content

docs(web): improve documentation on addKeyboards/addKeyboardsForLanguage#16020

Open
ermshiperete wants to merge 2 commits into
masterfrom
docs/web/addKeyboards
Open

docs(web): improve documentation on addKeyboards/addKeyboardsForLanguage#16020
ermshiperete wants to merge 2 commits into
masterfrom
docs/web/addKeyboards

Conversation

@ermshiperete
Copy link
Copy Markdown
Contributor

Also improve types on signature of those functions.

Fixes: keymanapp/help.keyman.com#365
Build-bot: skip build:web
Test-bot: skip

@keymanapp-test-bot
Copy link
Copy Markdown

keymanapp-test-bot Bot commented May 27, 2026

User Test Results

Test specification and instructions

User tests are not required

Test Artifacts

  • Web
    • KeymanWeb Test Home - build : all tests passed (no artifacts on BuildLevel "build")

@keymanapp-test-bot keymanapp-test-bot Bot added this to the A19S30 milestone May 27, 2026
@ermshiperete ermshiperete marked this pull request as draft May 27, 2026 17:51
There are multiple ways to add and install keyboards into your KeymanWeb installation.

## Directly linking a local copy
## Requesting from the Keyman cloud (CDN)
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I decided to change the order so that the simpler cases come first. This also matches the order of the parameter description in addKeyboards.md.

Comment thread web/docs/engine/guide/adding-keyboards.md Outdated
@ermshiperete ermshiperete force-pushed the docs/web/addKeyboards branch from 6aa831c to 45e48e1 Compare May 27, 2026 17:57
@ermshiperete ermshiperete changed the base branch from master to refactor/web/docs May 27, 2026 17:57
@ermshiperete ermshiperete marked this pull request as ready for review May 27, 2026 17:58
…nguage`

Also improve types on signature of those functions.

Fixes: keymanapp/help.keyman.com#365
Build-bot: skip build:web
Test-bot: skip
@ermshiperete ermshiperete force-pushed the docs/web/addKeyboards branch from 45e48e1 to 47ec50b Compare May 28, 2026 07:33
Comment on lines +47 to +49
await keyman.addKeyboards('@fr$');
// or
await keyman.addKeyboardsForLanguage('French$');
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Currently not working - see #16018

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If not working, should we remove from the active docs and leave it to re-add when #16018 is resolved?

Comment thread web/docs/engine/guide/adding-keyboards.md Outdated
Comment thread web/docs/engine/guide/adding-keyboards.md Outdated
Comment on lines +47 to +49
await keyman.addKeyboards('@fr$');
// or
await keyman.addKeyboardsForLanguage('French$');
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

If not working, should we remove from the active docs and leave it to re-add when #16018 is resolved?

Comment thread web/docs/engine/reference/core/addKeyboards.md Outdated
Comment on lines +57 to +58
If the BCP47 language code is suffixed with `$` (e.g. `@fr$`) and no specific keyboard is
requested, all keyboards for that language code will be loaded.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

As this doesn't work, we shouldn't add it currently

Comment thread web/docs/engine/reference/core/addKeyboardsForLanguage.md Outdated
Base automatically changed from refactor/web/docs to master May 28, 2026 08:31
@ermshiperete
Copy link
Copy Markdown
Contributor Author

Do not merge until #16018 is fixed - or the corresponding sections from the docs removed.

Co-authored-by: Marc Durdin <marc@durdin.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

docs: update addKeyboards for Keyman Engine for Web to clarify async and update examples

2 participants