From 22c8a6673105d7bc6a11cf8a038ef4f6d95fb7e2 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Fri, 5 Dec 2025 15:54:46 +0100 Subject: [PATCH 1/4] docs(web): add links to next/previous page to web guide Build-bot: skip Test-bot: skip --- web/docs/engine/guide/adding-keyboards.md | 2 ++ web/docs/engine/guide/get-started.md | 20 +++++++++++++++---- .../engine/guide/user-interface-design.md | 3 ++- web/docs/engine/guide/what-is-a-keyboard.md | 2 ++ 4 files changed, 22 insertions(+), 5 deletions(-) diff --git a/web/docs/engine/guide/adding-keyboards.md b/web/docs/engine/guide/adding-keyboards.md index 2dba3e86c1..221f495de1 100644 --- a/web/docs/engine/guide/adding-keyboards.md +++ b/web/docs/engine/guide/adding-keyboards.md @@ -56,3 +56,5 @@ keyman.addKeyboards('french','sil_euro_latin@sv','sil_euro_latin@no') ``` This will install three keyboards - one for French (named, quite simply, "French") and two copies of the EuroLatin keyboard - one for Swedish and one for Norwegian. + +[Previous: What is a Keyboard?](what-is-a-keyboard) | [Next: Additional Examples](examples/) diff --git a/web/docs/engine/guide/get-started.md b/web/docs/engine/guide/get-started.md index 4089f6712d..87aa234aea 100644 --- a/web/docs/engine/guide/get-started.md +++ b/web/docs/engine/guide/get-started.md @@ -38,16 +38,28 @@ The source code for the page may be seen below. ## The Breakdown -- The `` loads the Keyman Engine for Web script for the page. +- The `` loads the Keyman Engine + for Web script for the page. -- `(function() { keyman.init(); });` serves to initialize the web engine with default settings. By adding the object `{attachType:'auto'}` as a parameter to our `keyman.init()` call, the KeymanWeb engine will then link into any detected input elements automatically, regardless of browser or device, as part of its initialization. +- `(function() { keyman.init(); });` serves to initialize the web engine with default settings. + By adding the object `{attachType:'auto'}` as a parameter to our `keyman.init()` call, the + KeymanWeb engine will then link into any detected input elements automatically, regardless of + browser or device, as part of its initialization. -- The other ``, creates the language menu seen on non-mobile devices and the on-screen keyboard toggle button. For other options, see our [User Interface Design](user-interface-design) page. +- The other ``, creates the language + menu seen on non-mobile devices and the on-screen keyboard toggle button. For other options, + see our [User Interface Design](user-interface-design) page. -- The calls to `keyman.addKeyboards()` in the source above link in the two example Keyman keyboards used in this demo from our CDN server. For more info on how to include keyboards in your KeymanWeb installation, check the [Adding Keyboards](adding-keyboards) page. +- The calls to `keyman.addKeyboards()` in the source above link in the two example Keyman + keyboards used in this demo from our CDN server. For more info on how to include keyboards in + your KeymanWeb installation, check the [Adding Keyboards](adding-keyboards) page. ## API References - On initialization: [`keyman.init()`](../reference/core/init). - On including keyboards: [`keyman.addKeyboards()`](../reference/core/addKeyboards). + +[Next: User Interface Design](user-interface-design) diff --git a/web/docs/engine/guide/user-interface-design.md b/web/docs/engine/guide/user-interface-design.md index 9f56ac214e..6779b75724 100644 --- a/web/docs/engine/guide/user-interface-design.md +++ b/web/docs/engine/guide/user-interface-design.md @@ -96,8 +96,9 @@ less suitable.

The include for this interface is <script src="kmwuitoolbar.js">.

To select where the interface will be displayed on your page, add the following element where desired: <div id="KeymanWebControl" display="block"></div>, as with the Button Interface above.

A live example of the KeymanWeb Toolbar Interface is available on the KeymanWeb Demo Site. For information on how your site users will interact with the Toolbar Interface, click here.

- + +[Previous: Get Started](get-started) | [Next: What is a Keyboard?](what-is-a-keyboard) diff --git a/web/docs/engine/guide/what-is-a-keyboard.md b/web/docs/engine/guide/what-is-a-keyboard.md index 204e26bfb7..488d12f923 100644 --- a/web/docs/engine/guide/what-is-a-keyboard.md +++ b/web/docs/engine/guide/what-is-a-keyboard.md @@ -11,3 +11,5 @@ The keyboards available for use with KeymanWeb have been developed by a wide ran KeymanWeb supports a very wide range of languages, and many keyboards available for use with KeymanWeb include features specific to particular languages. Because of this, each keyboard has its own documentation, which is included with the On-Screen Keyboard. Although the level of detail in this documentation does vary somewhat, depending on the designer and the requirements of each keyboard, this is the first place to look for information on using a particular language with KeymanWeb. [Index of help for KeymanWeb keyboard layouts](/keyboard) + +[Previous: User Interface Design](user-interface-design) | [Next: Installing Keyboards](adding-keyboards) From 4e291b8ef1c1adb444ef5395b56795c704ff4743 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Mon, 8 Dec 2025 10:14:33 +0100 Subject: [PATCH 2/4] Update web/docs/engine/guide/get-started.md Co-authored-by: Marc Durdin --- web/docs/engine/guide/get-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/docs/engine/guide/get-started.md b/web/docs/engine/guide/get-started.md index 87aa234aea..0ff79814a7 100644 --- a/web/docs/engine/guide/get-started.md +++ b/web/docs/engine/guide/get-started.md @@ -42,7 +42,7 @@ The source code for the page may be seen below. src='https://s.keyman.com/kmw/engine/17.0.330/keymanweb.js'>` loads the Keyman Engine for Web script for the page. -- `(function() { keyman.init(); });` serves to initialize the web engine with default settings. +- `(function() { ... keyman.init( ... ); ... })(keyman);` serves to initialize the web engine with default settings. By adding the object `{attachType:'auto'}` as a parameter to our `keyman.init()` call, the KeymanWeb engine will then link into any detected input elements automatically, regardless of browser or device, as part of its initialization. From a18ad08a8f1a62f83cb1b13b1bdd98f034ee3d06 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Mon, 8 Dec 2025 10:20:00 +0100 Subject: [PATCH 3/4] docs(web): update version in documentation Addresses a code review comment. --- web/docs/engine/guide/get-started.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/docs/engine/guide/get-started.md b/web/docs/engine/guide/get-started.md index 0ff79814a7..8d3cd1baa4 100644 --- a/web/docs/engine/guide/get-started.md +++ b/web/docs/engine/guide/get-started.md @@ -19,8 +19,8 @@ The source code for the page may be seen below. KeymanWeb - A First Example - - + + ` loads the Keyman Engine + src='https://s.keyman.com/kmw/engine/18.0.245/keymanweb.js'>` loads the Keyman Engine for Web script for the page. - `(function() { ... keyman.init( ... ); ... })(keyman);` serves to initialize the web engine with default settings. @@ -48,7 +48,7 @@ The source code for the page may be seen below. browser or device, as part of its initialization. - The other ``, creates the language + src='https://s.keyman.com/kmw/engine/18.0.245/kmwuitoggle.js'>`, creates the language menu seen on non-mobile devices and the on-screen keyboard toggle button. For other options, see our [User Interface Design](user-interface-design) page. From df806e10b6d5be6ca8f42b19978df15ccb42b059 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Mon, 8 Dec 2025 10:26:09 +0100 Subject: [PATCH 4/4] docs(web): remove specific version from documentation This removes the specific version from the control-by-control example and thus makes it similar to the other examples where we use a relative path. `get-started.md` and the *.html files will still show how this can be done with a specific version. Build-bot: skip Test-bot: skip --- web/docs/engine/guide/examples/control-by-control.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/docs/engine/guide/examples/control-by-control.md b/web/docs/engine/guide/examples/control-by-control.md index da8ee9acca..974338ef1f 100644 --- a/web/docs/engine/guide/examples/control-by-control.md +++ b/web/docs/engine/guide/examples/control-by-control.md @@ -40,8 +40,8 @@ Also include the following HTML code: ```html - - + +