From 9e17f7f9c0f0bcb63865d9ef22ac515493c71571 Mon Sep 17 00:00:00 2001 From: Nnyny Date: Mon, 27 May 2024 15:39:41 +0700 Subject: [PATCH 1/7] Add context/options --- developer/src/tike/xml/help/contexthelp.xml | 149 ++++++++++++++++++++ 1 file changed, 149 insertions(+) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 3f071d11c39..b32c8d04ff1 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -387,6 +387,155 @@ +
+ +

The following options are configurable in TIKE in the General tab.

+ + + +

+ + + +

+ + + +

Instead of opening a keyboard file in the Details tab, open directly into the Layout tab, Source pane.

+ + + +

You can open any Keyman source file shown in the project in an external text editor by right-clicking + on the file and selecting "Open in External Editor". The files available for editing externally + are .kmn, .kps, and .kvks. This field configures which editor you wish to use to edit the files. + Note: if you need to pass command line parameters to the editor, you will need to wrap the command + in a batch file and reference the batch file here.

+ + + +

You can open any Keyman source file shown in the project in an external text editor by right-clicking + on the file and selecting "Open in External Editor". The files available for editing externally + are .kmn, .kps, and .kvks. This field configures which editor you wish to use to edit the files. + Note: if you need to pass command line parameters to the editor, you will need to wrap the command + in a batch file and reference the batch file here.

+ + + +

+ + + +

+ + + +

Configure your SMTP server settings for email functionality within Keyman Developer, + such as emailing debug URLs for the touch layout debugger.

+ + + +

Configure the HTTP proxy settings for online functionality within Keyman Developer, + such as uploading files to Tavultesoft.

+ + + +

Click Cancel to close the tab.

+ + + +

Click OK to save changes.

+ + + +

Sets whether to use the Tab character or spaces for indents.

+ + + +

The indent size, measured in number of spaces.

+ + + +

If checked, the quoted font size will be the same as the default font size.

+ + + +

Sets the font for ordinary text in the editor.

+ + + +

Sets the font for displaying comments text and strings in Keyman source files in single or double quotes.

+ + + +

Sets the display theme and syntax highlighting options for the editor. A custom theme can be defined in a JSON file.

+ + + +

Enables the Keyman 5-style Test window instead of the debugger.

+ + + +

Breakpoints will fire when a rule has finished being processed also.

+ + + +

Activates single-step mode after a breakpoint fires.

+ + + +

Displays numeric indices of characters in stores

+ + + +

When the debugger starts, rebuild a keyboard without prompting if the keyboard + has no debug symbols included.

+ + + +

update is coming

+ + + +

+ + + +

The character beneath the cursor in the edit window will be highlighted in the + Character Map. This will intelligently parse the character data under the cursor so that + a character code (e.g. U+1234) will be highlighted correctly.

+ + + +

Rebuilds the Unicode character database from source unicodedata.txt and blocks.txt. + These files can be downloaded from the Unicode website at http://www.unicode.org/ucd/. + This lets you update the character map with a newer version of Unicode. + Keyman Developer 10.0 was released with Unicode version 10.0 data.

+ + + +

Rebuilds the Unicode character database from source unicodedata.txt and blocks.txt. + These files can be downloaded from the Unicode website at http://www.unicode.org/ucd/. + This lets you update the character map with a newer version of Unicode. + Keyman Developer 10.0 was released with Unicode version 10.0 data.

+ + + +

You can customize the Keyman Developer server for testing the usability of your keyboard. + Features of the Keyman Developer server include: +

    +
  • Seamless integration with the IDE (Start, Stop, Live reload, Recompile...)
    • +
  • Port configuration
    • +
  • Allow testing cross devices
    • +
  • Wider range support for NGROK...
    • +
+

+ + + +

Below Configure Server, untick the box, and it will quit displaying any local URLs for keyboard testing.

+ +
+

This dialog lets you check the virtual key code for any key combination (except Window reserved key combinations such as Alt + Tab). You can then insert the virtual key code into the last active edit window at the current cursor position.



From 8e0033072ffcce47c11c32e70deb9b8b23ec6d9e Mon Sep 17 00:00:00 2001 From: Nguonnyny Tan <123520338+Nnyny@users.noreply.github.com> Date: Tue, 28 May 2024 12:34:20 +0700 Subject: [PATCH 2/7] Update developer/src/tike/xml/help/contexthelp.xml Co-authored-by: Marc Durdin --- developer/src/tike/xml/help/contexthelp.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index b32c8d04ff1..be466fdc2ce 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -439,7 +439,7 @@ -

Click Cancel to close the tab.

+

Click Cancel to close the dialog without saving changes.

 From 73f8477b50b00d34f6b2340df9f6738d62b2537e Mon Sep 17 00:00:00 2001 From: Nguonnyny Tan <123520338+Nnyny@users.noreply.github.com> Date: Tue, 28 May 2024 12:34:35 +0700 Subject: [PATCH 3/7] Update developer/src/tike/xml/help/contexthelp.xml Co-authored-by: Marc Durdin --- developer/src/tike/xml/help/contexthelp.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index be466fdc2ce..1d0f3aa7725 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -443,7 +443,7 @@ -

Click OK to save changes.

+

Click OK to save changes and close the dialog.

 From 518a13a5910a549694e1bc14bd646c47e2173ae9 Mon Sep 17 00:00:00 2001 From: Nguonnyny Tan <123520338+Nnyny@users.noreply.github.com> Date: Tue, 28 May 2024 14:53:47 +0700 Subject: [PATCH 4/7] Update contexthelp.xml --- developer/src/tike/xml/help/contexthelp.xml | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 1d0f3aa7725..700ef63a657 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -389,7 +389,7 @@ -

