diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 62bd8677ae..134fb619a4 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -102,6 +102,18 @@ ======================================================================== -->
+ +

Keyboard Editor page consists of: +

+

+
@@ -139,6 +151,24 @@

This corresponds to the following source line:

store(&message) 'Here is a message about a keyboard'
+ + +

The Keyboard Version documents the version of the keyboard.

+

A keyboard version should be updated whenever there are changes to a keyboard. The good principles to follow are: +

+

+

This corresponds to the following source line:

+
store(&keyboardversion) '1.1.2'
+

Note: there is a difference between &keyboardversion, which documents the keyboard version, and &version, + which determines which version of Keyman a keyboard will run with.

+
+

In this field, enter information about the keyboard for your own reference. These comments will only be visible in the source file, and not to users of your keyboard.

@@ -183,6 +213,41 @@

Tests your KeymanWeb keyboard in an Internet Explorer embedded window

+ +

The Features grid controls which additional file components are included in + the keyboard. Each of the features relates to a system store. Here are the file + components: +

+ Icon will be automatically included when a new keyboard project is created. +

+
+ + +

This will open a selection dialog allowing you to choose a feature to add to + the keyboard project. Adding a feature will add an extra tab to the editor, + and add the corresponding store to the keyboard source

+
+ + +

Depending on what is included in the Feature Grid, you can select a feature from + the grid then click on Edit... This will take you to the corresponding tab and + let you make changes. +

+
+ + +

Removing a feature will not delete the component file, + but will just remove the store from the keyboard source. +

+
+ @@ -197,8 +262,40 @@

The toolbox allows for the changing of the colours, addition of text and shapes. It also allows for the moving of the icon around the canvas and also a preview of the icon is displayed.

+ + +

Click on a colour from the box to apply the colour onto the Keyboard's + icon. You can see the Foreground Color displays the colour you chose. To deselect + the colour, click on the X mark on the corner left of the colour box, or choose + another colour. +

+
+ +

This tab allows you to edit the visual representation of your keyboard + layout. The content on this tab is stored in the .kvks file associated with + your keyboard. The visual representation is used only in desktop and desktop + web; however if no touch layout is defined, this layout will be synthesized + into a touch layout automatically. +

+

An On-Screen keyboard is optional but in most keyboards is recommended. + The On-Screen keyboard may not always match the actual layout identically, + because you may choose to hide some of the details of encoding from the + interface presented to the user. +

+

+ This keyboard layout can also be printed or included in HTML or other documentation. + The editor allows you to export the file to HTML, PNG or BMP formats. +

+
+ + +

If this option is checked, when the Fill from layout button is clicked, + then keys without corresponding rules in the Layout will be filled with the + base layout character. +

+