coreConstants)[key];
+ }
+ }
+
+ assert.deepEqual(coreConstantsFiltered, dis2_key_cap_expected);
+ });
+
+ it('should be documented correctly', function() {
+ // These two files should have the same constant values for key caps:
+ // developer/docs/help/reference/file-types/keyman-touch-layout.md
+ // web/src/engine/osk/src/specialCharacters.ts
+ const helpFile =
+ path.join(path.dirname(fileURLToPath(import.meta.url)), '../../../../../docs/help/reference/file-types/keyman-touch-layout.md');
+ const lines = fs.readFileSync(helpFile, 'utf-8').replaceAll(/\r\n/g, '\n').split('\n');
+
+ // Find the relevant section in the file between start:special_key_caps and
+ // end:special_key_caps
+ const line0 = lines.findIndex(line => line.includes('start:special_key_caps'));
+ assert.notEqual(line0, -1);
+ const line1 = lines.findIndex(line => line.includes('end:special_key_caps'));
+ assert.notEqual(line1, -1);
+
+ const content = lines.slice(line0+1, line1);
+
+ const markdownConstants: any = {};
+
+ // Iterate over | cells in the relevant section of the file and build an
+ // array of values, assuming the format of the markdown doesn't change
+ let nextCap: string = null;
+ for(const line of content) {
+ const mCap = line.match(/ | `(\*.+\*)`<\/td>/i);
+ if(mCap) {
+ nextCap = mCap[1];
+ continue;
+ }
+ const mVal = line.match(/ | (.+);<\/td>/);
+ if(mVal) {
+ markdownConstants[nextCap] = parseInt(mVal[1], 16);
+ }
+ }
+
+ assert.deepEqual(markdownConstants, keymanWebSpecialCharacters);
+ });
+});
diff --git a/developer/src/kmc-kmn/test/tsconfig.json b/developer/src/kmc-kmn/test/tsconfig.json
index dee653dfac..ffdcf60ae7 100644
--- a/developer/src/kmc-kmn/test/tsconfig.json
+++ b/developer/src/kmc-kmn/test/tsconfig.json
@@ -10,6 +10,8 @@
},
"include": [
"**/*.tests.ts",
+ "./kmw/_imported_constants.js",
+ "./kmw/_imported_specialCharacters.ts",
"./helpers/index.ts",
"./kmw/util.ts"
],
diff --git a/developer/src/tike/xml/layoutbuilder/constants.js b/developer/src/tike/xml/layoutbuilder/constants.js
index 117020e5d5..7680725d40 100644
--- a/developer/src/tike/xml/layoutbuilder/constants.js
+++ b/developer/src/tike/xml/layoutbuilder/constants.js
@@ -552,7 +552,14 @@ $(function() {
this.lookupKeyNames.sort();
// Defines the PUA code mapping for the various 'special' modifier/control/non-printing keys on keyboards.
- // This is lifted directly from specialCharacters.ts and must be kept in sync. See also CompileKeymanWeb.pas: CSpecialText10
+ // This is lifted directly from web/.../specialCharacters.ts and must be kept in sync.
+ //
+ // `specialCharacters` must be kept in sync with the same values in:
+ // * /web/src/engine/osk/src/specialCharacters.ts
+ // * /developer/src/kmc-kmn/src/kmw-compiler/constants.ts
+ // * /core/include/ldml/keyman_core_ldml.ts
+ //
+ // More information, and unit test, in /developer/src/kmc-kmn/tests/kmw/constants.tests.ts
this.specialCharacters = {
'*Shift*': 8,
'*Enter*': 5,
diff --git a/web/src/engine/osk/src/specialCharacters.ts b/web/src/engine/osk/src/specialCharacters.ts
index c13e63715e..4efac09233 100644
--- a/web/src/engine/osk/src/specialCharacters.ts
+++ b/web/src/engine/osk/src/specialCharacters.ts
@@ -1,5 +1,12 @@
// Defines the PUA code mapping for the various 'special' modifier/control/non-printing keys on keyboards.
-// `specialCharacters` must be kept in sync with the same variable in constants.js. See also CompileKeymanWeb.pas: CSpecialText10
+//
+// `specialCharacters` must be kept in sync with the same values in:
+// * /developer/src/tike/xml/layoutBuilder/constants.js
+// * /developer/src/kmc-kmn/src/kmw-compiler/constants.ts
+// * /core/include/ldml/keyman_core_ldml.ts
+//
+// More information, and unit test, in /developer/src/kmc-kmn/tests/kmw/constants.tests.ts
+
const specialCharacters = {
'*Shift*': 8,
'*Enter*': 5,
|