Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Index

On this page

keyman_keyboardlist.xsl: Keyman Desktop Configuration window - Keyboards tab

This tab shows the list of installed keyboards for the active product.

XML Parameters

The list of keyboards and packages is returned as XML from Keyman Engine as multiple KeymanKeyboardInstalled and KeymanPackageInstalled elements, described below:
<ImagePath>(temppath to keyboard icons)</ImagePath>

<KeymanKeyboardInstalled>
  <index>##</index>
  <name>(Short name of keyboard)</name>
  <keyboardname>(Descriptive name of keyboard)</keyboardname>
  <filename>(Full path and filename of keyboard)</filename>
  [<copyright>(Copyright)</copyright>]
  [<message>(Keyboard message)</message>]
  <encodings>
    [<encoding>Unicode</encoding>]
    [<encoding>Codepage</encoding>]
  </encodings>
  [<installedbyadmin />
  [<loaded />]
  [<visualkeyboard />]
  <layoutpositional /> | <layoutmnemonic />
  <ownerproductname>(Name of owning product)</ownerproductname>
  [<keymanid>##</keymanid>]
  [<bitmap>(filename of bitmap in ImagePath)</bitmap>]
</KeymanKeyboardInstalled>
  
<KeymanPackageInstalled>
  <index>##</index>
  <description>(Descriptive name of package)</description>
  [<installedbyadmin />]
  <name>(Short name of package)</name>
  <filename>(Full path and filename of package)</filename>
  <KeymanKeyboardsPackageInstalled>
    <index>##</index>
    <KeymanKeyboardInstalled]
      <index>##</index>
      <name>(short name of keyboard)</name>
      <keyboardname>(descriptive name of keyboard)</keyboardname>
      <filename>(full path and filename of keyboard temp file)</filename>
      [<message>(keyboard message)</message>]
      [<copyright>(copyright)</copyright>]
      <encodings>
        [<encoding>Unicode</encoding>]
        [<encoding>Codepage</encoding>]
      </encodings>
      [<installedbyadmin />
      [<loaded />]
      [<visualkeyboard />]
      <layoutpositional /> | <layoutmnemonic />
      [<bitmap>(filename of bitmap in imagepath)</bitmap>]
      [<keymanid>##</keymanid>]
      <ownerproductname>(Name of owning product)</ownerproductname>
    </KeymanKeyboardInstalled>
    ...
  </KeymanKeyboardsPackageInstalled>
  <Fonts>
    <Font>
      <filename>(filename of font)</filename>
      <name>(descriptive name of font)</name>
    </Font>
    ...
  </Fonts>
  <detail name="version">(version number)</detail>
  <detail name="copyright">(copyright)</detail>
  <detail name="author" url="(url of author email)">(author name)</detail>
  <detail name="website" url="(url of website)">(url of website)</detail>
</KeymanPackageInstalled>
  

Targets

Target Parameters Description
keyman:keyboard_install Opens the Browse for Keyboard dialog, and then the Install Keyboard dialog.
keyman:keyboard_download Opens the Download Keyboard dialog
keyman:keyboard_uninstall index: The index of the keyboard from the parameters Uninstalls the keyboard identified by index
keyman:keyboard_clickcheck index: The index of the keyboard from the parameters Toggle the loaded state of the keyboard identified by index
keyman:keyboard_installvisualkeyboard index: The index of the keyboard from the parameters Opens the Browse for On Screen Keyboard dialog and installs the OSK for the keyboard identified by index
keyman:keyboard_uninstallvisualkeyboard index: The index of the keyboard from the parameters Uninstalls the OSK for the keyboard identified by index
keyman:keyboard_hotkey index: The index of the keyboard from the parameters Opens the hotkey dialog for the keyboard identified by index
keyman:package_uninstall index: The index of the package from the parameters Uninstalls the package identified by index
keyman:package_welcome index: The index of the package from the parameters Opens the package Welcome.htm documentation for the package identified by index