Skip to content

Commit 5e103d8

Browse files
committed
Merge branch 'master' into chore/merge-master-to-staging-a19s8
2 parents 9dba631 + 84e3f2a commit 5e103d8

96 files changed

Lines changed: 8919 additions & 43 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

developer/19.0/context/keyboard-editor.md

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,10 @@ multiple source files, which are all managed within this one editor.
1313
The following image shows the first tab of the editor, the Details tab,
1414
for a brand new keyboard, with those three initial tabs.
1515

16-
![Keyboard Editor - New file, Details tab](../images/ui/frmKeymanWizard_New.png)
16+
<img src="../images/ui/frmKeymanWizard_New.png" style="width:100%" alt="Keyboard Editor - New file, Details tab"/>
1717

18-
> ### Note
19-
Users of earlier versions of Keyman Developer may initially have trouble
20-
finding tabs such as the Icon tab or the On-Screen tab, as they are not
21-
initially visible. The Features grid on the Details tab allows you to
22-
add these extra features into the keyboard.
18+
> [!Note]
19+
> Users of earlier versions of Keyman Developer may initially have trouble finding tabs such as the Icon tab or the On-Screen tab, as they are not initially visible. The Features grid on the Details tab allows you to add these extra features into the keyboard.
2320
2421
## Keyboard component files
2522

@@ -47,7 +44,7 @@ because that reflects both the Details and the Layout tab.
4744

4845
## Details tab
4946

50-
![Keyboard Editor - Details tab](../images/ui/frmKeymanWizard_Details.png)
47+
<img src="../images/ui/frmKeymanWizard_Details.png" style="width:100%" alt="Keyboard Editor - Details tab"/>
5148

5249
The Details tab grows as you add more options to a keyboard. The fields
5350
here are:
@@ -102,7 +99,7 @@ Features
10299

103100
## Layout tab
104101

105-
![Keyboard Editor - Layout tab, Design view](../images/ui/frmKeymanWizard_Layout_Design.png)
102+
<img src="../images/ui/frmKeymanWizard_Layout_Design.png" style="width:100%" alt="Keyboard Editor - Layout tab, Design view"/>
106103

107104
The Layout tab gives you a simple interface to quickly create a keyboard
108105
using a visual representation of a desktop/laptop computer keyboard. You
@@ -124,13 +121,11 @@ There are two ways to assign characters to the keys:
124121
onto the appropriate key. This will set the key to output that
125122
character.
126123

127-
> ### Hint
128-
To add the character to a key with existing characters, hold
129-
<kbd>Ctrl</kbd> while dropping it onto the key.
124+
> [!TIP]
125+
> To add the character to a key with existing characters, hold <kbd>Ctrl</kbd> while dropping it onto the key.
130126
131-
<!-- Saperator -->
132-
> ### Note
133-
Any key that does not have a character assigned to it will output what the selected Windows layout specifies.
127+
> [!Note]
128+
> Any key that does not have a character assigned to it will output what the selected Windows layout specifies.
134129
135130
Distinguish between left and right Ctrl/Alt
136131
: A Keyman keyboard can treat left and right Ctrl and Alt identically,
@@ -151,9 +146,7 @@ Display 102nd Key (as on European keyboards)
151146
You can press and release <kbd>Ctrl</kbd> to select
152147
another key on the keyboard using your keyboard.
153148

154-
<br/>
155-
156-
![Keyboard Editor - Layout tab, Code view](../images/ui/frmKeymanWizard_Layout_Code.png)
149+
<img src="../images/ui/frmKeymanWizard_Layout_Code.png" style="width:100%" alt="Keyboard Editor - Layout tab, Code view"/>
157150

158151
The Code view shows the source code of the keyboard file. This is where
159152
all the information in the Details and Layout tab is stored, and
@@ -165,7 +158,7 @@ editor shown within this view.
165158

166159
## On-Screen tab
167160

