Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update images and instructions to 17.0 #1148

Merged
merged 11 commits into from
Apr 3, 2024
Binary file added cdn/dev/img/developer/170/ui/Debug_Menu.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added cdn/dev/img/developer/170/ui/Debug_Toolbar.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 7 additions & 9 deletions developer/17.0/context/debug.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Debug Window

![Debug window - Debug State](/cdn/dev/img/developer/100/ui/frmKeymanWizard_Debug_State.png)

The debug window is shown at the bottom of an keyboard editor when
The debug window is shown at the bottom of the keyboard editor when
debugging the keyboard. There are several user interface areas: The
debugger input window, the debugger status window, a debugger toolbar
(usually docked under the menu), and the status bar will show the
Expand All @@ -31,9 +31,9 @@ the screen, then only those that fit will be shown in the grid.

The debug menu and debug toolbar control the debugger.

![Debug toolbar](/cdn/dev/img/developer/100/ui/Debug_Toolbar.png)
![Debug toolbar](/cdn/dev/img/developer/170/ui/Debug_Toolbar.png)

![Debug menu](/cdn/dev/img/developer/100/ui/Debug_Menu.png)
![Debug menu](/cdn/dev/img/developer/170/ui/Debug_Menu.png)

Set/Clear breakpoint
: A breakpoint can be put on a line of code to ask Keyman Developer to
Expand Down Expand Up @@ -62,15 +62,13 @@ Run
into single step mode again.

Pause
: Use the Pause button or press Shift+Esc to pause the debugger. When
the debugger is paused, it will not accept any input, and ordinary
shortcut keys (Shift+F5, Alt+Tab, etc.) will function as usual.
Press Pause again to resume debugging.
: Use the Pause button or press <kbd>Shift</kbd> + <kbd>Esc</kbd> to pause the debugger. When
the debugger is paused, it will not accept any input, and ordinary shortcut keys (<kbd>Shift</kbd> + <kbd>F5</kbd>, <kbd>Alt</kbd> + <kbd>Tab</kbd>, etc.) will function as usual. Press Pause again to resume debugging.

System keyboard
<!-- System keyboard
: The system keyboard layout currently being used. You can test your
keyboard with a different underlying layout by selecting
**Select System Keyboard** from the **Debug** menu.
**Select System Keyboard** from the **Debug** menu. -->
Meng-Heng marked this conversation as resolved.
Show resolved Hide resolved

## Debug State box

Expand Down
221 changes: 123 additions & 98 deletions developer/17.0/context/keyboard-editor.md

Large diffs are not rendered by default.

52 changes: 38 additions & 14 deletions developer/17.0/context/model-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ editor are:
The following image shows the first tab of the editor, the Details tab.
Changes made to this tab are reflected immediately in the Source tab.

![Model Editor - Details tab](/cdn/dev/img/developer/130/ui/frmModelEditor_Details.png)
![Model Editor - Details tab](/cdn/dev/img/developer/170/ui/frmModelEditor_Details.png)

The fields here have corresponding definitions in the [.model.ts source file](../reference/file-types/model-ts), which can be seen in the
**Source** tab:
Expand All @@ -36,6 +36,26 @@ Word breaker
`default`, `ascii`, or `custom`. Corresponds to the `wordBreaker`
property in the [.model.ts source file](../reference/file-types/model-ts).

Insert after word
: Many languages insert a space after a word. Some languages, like Thai or Khmer, do not use spaces. To suppress the space, you may set insertAfterWord to the empty string:

```keyman
punctuation: {
insertAfterWord: "",
},
```

