Keyboard Support

Contact and Search Homepage

Header bottom

Other versions
Version 7.0


On this page

Reference - Branding Toolkit for Keyman Developer Professional


You must purchase a licence for the Branding Pack before you can use the Branding Editor or the Distribution Editor in Keyman Developer.

This reference sections details the customisable screens, actions and parameters for each dialog. Some generic parameters and targets are available for every screen.

XML Parameters

XML Parameters are passed in as part of the XML to the XSLT. The parameters are generally easy to use, for example, in the Keyboard Install dialog (installkeyboard.xsl), you can retrieve the descriptive name of the keyboard to be installed with the following code:

<xsl:value-of select="/Keyman/KeymanKeyboardFile/keyboardname" />

The following parameters are passed into every dialog and window:

<templatepath>(path to templates, for img src and includes)</templatepath>
<scripttemplatepath>(path to templates for embedding in script)</scripttemplatepath>
<defaultlocalepath>(path to default locale file)</defaultlocalepath>
<localepath>(path to currently selected locale file)</localepath>


Keyman Desktop Configuration is controlled by linking to specially formed URLs, for example:

<a href='keyman:link?url='>Open the Tavultesoft website</a>

This example will open the Tavultesoft website in the user's default browser. Note that if just the URL had been passed, the website would have been opened within Keyman Desktop Configuration, which is probably not the desired behaviour!

Target Parameters Description
keyman:link url: url of website to open Opens website url in user's default web browser. This should be used whenever linking to a website, instead of directly referencing the site, or using target='_blank' as both of these would open within the Keyman Desktop Configuration context.