168-
![Keyboard Editor - On-Screen tab](../images/ui/OnScreenKeyboard.png)
161+
<img src="../images/ui/OnScreenKeyboard.png" style="width:100%" alt="Keyboard Editor - On-Screen tab"/>
169162

170163
This tab allows you to edit the visual representation of your keyboard
171164
layout. The content on this tab is stored in the .kvks file associated
@@ -213,17 +206,28 @@ Distinguish between left and right Ctrl/Alt
213206
: If checked, treats the left and right Ctrl/Alt as separate layers
214207

215208
Display 102nd Key (as on European keyboards)
216-
: European keyboards have one extra key that is not on US keyboards.
209+
: European keyboards (ISO layout) have one extra key that is not on US keyboards (ANSI layout).
217210
This key is positioned to the right of the left shift key. Some
218211
other keyboards have additional keys; these are not shown on the
219-
layout designer. If you have a European layout selected as your
212+
layout designer.
213+
214+
If you have a European layout selected as your
220215
Windows layout, the 102nd key will always be visible in the
221216
designer; ensure you select this checkbox if you want the 102nd key
222217
to always be visible to end users of the layout, irrespective of
223-
their selected base layout. When a European layout is selected as
218+
their selected base layout.
219+
220+
When a European layout is selected as
224221
your Windows layout, the shape of the Enter key will also change to
225222
take two rows, and the backslash key will move down one row, but not
226-
otherwise change in behaviour.
223+
otherwise change in behaviour.
224+
225+
<img src="../images/ui/OnScreenKeyboard_ISO.png" style="width:100%" alt="Keyboard Editor - On-Screen tab with ISO layout"/>
226+
*See the difference between the two layouts in Keyman Developer.*
227+
228+
> [!NOTE]
229+
> The "Display 102nd Key (as on European keyboards)" checkbox can be left unchecked.
230+
> To ensure compatibility, the extra key shouldn't be assigned since it won't be accessible on an ANSI physical keyboard.
227231

228232
Auto-fill underlying layout
229233
: When the Fill from layout button is clicked, if this option is
@@ -232,7 +236,7 @@ Auto-fill underlying layout
232236

233237
## Touch Layout tab
234238

235-
![Keyboard Editor - Touch Layout tab, Design view](../images/ui/TouchLayout_Design.png)
239+
<img src="../images/ui/TouchLayout_Design.png" style="width:100%" alt="Keyboard Editor - Touch Layout tab, Design view"/>
236240

237241
The Touch Layout tab is used to create the visible representation of the
238242
keyboard layout for touch devices. It works similarly to the On Screen
@@ -251,7 +255,7 @@ including iPhone and iPad, in different orientations, to allow you to
251255
visualize the keyboard layout before you load it onto a device. The
252256
following image shows all aspects of the touch design view.
253257

254-
![Keyboard Editor - Touch Layout tab, Design view closeup](../images/ui/TouchLayout_Design_2.png)
258+
<img src="../images/ui/TouchLayout_Design_2.png" style="width:100%" alt="Keyboard Editor - Touch Layout tab, Design view closeup"/>
255259

256260
### Left sidebar controls
257261

@@ -265,21 +269,21 @@ Template...
265269
current layout are not in the new template, their definitions will
266270
be lost. Therefore, selecting an appropriate template early in the
267271
development process is suggested.
268-
272+
269273
- template-basic: has only a phone layout (4 rows of keys), with three layers: default (K_A through K_Z
270274
plus some punctuation), shift (Shift K_A through Shift K_Z, plus some punctuation), numeric (K_0 through
271275
K_9 unshifted and shifted, plus other non-alphanumerice keys).
272-
276+
273277
- template-latin: has both phone and tablet layouts (which are identical except for some key spacing,
274278
each with 4 rows of keys), with four layers: default, shift, numeric, symbol. The first three layers
275279
are similar to those of template-basic, with the addition of longpress keys for accented characters.
276280
The symbol layer has many symbols not usually seen on a physical keyboard.
277-
281+
278282
- template-traditional: has both phone (4 rows of keys) and tablet (5 rows of keys) layouts. The phone
279283
layout is similar to the template-basic layout. The tablet layout has eight layers: default, shift, ctrl,
280284
shift-ctrl, alt, shift-alt, ctrl-alt, shift-ctrl-alt. The default layer has the keys from the default layer
281285
of the desktop layout, the shift layer has the keys from the shift layer of the desktop layout, and so on.
282-
286+
283287
Import from On Screen
284288
: If you have an existing On-Screen Keyboard for your keyboard layout,
285289
importing the design from the On-Screen Keyboard can reduce the
@@ -468,7 +472,7 @@ dragged between the main keyboard area and the long press area. The bar
468472
below the long press area contains the corresponding controls for the
469473
long press keys.
470474

