Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 8 additions & 0 deletions developer/20.0/context/about-tike.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: About Dialog
---

![About dialog](../images/ui/frmAboutTike.png)

The About dialog displays copyright and registration information for
Keyman Developer, and has a link to the Keyman website.
136 changes: 136 additions & 0 deletions developer/20.0/context/character-map.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@
---
title: Using the Character Map
---

![Character Map tool](../images/ui/frmCharacterMapNew.png)

To display the Character Map:

- Press <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>c</kbd>
- Select **View** &#8594; **Character Map**

The Character Map will appear by default docked to the right hand side
of the IDE but can be undocked or re-docked on any side of the window.

### Using the Character Map

To insert a character:
1. Position the text cursor where you want to insert the character
2. Locate the desired character in the Character Map and insert it by:
- selecting the character and pressing the Enter key, or
- double-clicking on the character, or
- right-clicking on the character and selecting Insert Character.

> ### Note
If the Insert Mode is set to Code or Name, pressing Enter or
double-clicking on the character will insert the Unicode code or
name of the character, not the character itself. These options are
most useful when writing or editing keyboard source files (.KMN).

### Insert Modes

There are three insert modes: Code, Character and Name:

- Code: inserts the character's Unicode code
- Character: inserts the character itself
- Name: inserts the character's Unicode name

To change the insert mode:

1. Right-click on the Character Map.
2. Highlight the Insert Mode submenu.
3. Choose the desired mode from the Insert Mode submenu.

### Character Map Options

When you right click on the Character Map, the following menu options
are displayed:

Insert Character
: Inserts the selected character at the cursor position in your
document.