The following options are configurable in TIKE in the General tab.

+

The Options dialog display several tabs such as General, Editor, Debugger, Character Map and Server. You can configure the environment of Keyman Developer here.

 @@ -492,7 +492,9 @@ -

update is coming

+

If you are debugging a keyboard, make a change to the keyboard, and recompile it, then the debugger needs to be + reset in order to get access to the new keyboard. Keyman Developer will normally prompt you to do this, but if you set + this option, then it will reset the debugger automatically instead.

 @@ -516,7 +518,7 @@

Rebuilds the Unicode character database from source unicodedata.txt and blocks.txt. These files can be downloaded from the Unicode website at http://www.unicode.org/ucd/. This lets you update the character map with a newer version of Unicode. - Keyman Developer 10.0 was released with Unicode version 10.0 data.

+ Keyman Developer 17.0 was released with Unicode version 15.1 data.

 @@ -550,4 +552,4 @@

To close the dialog, click the Close button or press Shift + Esc.

 - \ No newline at end of file + From 6627d4e103019cd0d5c11567ea15fcba2ceb6293 Mon Sep 17 00:00:00 2001 From: Nguonnyny Tan <123520338+Nnyny@users.noreply.github.com> Date: Thu, 30 May 2024 12:19:21 +0700 Subject: [PATCH 5/7] chore: remove 'chkShowStartupDialog' and 'chkAllowMultipleInstances' --- developer/src/tike/xml/help/contexthelp.xml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 700ef63a657..4898f9a1c22 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -392,14 +392,6 @@

The Options dialog display several tabs such as General, Editor, Debugger, Character Map and Server. You can configure the environment of Keyman Developer here.

- -

- - - -

- -

Instead of opening a keyboard file in the Details tab, open directly into the Layout tab, Source pane.

 From 7c365e35a39c1dba014251d4b6ec6bfe90922641 Mon Sep 17 00:00:00 2001 From: Nguonnyny Tan <123520338+Nnyny@users.noreply.github.com> Date: Tue, 17 Sep 2024 14:31:38 +0700 Subject: [PATCH 6/7] chore: update contexthelp.xml --- developer/src/tike/xml/help/contexthelp.xml | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 552e975fe01..6a3dd4cef5b 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -494,12 +494,14 @@ in a batch file and reference the batch file here.

- -

+ +

You can check the location of your default project folder, where projects like keyboards or + lexical models will be saved automatically. If needed, you can change the folder location + to a more convenient spot.

 - -

+ +

Reset all tabs to their original locations.

 @@ -571,10 +573,6 @@ this option, then it will reset the debugger automatically instead.

 - -

- -

The character beneath the cursor in the edit window will be highlighted in the Character Map. This will intelligently parse the character data under the cursor so that From 035af7271ccf9dd7bb4d646d65549148672e3e48 Mon Sep 17 00:00:00 2001 From: Marc Durdin Date: Thu, 26 Sep 2024 00:15:52 +0200 Subject: [PATCH 7/7] docs: tweak content --- developer/src/tike/xml/help/contexthelp.xml | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/developer/src/tike/xml/help/contexthelp.xml b/developer/src/tike/xml/help/contexthelp.xml index 6a3dd4cef5b..00e4cf525b4 100644 --- a/developer/src/tike/xml/help/contexthelp.xml +++ b/developer/src/tike/xml/help/contexthelp.xml @@ -471,7 +471,8 @@

-

The Options dialog display several tabs such as General, Editor, Debugger, Character Map and Server. You can configure the environment of Keyman Developer here.

+

The Options dialog display several tabs such as General, Editor, Debugger, Character Map and Server. + You can configure the environment of Keyman Developer here.

 @@ -539,11 +540,13 @@ -

Sets the font for displaying comments text and strings in Keyman source files in single or double quotes.

+

Sets the font for displaying comments text and strings in Keyman source files in + single or double quotes.

 -

Sets the display theme and syntax highlighting options for the editor. A custom theme can be defined in a JSON file.

+

Sets the display theme and syntax highlighting options for the editor. A custom + theme can be defined in a JSON file.

 @@ -568,8 +571,9 @@ -

If you are debugging a keyboard, make a change to the keyboard, and recompile it, then the debugger needs to be - reset in order to get access to the new keyboard. Keyman Developer will normally prompt you to do this, but if you set +

If you are debugging a keyboard, make a change to the keyboard, and recompile it, + then the debugger needs to be reset in order to get access to the new keyboard. + Keyman Developer will normally prompt you to do this, but if you set this option, then it will reset the debugger automatically instead.

 @@ -583,7 +587,7 @@

Rebuilds the Unicode character database from source unicodedata.txt and blocks.txt. These files can be downloaded from the Unicode website at http://www.unicode.org/ucd/. This lets you update the character map with a newer version of Unicode. - Keyman Developer 10.0 was released with Unicode version 10.0 data.

+ Keyman Developer 17.0 was released with Unicode version 15.1 data.

@@ -600,7 +604,7 @@
  • Seamless integration with the IDE (Start, Stop, Live reload, Recompile...)
  • Port configuration
  • Allow testing cross devices
    • -
  • Wider range support for NGROK...
    • +
  • Support for ngrok to allow simple sharing of debug sessions across the Internet

    •