471-
![Keyboard Editor - Touch Layout tab, Code view](../images/ui/frmKeymanWizard_TouchLayout_Code.png)
475+
<img src="../images/ui/frmKeymanWizard_TouchLayout_Code.png" style="width:100%" alt="Keyboard Editor - Touch Layout tab, Code view"/>
472476

473477
The Code view allows you to edit the JSON source of the touch layout
474478
file. This makes certain operations simpler, such as batched rearranging
@@ -481,7 +485,7 @@ The format of the layout file is described in [Creating a touch keyboard layout
481485

482486
Underneath the keyboard area is the Long-press, Flicks, and Multitaps controls.
483487

484-
![Long-press, Flicks, and Multitaps layout](../images/ui/LongPress_Flicks_Multitaps.png)
488+
<img src="../images/ui/LongPress_Flicks_Multitaps.png" style="width:100%" alt="Long-press, Flicks, and Multitaps layout"/>
485489

486490
Red circle with an X
487491
: This button to the top right of the key will delete the key from the
@@ -508,7 +512,7 @@ the selected key for different Gesture Type. The only difference between this co
508512

509513
## Icon tab
510514

511-
![Keyboard Editor - Icon tab](../images/ui/frmKeymanWizard_Icon.png)
515+
<img src="../images/ui/frmKeymanWizard_Icon.png" style="width:100%" alt="Keyboard Editor - Icon tab"/>
512516

513517
The icon tab allows you to edit the icon associated with the keyboard. An external icon editor will allow you to create more sophisticated icons with alpha transparency and multiple resolutions, but this will cover the standard 16x16 256 colour icon, which is all that many keyboards require. The controls at the top left are:
514518

@@ -574,7 +578,7 @@ This tab allows you to edit the [named constants](/developer/language/guide/cons
574578

575579
## Build tab
576580

577-
![Keyboard Editor - Build tab](../images/ui/BuildTab.png)
581+
<img src="../images/ui/BuildTab.png" style="width:100%" alt="Keyboard Editor - Build tab"/>
578582

579583
A set of common controls is across the top of this tab:
580584

@@ -645,4 +649,4 @@ web page.
645649
The Send to email function makes it easier to open the addresses on your
646650
mobile device without having to enter them manually.
647651

648-
Learn more about [testing on the web and mobile devices](../guides/test/).
652+
Learn more about [testing on the web and mobile devices](../guides/test/).

developer/19.0/context/package-editor.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,12 @@ are optional.
129129
A web site is encouraged and should be filled in the web site field, including
130130
the initial "http://" or "https://".
131131

132+
The Description is the keyboard summary that users will see on the keyboard’s
133+
overview page at the keyman.com web site.
134+
[GitHub style Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
135+
can be used in the description text. However, HTML tags are not supported.
136+
137+
132138
A package can optionally include a 140x250 JPEG or PNG image file to be shown
133139
during installation. This image file must be added to the Files list in step 1,
134140
then selected from the list here.
@@ -191,4 +197,4 @@ keyboard to the [Keyman Cloud Keyboards Repository](/developer/keyboards/).
191197
## Package Installers
192198

193199
As of Keyman Developer 17, bundled executable package installers for Keyman for
194-
Windows can be created using [kmc](kmc), but cannot be created within the IDE.
200+
Windows can be created using [kmc](kmc), but cannot be created within the IDE.
12.9 KB
Loading

developer/language/reference/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ on top of both vowels when <key>^</key> is pressed.
8585
```
8686
store(vowel) "aeiou"
8787
store(vowelcirc) "âêîôû"
88-
any(vowel) index(vowel,1) + "^" > index(vowelcirc,1) index(vowelcirc,2)
88+
any(vowel) index(vowel,1) + "^" > index(vowelcirc,1)
8989
```
9090

9191
## Platforms
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
$pagename = 'Bassa Vah Keyboard Help';
3+
$pagetitle = $pagename;
4+
require_once('header.php');
5+
?>
6+
7+
<p>
8+
This is a keyboard for the Bassa language using the Bassa Vah script. This keyboard is based on the design found in one of the Unicode proposal documents. Feedback is welcomed.
9+
</p>
10+
11+
<p>Tone diacritics may only occur on vowels, and two tone diacritics can never co-occur. For pedagogical purposes, tone diacritics may be placed on a space or on U+25CC.</p>
12+
13+
<h2>Desktop Keyboard Layout</h2>
14+
<div id='osk' data-states='default shift'>
15+
</div>
16+
17+
<h2>Mobile/Phone Keyboard Layout</h2>
18+
19+
<p>
20+
Due to the size and number of keys, some characters are hidden in the long press. Press and hold on the key with a little dot on the top right to reveal and use them.
21+
</p>
22+
23+
<div id='osk-phone' data-states='default numeric'>
24+
</div>
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
$pagename = 'Bassa Vah Keyboard Help';
3+
$pagetitle = $pagename;
4+
require_once('header.php');
5+
?>
6+
7+
<p>
8+
This is a keyboard for the Bassa language using the Bassa Vah script. This keyboard is based on the design found in one of the Unicode proposal documents. Feedback is welcomed.
9+
</p>
10+
11+
<p>Tone diacritics may only occur on vowels, and two tone diacritics can never co-occur.</p>
12+
13+
<h2>Desktop Keyboard Layout</h2>
14+
<div id='osk' data-states='default shift'>
15+
</div>
16+
17+
<h2>Mobile/Phone Keyboard Layout</h2>
18+
19+
<p>
20+
Due to the size and number of keys, some characters are hidden in the long press. Press and hold on the key with a little dot on the top right to reveal and use them.
21+
</p>
22+
23+
<div id='osk-phone' data-states='default numeric'>
24+
</div>
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
$pagename = 'Fulfulde Ajami (QWERTY) Keyboard Help';
3+
$pagetitle = $pagename;
4+
// Header we will tidy up later
5+
require_once('header.php');
6+
?>
7+
8+
<p>
9+
Fulfulde Ajami (QWERTY) keyboard developed for use for the Adamawa Fulfulde, Maasina Fulfulde, Nigerian Fulfulde, Pular, Pulaar, and Western Niger Fulfulde languages.
10+
</p>
11+
12+
<p>This keyboard makes use of rotas for a few characters. For example: typing » twice will produce ›. Doing this works with «, ”, and “. It also works with turning <i>fatha</i>, <i>kasra</i>, and <i>damma</i> into <i>fathatan</i>, <i>kasratan</i>, and <i>dammatan</i> respectively.</p>
13+
<p>It may be difficult to tell, but kashida is on the SHIFT+7 key, and the hyphen is available on the RALT+- key.</p>
14+
15+
<h2>Desktop Keyboard Layout</h2>
16+
<div id='osk' data-states='default shift rightalt rightalt-shift'>
17+
</div>
18+
19+
<h2>Mobile/Tablet Keyboard Layout</h2>
20+
<p>Due to the size and number of keys, some characters are hidden in the long press.
21+
Press and hold on the key with a little dot on the top right to reveal and use them.</p>
22+
23+
<div id='osk-tablet' data-states='default shift rightalt rightalt-shift'>
24+
</div>
25+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
$pagename = 'Borgu Fulfulde Ajami (Azerty) Keyboard Help';
3+
$pagetitle = $pagename;
4+
// Header we will tidy up later
5+
require_once('header.php');
6+
?>
7+
8+
<p>
9+
Borgu Fulfulde Ajami (Azerty) keyboard developed for use for the Borgu Fulfulde language.
10+
</p>
11+
12+
<p>This keyboard makes use of rotas for a few characters. For example: typing » twice will produce ›. Doing this works with «, ”, and “. It also works with turning <i>fatha</i>, <i>kasra</i>, and <i>damma</i> into <i>fathatan</i>, <i>kasratan</i>, and <i>dammatan</i> respectively.</p>
13+
<p>It may be difficult to tell, but kashida is on the SHIFT+7 key, and the hyphen is available on the RALT+- key.</p>
14+
15+
<h2>Desktop Keyboard Layout</h2>
16+
<div id='osk' data-states='default shift rightalt'>
17+
</div>
18+
19+
<h2>Mobile/Tablet Keyboard Layout</h2>
20+
<p>Due to the size and number of keys, some characters are hidden in the long press.
21+
Press and hold on the key with a little dot on the top right to reveal and use them.</p>
22+
23+
<div id='osk-tablet' data-states='default shift'>
24+
</div>
25+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
$pagename = 'Borgu Fulfulde Ajami (Azerty) Keyboard Help';
3+
$pagetitle = $pagename;
4+
// Header we will tidy up later
5+
require_once('header.php');
6+
?>
7+
8+
<p>
9+
Borgu Fulfulde Ajami (Azerty) keyboard developed for use for the Borgu Fulfulde language.
10+
</p>
11+
12+
<p>This keyboard makes use of rotas for a few characters. For example: typing » twice will produce ›. Doing this works with «, ”, and “. It also works with turning <i>fatha</i>, <i>kasra</i>, and <i>damma</i> into <i>fathatan</i>, <i>kasratan</i>, and <i>dammatan</i> respectively.</p>
13+
<p>It may be difficult to tell, but kashida is on the SHIFT+7 key, and the hyphen is available on the RALT+- key.</p>
14+
15+
<h2>Desktop Keyboard Layout</h2>
16+
<div id='osk' data-states='default shift rightalt'>
17+
</div>
18+
19+
<h2>Mobile/Tablet Keyboard Layout</h2>
20+
<p>Due to the size and number of keys, some characters are hidden in the long press.
21+
Press and hold on the key with a little dot on the top right to reveal and use them.</p>
22+
23+
<div id='osk-tablet' data-states='default shift'>
24+
</div>
25+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<?php
2+
$pagename = 'Borgu Fulfulde Ajami (QWERTY) Keyboard Help';
3+
$pagetitle = $pagename;
4+
// Header we will tidy up later
5+
require_once('header.php');
6+
?>
7+
8+
<p>
9+
Borgu Fulfulde Ajami (QWERTY) keyboard developed for use for the Borgu Fulfulde language.
10+
</p>
11+
12+
<p>This keyboard makes use of rotas for a few characters. For example: typing » twice will produce ›. Doing this works with «, ”, and “. It also works with turning <i>fatha</i>, <i>kasra</i>, and <i>damma</i> into <i>fathatan</i>, <i>kasratan</i>, and <i>dammatan</i> respectively.</p>
13+
<p>It may be difficult to tell, but kashida is on the SHIFT+7 key, and the hyphen is available on the SHIFT+- key.</p>
14+
15+
<h2>Desktop Keyboard Layout</h2>
16+
<div id='osk' data-states='default shift rightalt'>
17+
</div>
18+
19+
<h2>Mobile/Tablet Keyboard Layout</h2>
20+
<p>Due to the size and number of keys, some characters are hidden in the long press.
21+
Press and hold on the key with a little dot on the top right to reveal and use them.</p>
22+
23+
<div id='osk-tablet' data-states='default shift'>
24+
</div>
25+

0 commit comments

Comments
 (0)