Filter...
: Displays the Filter dialog box. See [Filtering](#toc-filtering) below.

Goto...
: Displays the Goto dialog box. See Using [Goto](#toc-goto) below.

Font...
: Allows you to choose a different font for viewing the Character Map. <br/>
Note: This does not affect the font being used in your document!

Insert Mode
: Allows you to select the character insert mode you want. See [Insert
Modes](#toc-insert-modes) above.

Display Quality
: Allows you to select a different font display quality for the
Character Map. The options are: <br/>
- Plain: no font smoothing
- Antialiased: uses the Windows standard font smoothing
- ClearType: uses the Windows ClearType font smoothing method

### Characters and Fonts

When a character is not available in the selected font, the Character
Map will fall back to **Code2000**, **Code2001**, **Code2002**, **Arial Unicode MS** and
**Lucida Sans Unicode** fonts. If the character is not found in these
fallback fonts, the Character Map will use font linking to attempt to
find a character from other fonts installed on the system, and as a last
resort, will show a square box if no suitable font can be found.

If a character is not displayed from other than the selected font, it
will be shown in blue instead of black.

### Filtering

![Character Map Filter dialog](../images/ui/frmCharacterMapFilter.png)

The Character Map can be filtered by Unicode character name or character
range. Filters can be entered in the Filter By field at the bottom of
the Character Map; a quick reference user interface dialog to help you
edit the filter is available by clicking the \[...\] button.

When no filter is applied, the Character Map will show all characters
from the Unicode 8.0 standard.

All filter strings are case insensitive. Character names use the letters
`A-Z`, numerals `0-9`, and punctuation underscore (`_`) and hyphen
(`-`).

Spaces between words in the filter are represented either by underscore
(`_`) or space (` `) and can be used interchangeably.

A filter can be for a range or on the Unicode Character Name.

The filter format for a range is: `[U+]XXXX-[U+]YYYY`, where `U+` is
optional, `XXXX` is the starting Unicode value and `YYYY` is the
finishing Unicode value.

The filtering options for Unicode Character Names are:

### Examples

| | |
|--------------------------|-------------------------|
| Filter | Result |
| `LATIN CAPITAL LETTER A` | Finds all Latin capital A variations |
| `LATIN * LETTER A` | finds all Latin capital and lower case A variations |
| `LATIN * LETTER [AEIOU]` | finds all Latin A,E,I,O or U vowel combinations |
| `<Thai` | finds the Thai Unicode block |
| `>LAO` | finds all characters with names starting in "LAO" in the current font |
| `YI_` | finds all characters with names starting in "YI " - you must use `_` (underscore) and not `( )` space at the end of a search string. <br/> Note that without the `_`, this search also matches YIN_YANG. |
| `LATIN * LETTER A$` | finds only "a" and "A" |
| `1000-119F` | finds all characters between U+1000 and U+119F (inclusive) - the Myanmar alphabet in this case |

### Goto

The Goto tool can be used to move directly to a specific Unicode
character or value.

1. Right click on a character and select Goto. The **Enter Unicode character value or name** dialog box will be displayed.
2. Enter the Unicode character value - e.g. `006B` or `U+006B` OR enter the start of the character name, e.g. `LAO_LETTER` will go
to **LAO_LETTER_KO**, being the first character that matches. You
can substitute spaces for underscores if you prefer.
3. Click OK. The character map will attempt to move to the character you specified.
34 changes: 34 additions & 0 deletions developer/20.0/context/clone-github-project-parameters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Clone GitHub Project Parameters Dialog
---

![Clone GitHub Project Parameters dialog](../images/ui/frmCloneGitHubProjectParameters.png)

Allows you to clone a project from a GitHub repository, giving the project a
new id, and organizing project files following the
[file layout](/developer/keyboards/) used in the
[Keyman keyboards repository](https://github.com/keymanapp/keyboards).

Keyboard and lexical model projects can be cloned.

Projects can also be cloned from the command line with [`kmc copy`](kmc).

### Parameters

GitHub URL:
: The full URL to a source project .kpj file to copy, on github.com.

Destination path
: Specifies the base path where the project folder will be created.
The project folder name will be the keyboard ID. If the folder
already exists, then you will be prompted before Keyman Developer
overwrites files inside it.

New project ID
: The base filename of the keyboard/model, project and package. This must
conform to the Keyman keyboard or lexical model identifier rules.

Relocate external files into new project folder
: When selected, if the project references files that are not inside the same
folder as the .kpj file, move these files into an `external` subfolder

37 changes: 37 additions & 0 deletions developer/20.0/context/clone-keyman-cloud-project-parameters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Clone Keyman Cloud Project Parameters Dialog
---

![Clone Keyman Cloud Project Parameters dialog](../images/ui/frmCloneKeymanCloudProjectParameters.png)

Allows you to clone a project from Keyman Cloud, giving the project a
new id, and organizing project files following the
[file layout](/developer/keyboards/) used in the
[Keyman keyboards repository](https://github.com/keymanapp/keyboards).

Projects can also be cloned from the command line with [`kmc copy`](kmc).

Only keyboard projects can be cloned from Keyman Cloud at this time via this
dialog. Lexical model projects can be cloned from Keyman Cloud via the command
line.

Search for a keyboard using the standard keyman.com keyboard search in the upper
pane. Once you select a keyboard, and fill in the New Project Details, the OK
button will be enabled to allow you to finish the cloning process.

### Parameters

Destination path
: Specifies the base path where the project folder will be created.
The project folder name will be the keyboard ID. If the folder
already exists, then you will be prompted before Keyman Developer
overwrites files inside it.

New project ID
: The base filename of the keyboard, project and package. This must
conform to the Keyman keyboard identifier rules.

Relocate external files into new project folder
: When selected, if the project references files that are not inside the same
folder as the .kpj file, move these files into an `external` subfolder

34 changes: 34 additions & 0 deletions developer/20.0/context/clone-local-project-parameters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Clone Local Project Parameters Dialog
---

![Clone Local Project Parameters dialog](../images/ui/frmCloneLocalProjectParameters.png)

Allows you to clone a project from your local filesystem, giving the project a
new id, and organizing project files following the
[file layout](/developer/keyboards/) used in the
[Keyman keyboards repository](https://github.com/keymanapp/keyboards).

Keyboard and lexical model projects can be cloned.

Projects can also be cloned from the command line with [`kmc copy`](kmc).

### Parameters

Source project filename
: The full path of the source project .kpj file to copy.

Destination path
: Specifies the base path where the project folder will be created.
The project folder name will be the keyboard ID. If the folder
already exists, then you will be prompted before Keyman Developer
overwrites files inside it.

New project ID
: The base filename of the keyboard/model, project and package. This must
conform to the Keyman keyboard or lexical model identifier rules.

Relocate external files into new project folder
: When selected, if the project references files that are not inside the same
folder as the .kpj file, move these files into an `external` subfolder

Loading
Loading