keymanapp · mcdurdin · Jul 25, 2022 · Jul 1, 2022 · Jul 1, 2022 · Jul 1, 2022
@@ -42,7 +42,8 @@ The general structure of a .keyman-touch-layout file is:
 ## `root` object
 
 The `root` object may contain up to three properties, each being a [`platform`
-object](#platform-object), named `"phone"`, `"tablet"` or `"desktop"`.
+object](#platform-object), named `"phone"`, `"tablet"` or `"desktop"`. There
+must be at least one property.
 
 ## `platform` object
 
@@ -68,7 +69,7 @@ optionally contain three additional properties: `font`, `fontsize`, and
 `displayUnderlying`.
 
 * `layer`
-: An array of [`layer` objects](#layer-object). Required.
+: A non-empty array of [`layer` objects](#layer-object). Required.
 
 * `font`
 : An optional CSS-style font-family specification, being the name of the font to
@@ -83,6 +84,29 @@ optionally contain three additional properties: `font`, `fontsize`, and
 : A boolean value, if `true`, then the base layout's key cap will be displayed
   in the top left of the key cap. Defaults to `false`.
 
+* `defaultHint`
+
+: A string value. Default is `"dot"`.  Controls the display of the hint text on
+  the key cap, which is shown at the top right of the key cap.
+
+  * `"none"`: show no hint on the key cap.
+  * `"dot"`: show a dot on top-right of key cap if a longpress menu is
+    available, default. Matches behavior for Keyman 15.0 and earlier.
+  * `"longpress"`: show the default longpress key cap, if it exists.
+  * `"multitap"`: show the first multitap key cap, if it exists.
+  * `"flick"`: show the first flick key cap, selected in clockwise order,
+    starting from North.
+  * `"flick-n"`: show the key cap from the North flick, if it exists.
+  * `"flick-ne"`: show the key cap from the North-East flick, if it exists.
+  * `"flick-e"`: show the key cap from the East flick, if it exists.
+  * `"flick-se"`: show the key cap from the South-East flick, if it exists.
+  * `"flick-s"`: show the key cap from the South flick, if it exists.
+  * `"flick-sw"`: show the key cap from the South-West flick, if it exists.
+  * `"flick-w"`: show the key cap from the West flick, if it exists.
+  * `"flick-nw"`: show the key cap from the North-West flick, if it exists.
+
+  Introduced in Keyman 16.0.
+
 ## `layer` object
 
 The `layer` object describes one visible layer on a touch keyboard. It has two
@@ -140,7 +164,7 @@ affect the modifiers in any key events generated by keys on the layer.
 
 * `row`
 
-: An array of [`row` objects](#row-object). Required.
+: A non-empty array of [`row` objects](#row-object). Required.
 
 ## `row` object
 
@@ -150,19 +174,19 @@ properties: `id` and `key`.
 * `id`
 
 : An non-negative integer denoting where the row appears, with `0` being the top
-  row.
+  row. Required.
 
   Legacy: this value was sometimes an integer in a string. This string format is
   deprecated and will not be supported in future versions of Keyman Developer.
 
 * `key`
 
-: An array of [`key` objects](#key-object).
+: A non-empty array of [`key` objects](#key-object). Required.
 
 ## `key` object
 
 Describes a single key on a touch layout row. See also [`sk`
-object](#sk-object). A `key` object has no required properties.
+object](#sk-object). A `key` object must include either an `id` or `sp` property.
 
 * `id`
 
@@ -201,6 +225,13 @@ object](#sk-object). A `key` object has no required properties.
 
 : String. The string displayed on the key cap.
 
+* `hint`
+
+: String. If present, a small hint, often shown at top right of key cap.
+
+  Introduced in Keyman 16.0.
+
+
 * `layer`
 
 : String. If specified, overrides the modifier associated with the layer (this
@@ -291,19 +322,24 @@ object](#sk-object). A `key` object has no required properties.
 
 : If present, defines additional keys that may be selected when using a
   flick gesture on the key, with a [`flick` object](#flick-object). Flicks
-  should not be used on modifier keys, special keys, or the Spacebar. Keyman 16+.
+  should not be used on modifier keys, special keys, or the Spacebar.
+
+  Introduced in Keyman 16.0.
 
 * `multitap`
 
 : If present, defines an array of keys that may be selected sequentially when
   tapping multiple times on the key, an array of [`sk` objects](#sk-object).
-  Multitaps generally should not be used on modifier keys, special keys, or the
+  Multitaps may not be used on layer switch keys, special keys such as the globe key, or the
   Spacebar. Beware of mixing multitaps with layer switching, as this can lead to
-  a confusing user experience. Keyman 16+.
+  a confusing user experience.
 
   Keyman 15+: the Shift key has a predefined multitap sequence to access the
   `caps` layer, which is available if the `caps` layer is present. This is the
-  only multitap sequence supported in Keyman 15.
+  only multitap sequence supported in Keyman 15. This multitap sequence cannot
+  be overridden, and is the sole case where multitap input may cause a layer switch.
+
+  Introduced in Keyman 16.0.
 
 ## `sk` object
 
@@ -314,7 +350,9 @@ properties are not fully supported as of Keyman 15: `font`, `fontsize`, `pad`,
 and `width`.
 
 * `id`
-: A string identifier for the longpress key. See `key` object for details.
+
+: String. Required. An identifier for the longpress key. See `key` object for
+  details.
 
 * `text`
 
@@ -408,7 +446,7 @@ string") into the appropriate spec format.
 # .keyman-touch-layout version history
 
 ## 2022-06-30 2.0 stable
-* Add support for flick and multitap. Aligns with Keyman 16.0.
+* Add support for flick, multitap, hint, defaultHint. Aligns with Keyman 16.0.
 
 ## 2022-06-27 1.0 stable
 * Initial schema version and full documentation

@@ -11,7 +11,9 @@
         "tablet": { "$ref": "#/definitions/platform" },
         "phone": { "$ref": "#/definitions/platform" },
         "desktop": { "$ref": "#/definitions/platform" }
-      }
+      },
+      "minProperties": 1,
+      "additionalProperties": false
     },
 
     "platform": {
@@ -20,15 +22,17 @@
         "font": { "$ref": "#/definitions/font-spec" },
         "fontsize": { "$ref": "#/definitions/fontsize-spec" },
         "layer": { "$ref": "#/definitions/layers" },
-        "displayUnderlying": { "type": "boolean" }
+        "displayUnderlying": { "type": "boolean" },
+        "defaultHint": { "type": "string", "enum": ["none","dot","longpress","multitap","flick","flick-n","flick-ne","flick-e","flick-se","flick-s","flick-sw","flick-w","flick-nw"] }
       },
       "required": ["layer"],
       "additionalProperties": false
     },
 
     "layers": {
       "type": "array",
-      "items": { "$ref": "#/definitions/layer" }
+      "items": { "$ref": "#/definitions/layer" },
+      "minItems": 1
     },
 
     "layer": {
@@ -48,7 +52,8 @@
 
     "rows": {
       "type": "array",
-      "items": { "$ref": "#/definitions/row" }
+      "items": { "$ref": "#/definitions/row" },
+      "minItems": 1
     },
 
     "row": {
@@ -69,7 +74,8 @@
 
     "keys": {
       "type": "array",
-      "items": { "$ref": "#/definitions/key" }
+      "items": { "$ref": "#/definitions/key" },
+      "minItems": 1
     },
 
     "key": {
@@ -86,8 +92,16 @@
         "width": { "$ref" : "#/definitions/key-width" },
         "sk": { "$ref": "#/definitions/subkeys" },
         "flick": { "$ref": "#/definitions/flick" },
-        "multitap": { "$ref": "#/definitions/subkeys" }
+        "multitap": { "$ref": "#/definitions/subkeys" },
+        "hint": { "type": "string" }
       },
+      "anyOf": [
+        {"required": ["id"]},
+        {"required": ["sp"]},
+        {"required": ["sk"]},
+        {"required": ["flick"]},
+        {"required": ["multitap"]}
+      ],
       "additionalProperties": false
     },
 
@@ -98,24 +112,25 @@
 
     "key-sp": {
       "type": "integer",
-      "enum": [0, 1, 2, 8, 9, 10],
+      "enum": [0, 1, 2, 8, 9, 10]
     },
 
     "key-pad": {
       "type": "number",
       "minimum": 0,
-      "maximum": 10000
+      "maximum": 100000
     },
 
     "key-width": {
       "type": "number",
       "minimum": 0,
-      "maximum": 1000
+      "maximum": 100000
     },
 
     "subkeys": {
       "type": "array",
-      "items": { "$ref": "#/definitions/subkey" }
+      "items": { "$ref": "#/definitions/subkey" },
+      "minItems": 1
     },
 
     "subkey": {
@@ -140,6 +155,7 @@
       "patternProperties": {
         "^(n|s|e|w|ne|nw|se|sw)$": { "$ref": "#/definitions/subkey" }
       },
+      "minProperties": 1,
       "additionalProperties": false
     },
 

@@ -20,7 +20,8 @@
         "font": { "$ref": "#/definitions/font-spec" },
         "fontsize": { "$ref": "#/definitions/fontsize-spec" },
         "layer": { "$ref": "#/definitions/layers" },
-        "displayUnderlying": { "type": "boolean" }
+        "displayUnderlying": { "type": "boolean" },
+        "defaultHint": { "type": "string", "enum": ["none","dot","longpress","multitap","flick","flick-n","flick-ne","flick-e","flick-se","flick-s","flick-sw","flick-w","flick-nw"] }
       },
       "required": ["layer"],
       "additionalProperties": false
@@ -95,7 +96,8 @@
         "width": { "$ref" : "#/definitions/numeric" },
         "sk": { "$ref": "#/definitions/subkeys" },
         "flick": { "$ref": "#/definitions/flick" },
-        "multitap": { "$ref": "#/definitions/subkeys" }
+        "multitap": { "$ref": "#/definitions/subkeys" },
+        "hint": { "type": "string" }
       },
       "additionalProperties": false
     },

@@ -3323,6 +3323,7 @@ procedure TfrmKeymanWizard.SelectTouchLayoutTemplate(APromptChange: Boolean);
     PromptChange := APromptChange;
     if ShowModal = mrOk then
     begin
+      frameTouchLayout.SaveToString;
       frameTouchLayout.TemplateFileName := TemplateFileName;
       frameTouchLayout.Load('', True, False);   // I4034
       Self.Modified := True;

@@ -1672,6 +1672,7 @@ function TCompileKeymanWeb.ValidateLayoutFile(var sLayoutFile: string; const sVK
   FSubKey: TTouchLayoutSubKey;
   FRequiredKeys: set of TRequiredKey;
   FDictionary: TStringList;
+  FDirection: TTouchLayoutFlickDirection;
 
     function IsValidUnicodeValue(ch: Integer): Boolean;   // I4198
     begin
@@ -1873,6 +1874,11 @@ function TCompileKeymanWeb.ValidateLayoutFile(var sLayoutFile: string; const sVK
               CheckKey(FKey.Id, FKey.Text, FKey.NextLayer, FKey.SpT);   // I4119
               for FSubKey in FKey.Sk do
                 CheckKey(FSubKey.Id, FKey.Text, FSubKey.NextLayer, FSubKey.SpT);   // I4119
+              for FDirection in FKey.Flick.Keys do
+                CheckKey(FKey.Flick[FDirection].Id, FKey.Flick[FDirection].Text,
+                  FKey.Flick[FDirection].NextLayer, FKey.Flick[FDirection].SpT);
+              for FSubKey in FKey.MultiTap do
+                CheckKey(FSubKey.Id, FKey.Text, FSubKey.NextLayer, FSubKey.SpT);
             end;
 
           if FRequiredKeys <> CRequiredKeys then

@@ -191,7 +191,7 @@ procedure TAppSourceHttpResponder.RespondTouchEditorLib(
 begin
   doc := ARequestInfo.Document;
   Delete(doc, 1, Length('/app/source/toucheditor/lib/'));
-  if (Pos('/', doc) > 0) or (Pos('\', doc) > 0) then
+  if Pos('..', doc) > 0 then
     Respond404(AContext, ARequestInfo, AResponseInfo)
   else
     RespondFile(GetLayoutBuilderPath + doc, AContext, ARequestInfo, AResponseInfo);

@@ -36,7 +36,7 @@ class function TKeymanDeveloperPaths.NodePath: string;
   KeymanRoot: string;
 begin
   if TKeymanPaths.RunningFromSource(KeymanRoot)
-    then Result := KeymanRoot + 'developer\src\inst\dist\node.exe'
+    then Result := KeymanRoot + 'developer\src\inst\node\dist\node.exe'
     else Result := ExtractFilePath(ParamStr(0)) + 'node.js\node.exe';
 end;