Keyboard Support

Contact and Search Homepage

Header bottom

Other versions
Version 9.0

On this page

Branding Editor

The Branding Editor allows you to customise the user interface for a project that uses the Keyman Engine.

Details tab

Branding editor - Details tab

Fill in the product-specific licensing and naming details. Three licence types are supported:

Shareware licenses allow a trial period before a user must purchase a license to continue using the product. You can set the length of the trial period with the Trial Day Count field. The Shareware model includes product activation and license management.
Global licenses allow unlimited distribution of the product, and require negotiating a price with Tavultesoft. This model does not include license management or product activation.
Freeware licenses are similar to Global, but the intent is to allow unlimited free distribution of the product.

The User Interface Type area allows you to specify an alternate program to replace Keyman Configuration. If this is used, then you must write your own configuration and control application using the Keyman COM API.

Icons tab

Branding editor - Icons tab

The icon editor allows you to edit the icons included in the product. It is usually better to edit the icons in an external editor which allows for multiple resolutions and colour depths. Icons can be imported with the Import button, and custom icons can be added with the Add button.

Tray Menu tab

Branding editor - Tray Menu tab

This tab allows you to customise the left and right click menus on the notification area icon for your product. Also managed here is the toolbar in the On Screen Keyboard, and the right-click menu for the On Screen Keyboard. Each item can be of type Text, Image, Separator, or Break. A Hotkey can be assigned to each item. The Action allows you to specify a standard or a custom action for each item on the menu.

Strings tab

Branding editor - Strings tab

Every string displayed in Keyman Configuration and the Keyman On Screen Keyboard user interface can be customised here. Other translations can be added through the Distribution Editor.

Config UI tab

Branding editor - Config UI tab

This tab allows you to edit every dialog in Keyman Configuration, as well as key runtime dialogs in the Engine. The dialogs are HTML, but the source files are XSLT which allow a transform from a data file to present the current configuration. See Reference - Branding Toolkit for Keyman Developer Professional for more details on each dialog.

The Test button will open a non-modal test window for the selected page. While this window is opened, it will be refreshed automatically as you change the source. Errors in the source will cause the window to show an error message instead of the expected content.

See also