erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 00:15:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Merge pull request #16085 from keymanapp/docs/web/keyman17

Browse source 
docs(web): remove unnecessary mentioning of Keyman 17 from docs

Some pages were mentioning Keyman 17 although the content applies to newer versions as well. This change therefore removes the version number from those places.
This commit is contained in:
Eberhard Beilharz 2026-06-10 08:13:38 +02:00 • committed by GitHub
commit 0539582012
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 30 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
web/docs/engine/reference/layouts.md
View file

@ -2,4 +2,6 @@
title: Layout Designer
---
One of the main features of *KeymanWeb 17* is its ability to support distinct, user-customizable layouts for touch-screen keyboards on phones and tablets. *Keyman Developer 17* includes a layout designer to simplify the process of creating custom layouts for any keyboard.
One of the main features of *KeymanWeb* is its ability to support distinct, user-customizable
layouts for touch-screen keyboards on phones and tablets. *Keyman Developer* includes a layout
designer to simplify the process of creating custom layouts for any keyboard.

28
web/docs/engine/reference/layoutspec.md
View file

@ -2,13 +2,19 @@
title: Layout Specifications
---
Touch-screen layouts for *KeymanWeb 17* are specified as JSON objects containing a member object for each specified device type. Currently supported device types are *tablet* and *phone*. Layouts for *desktop* computers may also be specified but desktop on-screen keyboard design is normally managed by the
standard *Keyman Developer* on-screen keyboard tool rather than the keyboard layout designer. If the same
layout is appropriate for both *tablet* and *phone* devices only one need be specified, and will be used for either type of device.
Touch-screen layouts for *KeymanWeb* are specified as JSON objects containing a member object for
each specified device type. Currently supported device types are *tablet* and *phone*. Layouts
for *desktop* computers may also be specified but desktop on-screen keyboard design is normally
managed by the standard *Keyman Developer* on-screen keyboard tool rather than the keyboard
layout designer. If the same layout is appropriate for both *tablet* and *phone* devices only one
need be specified, and will be used for either type of device.
File encoding for manually-created layout files may use either UTF-8 or 7-bit ANSI coding, but must not include a BOM. For easier editing and management without requiring special fonts, embedded Unicode characters with values above 127 may use the *\uXXXX* notation.
File encoding for manually-created layout files may use either UTF-8 or 7-bit ANSI coding, but
must not include a BOM. For easier editing and management without requiring special fonts,
embedded Unicode characters with values above 127 may use the *\uXXXX* notation.
For details of the JSON specification, see [The JSON Data Interchange Format(ECMA-404)](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
For details of the JSON specification, see [The JSON Data Interchange
Format(ECMA-404)](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
<table data-border="1">
<thead>
@ -249,7 +255,7 @@ Details of key member specifications are given below:
</tr>
</thead>
<tbody>
<tr>
<tr>
<td class="rowhead" style="text-align: left;">id</td>
<td style="text-align: left;">Each key id must start with <i>>K_</i> , for keys mapped to standard Keyman virtual key names, e.g. <i>K_HYPHEN</i> , or either <i>U_</i> or <i>T_</i> for user-defined names. Keys identified as <i>U_xxxx[_xxxx...]</i> specify one or more Unicode characters in hex format, e.g. <i>U_1363</i> for the Ethiopic Comma character, and will insert those characters if the key id is not matched by a rule. Other user-defined keys, such as <i>T_ZZZ</i> , will be ignored unless matched by a rule. The key id is required except for key styles 9 or 10 (blank or spacer keys).</td>
</tr>
@ -330,7 +336,11 @@ Details of key member specifications are given below:
</tbody>
</table>
For many keyboards, it is helpful to associate some keyboard layers with physical keyboard modifier states. This is reflected in the layer name, where a layer name of *shift* means that when a key in that layer is touched, the keystroke will be processed as if the keyboard Shift key is held.
For many keyboards, it is helpful to associate some keyboard layers with physical keyboard
modifier states. This is reflected in the layer name, where a layer name of *shift* means that
when a key in that layer is touched, the keystroke will be processed as if the keyboard Shift key
is held.
The special layer names of:
  *leftalt* ,
@ -364,7 +374,9 @@ The following special key identifiers have been added to simplify layer selectio
| K_SHIFTED | 264 |
| K_ALTGR | 265 |
A special font is used to provide easily recognizable key graphics for various special purpose keys. The following key text strings will be recognized and cause the appropriate graphic to be used for the key cap instead of the actual text:
A special font is used to provide easily recognizable key graphics for various special purpose
keys. The following key text strings will be recognized and cause the appropriate graphic to be
used for the key cap instead of the actual text:
| Text string | Key purpose |
|:------------------|:--------------------------------------------------------|

11
web/docs/engine/reference/overview.md
View file

@ -4,11 +4,14 @@ title: Overview
*KeymanWeb* is a cross-browser JavaScript input method solution.
The *KeymanWeb 17 API* provides JavaScript functions to allow a website developer to integrate the use of
*KeymanWeb* multi-lingual keyboard mapping into a website, using either a standard or a custom-designed user-interface. The functions are exposed as API calls to the *KeymanWeb* core, the
*On-Screen Keyboard* module, a *Utility function* library, or one of the standard *User Interface* modules.
The *KeymanWeb API* provides JavaScript functions to allow a website developer to integrate the
use of *KeymanWeb* multi-lingual keyboard mapping into a website, using either a standard or a
custom-designed user-interface. The functions are exposed as API calls to the *KeymanWeb* core,
the *On-Screen Keyboard* module, a *Utility function* library, or one of the standard *User
Interface* modules.
A *KeymanWeb* instance is automatically constructed when you include the compiled KeymanWeb script (kmw-release.js) in your web page source.
A *KeymanWeb* instance is automatically constructed when you include the compiled KeymanWeb
script (kmw-release.js) in your web page source.
The *KeymanWeb API* comprises the following objects: