Distribution Editor

The Distribution Editor allows you to create an installer for a product based on Keyman Engine for Windows. This component is part of the Branding Pack. You do not need to create an installer for a Keyman Desktop package, only if you are creating your own product.

See the Distribution Guide and Tutorial contained therein for more detail on the Distribution Editor.

• Distribution Guide
• Windows Installer XML (WiX)

Note: If you copy an installer source file, you must delete the GUID (globally unique identifier) section from the file because the GUIDs are specific to that particular installer file. Keyman Developer will then regenerate the GUIDs as needed.

Licence tab

This tab selects the branding .kct file that should determine the licensing and product for this installer. Keyboards compiled into this installer either directly or indirectly through a package installer will be rebased onto this .kct file's ProductID and will only be installable into this product.

It is possible to create multiple installers with the same branding .kct file, but this is not recommended, because they will not coexist cleanly on the same system when installing or uninstalling.

Files tab

This tab lists all the files that are required for the install. The Keyman Engine itself will be added during compilation and does not need to be included here. If addins are available for embedding, they will be listed in the Addins list box. The only required file is the branding .kct file, which is specified on the Licence tab.

A EULA file should be included, in .rtf format.

Typically .kmp packages will not be included here, but rather a bundled installer will be created with the Package Installer functionality in the Package Wizard.

Details tab

This tab defines the product-specific metadata which will be embedded into the .msi file. All fields are required, except for EULA, Command line, and Locale Folder.

Destination path

Defines the default install folder for the product. This will be in the (x86) version of Program Files.

EULA

Defines a .rtf format End User License Agreement. If one is not specified, the Keyman Desktop EULA will be used by default.

Product Name

The name of the product, extracted from the .kct branding file by default.

Version

The installer version. This must be a dotted triplet of integers - major, minor, patch, and must always increment. That is, 1.0.1 > 1.0.0, and 1.3.0 > 1.2.9, and 1.0.10 > 1.0.2. The version number must always be updated when any changes are made to any files in an installer, if previous versions are already in use.

Copyright

Your product copyright

Author

The author of the product. This can be a person's name or a company name.

E-mail address

The support email address for the product. This may be displayed in Windows user interface.

Web Site

The home page for the product, including the http:// or https:// prefix.

Command line

Details a specific program to run after installation.

Locale folder

If you have translations for your product, reference the source folder here.

Shortcuts tab

This tab details the shortcuts that will be created when you install the product. The typical shortcuts will include (Start Product) and (Product Configuration).

Source tab

The source of the .kpp file in XML format. All details from previous tabs can be seen in the Source tab, and changes in either the Source tab or the other tabs will be reflected immediately in the other.

Compile tab

Compile product

Compile product generates an .msi file, with a licensed and copy-protected product file.

Install product

Runs the installer for test purposes.

Export to WiX

Exports the intermediate .wxs files for this product so that the installer can be further customised. This is a one-way operation; changes to the product will require generating the WiX files again.

Upload to Tavultesoft

Allows you to upload the completed installer to Tavultesoft for distribution; typically you will share a Package Installer instead.

Open Containing Folder

Opens the folder where the .kpp file is stored in Windows Explorer.

Add to Project

Adds the current product file to the active project in Keyman Developer.