[Read more](../guides/lexical-models/advanced/punctuation#toc-customizing-insertafterword)

Quotation marks
: These are the quotation marks that surround the "keep" suggestion when it's displayed in the suggestion banner. [Read about Quotation marks here](../guides/lexical-models/advanced/punctuation#toc-customizing-quotesforkeepsuggestion).

Right-to-left script
: Check this box to indicate that the lexical-model is for a right-to-left script.

Language uses casing
: Tick this box for uppercase, capitalize, or any casing in the predicted word.

Comments
: This field corresponds to the first lines of comments in the model
source, and is visible only to the model designer.
Expand All @@ -49,7 +69,7 @@ Wordlists
model source. Corresponds to the `sources` property in the
[.model.ts source file](../reference/file-types/model-ts).

> Note:
> ### Note
If the [.model.ts](../reference/file-types/model-ts) file cannot
be parsed by the model editor, the field shown here will be read only
and you will need to make changes only in the **Source** tab. This can
Expand Down Expand Up @@ -83,7 +103,8 @@ earlier in the list.

![Model Editor - Wordlist tab - Code view](/cdn/dev/img/developer/130/ui/frmModelEditor_Wordlist_Code.png)

Note: The wordlist Code editor will accept the Tab key to insert a Tab
> ### Note
The wordlist Code editor will accept the Tab key to insert a Tab
character. In other code editors in Keyman Developer, the Tab key
inserts spaces.

Expand All @@ -97,7 +118,7 @@ programming language. The format of this file is documented in the

## Build tab

![Model Editor - Build tab](/cdn/dev/img/developer/130/ui/frmModelEditor_Build.png)
![Model Editor - Build tab](/cdn/dev/img/developer/170/ui/frmModelEditor_Build.png)

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

Expand All @@ -108,13 +129,13 @@ Compile Model
single Javascript file, named as shown in the **Target filename**
field.

Open Containing Folder
: Opens the folder which contains the model source files.
Open source, build, and project folder
: Opens the folder which contains the model source, build, and project files.

Add to Project
<!-- Add to Project
: If the model file is not already part of the project, adds it to the
project. (Note: this button can sometimes have the caption "Current
editor file".)
editor file".) -->

### Test Lexical Model in Web Browser

Expand All @@ -131,21 +152,24 @@ Keyboard for testing

Test Lexical Model
: Starts the Keyman Developer Web Server for the current lexical
model.

Addresses
: Lists the various IP addresses and hostnames that Keyman Developer
model. This will list the various IP addresses and hostnames that Keyman Developer
is listening on

Open debugger in local browser
Configure...
: Pressing this allows the [Options](./options) dialog to pop-up.

Open in browser
: Starts your default browser with the selected address to allow
testing of the model directly

Send addresses to email
Send to email...
: Sends the list of web addresses as an email so that you can more
easily open the test site on your mobile device, or share with
someone else on your network.

Copy link
: Once the IP addresses are shown, feel free to copy any one of the links.

To test on other platforms, open one of the debug host addresses listed
on your device. Your device will need to be on the same network as the
Keyman Developer computer.
Expand Down
19 changes: 7 additions & 12 deletions developer/17.0/context/new-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,23 @@
title: New Project Dialog
---

![New Project dialog](/cdn/dev/img/developer/120/ui/frmNewProject.png)
![New Project dialog](/cdn/dev/img/developer/170/ui/frmNewProject.png)

Creates a new keyboard or lexical model project, optionally from a template or by importing from another source.

## Basic
## Keyman keyboard

Creates a keyboard project that matches the folder structure used in the Keyman [keyboards repository](https://github.com/keymanapp/keyboards) and includes all [basic files](/developer/keyboards/) needed for a keyboard project. Clicking OK will open the [New Project Parameters dialog](new-project-parameters).

## Blank
## LDML Keyboard
Creates a keyboard project that matches the folder structure used in the Keyman [keyboards repository](https://github.com/keymanapp/keyboards) and includes all [basic files](/developer/keyboards/) needed for a LDML keyboard project. Clicking OK will open the [New LDML Keyboard Project Parameters dialog](new-ldml-project-parameters).

Creates a new empty keyboard project.
## Import Windows Keyboard

Creates a keyboard project that matches the folder structure used in the Keyman [keyboards repository](https://github.com/keymanapp/keyboards) and includes all [basic files](/developer/keyboards/) needed for a keyboard project, then converts and imports the Windows keyboard that you select into the project. Clicking OK will open the [New Project Parameters dialog](new-project-parameters).

## Wordlist Lexical Model

Creates a lexical model project that matches the folder structure used in the Keyman [lexical models repository](https://github.com/keymanapp/lexical-models) and includes all basic files needed for a lexical model project. Clicking OK will open the [New Lexical Model Project Parameters dialog](new-lm-project-parameters).

## Blank Lexical Model

Creates a new empty lexical model project.

## Import Windows Keyboard

Creates a keyboard project that matches the folder structure used in the Keyman [keyboards repository](https://github.com/keymanapp/keyboards) and includes all [basic files](/developer/keyboards/) needed for a keyboard project, then converts and imports the Windows keyboard that you select into the project. Clicking OK will open the [New Project Parameters dialog](new-project-parameters).

The **Basic** and **Import Windows Keyboard** modes can also be driven by command line with [KMConvert](kmconvert).
59 changes: 36 additions & 23 deletions developer/17.0/context/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,53 @@ title: Options Dialog

## General tab

![Options dialog - General tab](/cdn/dev/img/developer/120/ui/frmOptions_General.png)
![Options dialog - General tab](/cdn/dev/img/developer/170/ui/frmOptions_General.png)

The following options are configurable in TIKE in the **General** tab:

Show splash screen
Open keyboard files in source view.
: Instead of opening a keyboard file in the Details tab, open directly
into the Layout tab, Source pane.

External Editor Path
: 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.

<!-- Show splash screen
: If checked, displays a splash screen when Keyman Developer is
started.
started.

Allow multiple instances of TIKE
: Allow Keyman Developer to be started multiple times, instead of
loading other files in the current instance when selected from
Explorer.

Open keyboard files in source view.
: Instead of opening a keyboard file in the Details tab, open directly
into the Layout tab, Source pane.

Save visual keyboard source files (.kvks) as XML
: Keyman Developer will default to saving .kvks files as XML when
editing, which makes them easier to share in version control systems
such as Git. The compiled .kvk files will be binary and will work
with earlier versions of Keyman Desktop. However, if you are sharing
keyboard source files with developers using earlier versions of
Keyman Developer, you should clear this checkbox so they can load
the files.

External Editor
: 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.
the files.-->

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

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

## Editor tab

![Options dialog - Editor tab](/cdn/dev/img/developer/120/ui/frmOptions_Editor.png)
![Options dialog - Editor tab](/cdn/dev/img/developer/170/ui/frmOptions_Editor.png)

Use tab character
: Sets whether to use the Tab character or spaces for indents.
Expand All @@ -76,7 +76,7 @@ Editor theme

## Debugger tab

![Options dialog - Debugger tab](/cdn/dev/img/developer/120/ui/frmOptions_Debugger.png)
![Options dialog - Debugger tab](/cdn/dev/img/developer/170/ui/frmOptions_Debugger.png)

Enable test window (from version 5.0)
: Enables the Keyman 5-style Test window instead of the debugger.
Expand All @@ -94,9 +94,12 @@ Automatically recompile if no debug information available
: When the debugger starts, rebuild a keyboard without prompting if
the keyboard has no debug symbols included.

Automatically reset debugger before recompiling
: *update is coming*

## Character Map tab

![Options dialog - Character Map tab](/cdn/dev/img/developer/120/ui/frmOptions_CharacterMap.png)
![Options dialog - Character Map tab](/cdn/dev/img/developer/170/ui/frmOptions_CharacterMap.png)

Find character under cursor automatically
: The character beneath the cursor in the edit window will be
Expand All @@ -111,4 +114,14 @@ Update database
: 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/](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.
[http://www.unicode.org/ucd/](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.

## Server tab

![Options dialog - Server tab](/cdn/dev/img/developer/170/ui/frmOptions_Server.png)

Keyman Developer Server
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe PR keymanapp/keyman#6073 documents features of the Keyman Developer Server which is used for testing and debugging keyboards.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a lot of info, so that could go on separate PR if you want

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I will update this section on another PR.

: *update soon*

List local URLs for Server
: *update soon*
18 changes: 0 additions & 18 deletions developer/17.0/context/startup.md

This file was deleted.