mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 00:15:32 +00:00
Merge pull request #14669 from keymanapp/chore/windows/desktop
This commit is contained in:
commit
e615139348
23 changed files with 55 additions and 53 deletions
|
|
@ -602,7 +602,7 @@ Open source, build, and project folder
|
|||
|
||||
### Windows, macOS, and Linux Targets
|
||||
|
||||
If your keyboard is designed to target Windows and macOS, then the
|
||||
If your keyboard is designed to target Windows, Linux, and macOS, then the
|
||||
following buttons will also be visible:
|
||||
|
||||
Install
|
||||
|
|
|
|||
|
|
@ -123,7 +123,7 @@ be displayed before the package is installed as information about the package.
|
|||
|
||||
: Version numbers should be in the form `major.minor[.patch]`. Patch is optional
|
||||
but is helpful for small bug fix releases. Each of the sections of the version
|
||||
should be an integer. Keyman Desktop does integer comparisons on the version
|
||||
should be an integer. Keyman for Windows does integer comparisons on the version
|
||||
number components, so, for example, version 2.04 is regarded as newer than
|
||||
version 2.1. Alphabetic or date formats should be avoided as the installer for
|
||||
the keyboard cannot determine which version is older reliably.
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ The DLL should be placed in any of the following locations:
|
|||
The best option is the first, as you can then include the DLL in a
|
||||
Keyman package for easy installation and uninstallation.
|
||||
|
||||
Full x64 support for IMX DLLs was introduced in Keyman Desktop
|
||||
Full x64 support for IMX DLLs was introduced in Keyman for Windows
|
||||
8.0.333.0. An x64 version of the DLL may be included simply by giving it
|
||||
the file extension .x64.dll, with the same base name as the x86 DLL.
|
||||
Keyman will call the appropriate DLL.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
title: Distributing keyboards
|
||||
---
|
||||
|
||||
- [Package development tutorial](tutorial) (Keyman Desktop, Keyman for macOS, Keyman for mobile apps)
|
||||
- [Package development tutorial](tutorial) (Keyman for Windows, Keyman for macOS, Keyman for mobile apps)
|
||||
- [Distribute keyboards to Keyman applications](packages)
|
||||
|
||||
## See also
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@ archive.
|
|||
You can distribute keyboards and lexical models in package files, but
|
||||
you can't include both in the same package file.
|
||||
|
||||
#### Keyman Desktop
|
||||
#### Keyman for Windows
|
||||
|
||||
Keyman Desktop can install package files, including installing fonts,
|
||||
Keyman for Windows can install package files, including installing fonts,
|
||||
creating Start Menu shortcuts, and adding appropriate registry entries
|
||||
for uninstallation.
|
||||
|
||||
|
|
@ -37,20 +37,20 @@ in Keyman Configuration.
|
|||
#### Keyman for Android and Keyman for iPhone and iPad
|
||||
|
||||
Keyman mobile applications can install the same package files as Keyman
|
||||
Desktop, as long as the package includes keyboards for touch layouts.
|
||||
for Windows, as long as the package includes keyboards for touch layouts.
|
||||
|
||||
## Package file contents
|
||||
|
||||
A package can have a variety of different files contained within. The
|
||||
following files and file types are recognized by the package installer:
|
||||
|
||||
\*.kmx (Desktop and macOS only)
|
||||
\*.kmx (Keyman for Windows, Linux, and macOS only)
|
||||
: Keyboard files. Each of these will be installed. Keyman
|
||||
Configuration will not allow installation or uninstallation of a
|
||||
single keyboard from a package. They will always be treated as a
|
||||
group for installation and uninstallation.
|
||||
|
||||
\*.kvk (Desktop and macOS only)
|
||||
\*.kvk (Keyman for Windows, Linux, and macOS only)
|
||||
: On Screen Keyboard files, associated with each keyboard file.
|
||||
|
||||
\*.js (mobile only)
|
||||
|
|
@ -91,7 +91,7 @@ kmp.json
|
|||
|
||||
> ### Tip
|
||||
Read [Step 2: Organizing the Keyboard Files](../../../keyboards/github/step-2)
|
||||
to know which files to include or exclude in the keybord folder.
|
||||
to know which files to include or exclude in the keybord folder.
|
||||
|
||||
Once the keyboard package .kmp file is created, you can share them via
|
||||
external storage devices (USB drive, SD card, etc). You can also share
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ Welcome! In this tutorial, you will learn how to create a
|
|||
of files, compressed into a single file, just like a ZIP file. It is
|
||||
designed to make installation of keyboards, fonts and related
|
||||
documentation straightforward for the end user. When done, the package
|
||||
can be installed into Keyman Desktop through a simple dialog. Keyman for
|
||||
can be installed into Keyman for Windows through a simple dialog. Keyman for
|
||||
mobile apps can also download and install keyboards through the keyboard
|
||||
package.
|
||||
|
||||
|
|
@ -33,4 +33,4 @@ package based on the Quick French keyboard from the [keyboard tutorial](../../de
|
|||
Let's get started! Move on to the next topic to begin the first step,
|
||||
choosing what to include in the package.
|
||||
|
||||
[Step 1: What do we include?](step-1)
|
||||
[Step 1: What do we include?](step-1)
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ many details as you can on this page.
|
|||
Package Name
|
||||
|
||||
: The Package Name will be displayed in the package install dialog,
|
||||
and within Keyman Desktop Configuration, wherever the package is
|
||||
and within Keyman Configuration, wherever the package is
|
||||
referred to.
|
||||
|
||||
Readme File
|
||||
|
|
@ -31,7 +31,7 @@ Version
|
|||
Version numbers should be in the form `major.minor[.subversion]`.
|
||||
Subversion is optional but is helpful for small bug fix releases.
|
||||
Each of the sections of the version should be an integer. Keyman
|
||||
Desktop does integer comparisons on the version numbers, so, for
|
||||
for Windows does integer comparisons on the version numbers, so, for
|
||||
example, version `2.01` is regarded as older than version `2.2`.
|
||||
Alphabetic or date formats should be avoided as the installer for
|
||||
the keyboard cannot determine which version is older reliably.
|
||||
|
|
|
|||
|
|
@ -31,19 +31,19 @@ package. Enter a description for the shortcut, and select the program or
|
|||
file to start from the Program list. Four predefined program entries
|
||||
(Start Product), (Product Configuration), (Product Help) and (About
|
||||
Product) will be translated into the appropriate shortcuts to start
|
||||
Keyman Desktop tasks as described.
|
||||
Keyman for Windows tasks as described.
|
||||
|
||||
> ### Note
|
||||
In Keyman 6 and earlier, the predefined targets $KEYMAN\keyman.exe and
|
||||
$KEYMAN\kmshell.exe were available. These are translated to (Start
|
||||
Product) and (Product Configuration), respectively, in Keyman Desktop
|
||||
Product) and (Product Configuration), respectively, in Keyman
|
||||
7.0 and later versions.
|
||||
|
||||
<!-- a seperator -->
|
||||
|
||||
> ### Tip
|
||||
Packages are not listed in the Control Panel Add/Remove Programs applet
|
||||
with Keyman Desktop 7.0 and later versions. Packages can be uninstalled
|
||||
through the Start Menu shortcut or from Keyman Desktop Configuration.
|
||||
with Keyman 7.0 and later versions. Packages can be uninstalled
|
||||
through the Start Menu shortcut or from Keyman Configuration.
|
||||
|
||||
[Step 6: Compiling, testing and distributing a Package](step-6)
|
||||
[Step 6: Compiling, testing and distributing a Package](step-6)
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ and tutorials, and full reference information.
|
|||
## Reference
|
||||
- [Keyman keyboard language reference](../language/reference)
|
||||
- [Keyman keyboard language guide](../language/guide)
|
||||
- [Customising Keyman Engine for Desktop](../engine/desktop)
|
||||
- [Customising Keyman Engine for Windows](../engine/windows)
|
||||
- [Error codes, File types and Tools](reference/)
|
||||
- [Keyman Developer user interface](context/)
|
||||
- [Additional Notes](main/)
|
||||
|
|
@ -31,8 +31,8 @@ and tutorials, and full reference information.
|
|||
|
||||
- [Keyboard Quality White Paper](/developer/whitepaper1.1.pdf)
|
||||
- [Knowledge Base](/kb)
|
||||
- [Keyman Desktop Help](/products/desktop)
|
||||
- [Keyman Engine for Desktop](/developer/engine/desktop/current-version/)
|
||||
- [Keyman for Windows Help](/products/windows)
|
||||
- [Keyman Engine for Windows](/developer/engine/windows/current-version/)
|
||||
- [Keyman Engine for Web](/developer/engine/web/)
|
||||
- [Keyman Engine for iPhone and iPad](/developer/engine/iphone-and-ipad/current-version/)
|
||||
- [Keyman Engine for Android](/developer/engine/android/current-version/)
|
||||
|
|
@ -4,14 +4,14 @@ title: Setup Bootstrapper
|
|||
|
||||
# Setup Bootstrapper
|
||||
|
||||
The Keyman Desktop installation bootstrapper is a self-extracting executable file that contains a Windows Installer technology MSI file, and optionally keyboards. The bootstrapper is used whenever a package installer is created.
|
||||
The Keyman for Windows installation bootstrapper is a self-extracting executable file that contains a Windows Installer technology MSI file, and optionally keyboards. The bootstrapper is used whenever a package installer is created.
|
||||
|
||||
The bootstrapper:
|
||||
|
||||
1. Checks the system before starting the installation to ensure that all prerequisites are met, and optionally downloads and installs the prerequisites.
|
||||
2. Optionally checks online for an updated version of Keyman Desktop before installing.
|
||||
3. Starts the Keyman Desktop Windows Installer MSI package.
|
||||
2. Optionally checks online for an updated version of Keyman for Windows before installing.
|
||||
3. Starts the Keyman for Windows Windows Installer MSI package.
|
||||
4. Installs any keyboards included.
|
||||
5. Starts Keyman Desktop after the install completes.
|
||||
5. Starts Keyman for Windows after the install completes.
|
||||
|
||||
For command line parameters and more information see [Knowledge Base article KMKB0035](/kb/35)
|
||||
|
|
|
|||
|
|
@ -120,8 +120,8 @@
|
|||
</LanguageReference>
|
||||
|
||||
<LanguageReference Name="beep" Title="beep">
|
||||
<p>The beep statement produces a beep with the system speaker when the rule is matched.
|
||||
In Keyman Desktop, beep will produce the sound specified by "Asterisk" in Windows Sounds
|
||||
<p>The beep statement produces a beep with the system speaker when the rule is matched.
|
||||
In Keyman for Windows, beep will produce the sound specified by "Asterisk" in Windows Sounds
|
||||
configuration.</p><br></br>
|
||||
<p>Syntax</p>
|
||||
<div class="code">
|
||||
|
|
|
|||
|
|
@ -84,7 +84,7 @@ function _publish_to_downloads_keyman_com() {
|
|||
# TODO: is this still needed?
|
||||
if [[ -f "release/${KEYMAN_VERSION}/${DEBUG_ZIP}" ]]; then
|
||||
cp "release/${KEYMAN_VERSION}/${DEBUG_ZIP}" "${UPLOAD_PATH}"
|
||||
write_download_info "${UPLOAD_PATH}" "${DEBUG_ZIP}" "Keyman Desktop and Keyman Developer debug files" zip win
|
||||
write_download_info "${UPLOAD_PATH}" "${DEBUG_ZIP}" "Keyman for Windows and Keyman Developer debug files" zip win
|
||||
fi
|
||||
|
||||
cd upload
|
||||
|
|
|
|||
|
|
@ -36,11 +36,11 @@ needed to display correctly.
|
|||
| Tibetan |  | བོད་ཡུལ། | བོད་ཡུལ། |
|
||||
|
||||
---
|
||||
**If the embedded font display for a language is not exactly the same as in the corresponding image,**
|
||||
**If the embedded font display for a language is not exactly the same as in the corresponding image,**
|
||||
for example, with script characters shown
|
||||
but incorrectly positioned or ordered, you will need to install the
|
||||
Keyman Desktop package for your language onto your computer. You can
|
||||
download the Keyman Desktop package by clicking the "Help on this
|
||||
Keyman for Windows package for your language onto your computer. You can
|
||||
download the Keyman for Windows package by clicking the "Help on this
|
||||
keyboard" link in the On Screen Keyboard. This is likely to be observed
|
||||
with scripts such as Burmese, Khmer or Tibetan if your operating system
|
||||
does not fully support the display of the font used for those scripts.
|
||||
|
|
|
|||
|
|
@ -29,8 +29,8 @@ the images on the right, please check the following:
|
|||
- If you copy and paste text that you have typed in KeymanWeb into
|
||||
another application such as Microsoft Word, you may find that it
|
||||
does not display. In this case, you will need to installing the
|
||||
Keyman Desktop package for the keyboard onto your computer. You can
|
||||
download the Keyman Desktop package by clicking the "Help on this
|
||||
Keyman for Windows package for the keyboard onto your computer. You can
|
||||
download the Keyman for Windows package by clicking the "Help on this
|
||||
keyboard" link in the On Screen Keyboard.
|
||||
- An [embedded font test page](embedded_fonts) is available for further testing of embedded font support on your computer.
|
||||
|
||||
|
|
@ -43,8 +43,8 @@ the images on the right, please check the following:
|
|||
If you find that you can see the characters for a language on screen,
|
||||
but they don't display quite right, you may be experiencing a limitation
|
||||
in your operating system. An example of this is visible in the Tibetan
|
||||
script on the right. Installing Keyman Desktop or Keyman for Mac may
|
||||
help resolve these issues.
|
||||
script on the right. Installing Keyman for Windows, Keyman for Linux,
|
||||
or Keyman for macOS may help resolve these issues.
|
||||
|
||||
<span id="two"></span>
|
||||
|
||||
|
|
@ -89,4 +89,4 @@ please check the following:
|
|||
|
||||
If you are experiencing continued difficulty in using KeymanWeb and have not been able to find a solution on this page, [click here](/contact).
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,8 @@
|
|||
/**
|
||||
* Please note that this is an experimental handwritten keyboard designed for initial testing of modifier chirality support for KeymanWeb.
|
||||
* As it is handcoded, it uses multiple codesize optimization techniques that Keyman Developer simply does not and will not employ, and it
|
||||
* will only work with KeymanWeb based implementations. (Not supported for Keyman Desktop or Keyman for Mac.)
|
||||
* will only work with KeymanWeb based implementations. (Not supported for Keyman for Windows,
|
||||
* Keyman for Linux, or Keyman for macOS.)
|
||||
*
|
||||
* (This keyboard was written before Developer's implementation of chirality support and was used to bootstrap KeymanWeb chirality, serving
|
||||
* as the initial wave of testing.)
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ for Windows API. The `IKeyman` interface can be instantiated with the
|
|||
### VBScript
|
||||
|
||||
This example can be saved with a .vbs extension to run through Windows
|
||||
Scripting. This is similar to the uninstall script that Keyman Desktop
|
||||
Scripting. This is similar to the uninstall script that Keyman for Windows
|
||||
generates for packages which have a Start Menu Uninstall entry.
|
||||
|
||||
``` basic
|
||||
|
|
@ -83,7 +83,7 @@ Set kmcom = CreateObject("keymanapi.Keyman")
|
|||
n = kmcom.Packages.IndexOf("SamplePackage")
|
||||
if n >= 0 then
|
||||
Set package = kmcom.Packages(n)
|
||||
if msgbox("Uninstall package "+package.Description+"?", vbOKCancel, "Keyman Desktop") = vbOK then
|
||||
if msgbox("Uninstall package "+package.Description+"?", vbOKCancel, "Keyman for Windows") = vbOK then
|
||||
package.Uninstall(True)
|
||||
end if
|
||||
else
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ title: IKeymanControl::IsOnlineUpdateCheckOpen() Method
|
|||
## Introduction
|
||||
|
||||
The `IKeymanControl::IsOnlineUpdateCheckOpen()` method returns `True` if
|
||||
the Keyman Desktop online update check tool is currently running.
|
||||
the Keyman for Windows online update check tool is currently running.
|
||||
|
||||
## Specification
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ title: IKeymanControl::IsTextEditorOpen() Method
|
|||
## Introduction
|
||||
|
||||
The `IKeymanControl::IsTextEditorOpen()` method returns `True` if the
|
||||
Keyman Desktop text editor is currently running.
|
||||
Keyman for Windows text editor is currently running.
|
||||
|
||||
## Specification
|
||||
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: IKeymanControl::OpenHelp() Method
|
|||
|
||||
## Introduction
|
||||
|
||||
The `IKeymanControl::OpenHelp()` method opens Keyman Desktop help at the
|
||||
The `IKeymanControl::OpenHelp()` method opens Keyman for Windows help at the
|
||||
specified topic.
|
||||
|
||||
## Specification
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: IKeymanControl::OpenTextEditor() Method
|
|||
|
||||
## Introduction
|
||||
|
||||
The `IKeymanControl::OpenTextEditor()` method opens Keyman Desktop Text
|
||||
The `IKeymanControl::OpenTextEditor()` method opens Keyman for Windows Text
|
||||
Editor.
|
||||
|
||||
## Specification
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ title: IKeymanControl::OpenUpdateCheck() Method
|
|||
|
||||
## Introduction
|
||||
|
||||
The `IKeymanControl::OpenUpdateCheck()` method opens Keyman Desktop
|
||||
The `IKeymanControl::OpenUpdateCheck()` method opens Keyman for Windows
|
||||
online update check tool.
|
||||
|
||||
## Specification
|
||||
|
|
|
|||
|
|
@ -9,11 +9,11 @@ and provides methods to trigger Keyman Engine's user interface.
|
|||
|
||||
## Interface Hierarchy
|
||||
|
||||
`IDispatch`
|
||||
`IDispatch`
|
||||
|
||||
> [`IKeymanObject`](../IKeymanObject)
|
||||
> [`IKeymanObject`](../IKeymanObject)
|
||||
>
|
||||
> > **`IKeymanControl`**
|
||||
> > **`IKeymanControl`**
|
||||
|
||||
|
||||
## Properties
|
||||
|
|
@ -45,13 +45,13 @@ and provides methods to trigger Keyman Engine's user interface.
|
|||
<!-- -->
|
||||
|
||||
[`IsOnlineUpdateCheckOpen()`](IsOnlineUpdateCheckOpen)
|
||||
: Returns `True` if the Keyman Desktop online update check tool is
|
||||
: Returns `True` if the Keyman for Windows online update check tool is
|
||||
currently running.
|
||||
|
||||
<!-- -->
|
||||
|
||||
[`IsTextEditorOpen()`](IsTextEditorOpen)
|
||||
: Returns `True` if the Keyman Desktop text editor is currently
|
||||
: Returns `True` if the Keyman for Windows text editor is currently
|
||||
running.
|
||||
|
||||
<!-- -->
|
||||
|
|
@ -72,17 +72,17 @@ and provides methods to trigger Keyman Engine's user interface.
|
|||
<!-- -->
|
||||
|
||||
[`OpenHelp()`](OpenHelp)
|
||||
: Opens Keyman Desktop help at the specific topic.
|
||||
: Opens Keyman for Windows help at the specific topic.
|
||||
|
||||
<!-- -->
|
||||
|
||||
[`OpenTextEditor()`](OpenTextEditor)
|
||||
: Opens Keyman Desktop text editor.
|
||||
: Opens Keyman for Windows text editor.
|
||||
|
||||
<!-- -->
|
||||
|
||||
[`OpenUpdateCheck()`](OpenUpdateCheck)
|
||||
: Opens Keyman Desktop online update check tool.
|
||||
: Opens Keyman for Windows online update check tool.
|
||||
|
||||
<!-- -->
|
||||
|
||||
|
|
|
|||
|
|
@ -14,5 +14,6 @@ versions 14.0 and up.
|
|||
|
||||
## See also
|
||||
|
||||
- [Keyman Engine for Windows 14.0-17.0](/developer/engine/desktop/14.0/)
|
||||
- [Keyman Engine for Desktop 10.0-13.0](/developer/engine/desktop/10.0/)
|
||||
- [Keyman Engine for Desktop 9.0](/developer/engine/desktop/9.0/)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue