<?xml version="1.0" encoding="utf-8" ?>
<?xml-stylesheet type="text/xsl" href="help.xsl" ?>
<ContextHelp>

  <Form Name="context/character-map">
    <Control Name="editFilter" Title="Character Map Filter">
      <p>The Filter allows a user to reduce the number of characters displayed in the character map.  The standard filter options used are by font name or block name.</p>
    </Control>
    <Control Name="grid" Title="Character Map">
      <p>The Character Map Grid displays each character in a square, with a visual representation of the character and the Unicode value displayed at the bottom of the square. Each font group is divided into a block headed by the font name.</p>
    </Control>
  </Form>

  <!-- ========================================================================
       Keyboard Editor
       ======================================================================== -->

  <Form Name="context/keyboard-editor">

    <!-- Details tab -->
    <Control Name="editName" Title="Keyboard Name">
      <p>The name of the keyboard is displayed in Keyman Configuration, in the tray menu and in many other places.  It should be a descriptive
      name, in any language, but remember that some applications may use a font that does not include the language you are writing the
      keyboard name in.  Don't include a version number, help information or hotkey in the name.</p>

      <p>This corresponds to the following source line:</p>
      <div class="code">store(&amp;name) 'My Keyboard'</div>
    </Control>
    <Control Name="clbTargets" Title="Targets">
      <p>Specifies the platforms for which this keyboard is designed. Where possible, use more generic targets, for example, use
      <div class="code">mobile</div> instead of both <div class="code">androidphone</div> and <div class="code">iphone</div>.
      preference, use <div class="code">any</div>.</p>
    </Control>
    <Control Name="cbType" Title="Character Set">
      <p>Your keyboard should be either Unicode or Codepage based.  Most keyboards today will be Unicode.  If you are designing in the source editor,
      you can create a keyboard that is includes both Unicode and Codepage (or "ANSI") rules.</p>

      <p>This corresponds to either of the following source lines:</p>
      <div class="code">
        begin ANSI &gt; use(main)<br />
        begin Unicode &gt; use(main)
      </div>
    </Control>
    <Control Name="editCopyright" Title="Copyright">
      <p>Copyright details for the keyboard are displayed when the keyboard is installed.  They can also be viewed in Keyman Configuration.</p>

      <p>This corresponds to the following source line:</p>
      <div class="code">store(&amp;copyright) '© 2006 My Company'</div>
    </Control>
    <Control Name="editMessage" Title="Message">
      <p>The message provides some additional information to a user of your keyboard, when they install the keyboard.</p>

      <p>This corresponds to the following source line:</p>
      <div class="code">store(&amp;message) 'Here is a message about a keyboard'</div>
    </Control>
    <Control Name="memoComments" Title="Comments">
      <p>In this field, enter information about the keyboard for your own reference.  These comments will only be visible in the
      source file, and not to users of your keyboard.</p>

      <p>The comments are placed at the top of the source file, e.g.:</p>
      <div class="code">
        c Version 1.2 - fixed a bug with the 'k' key<br/>
        c Version 1.1 - improved matching on vowels<br/>
        c Version 1.0 - initial version
      </div>
    </Control>
    <Control Name="editKeyOutputText" Title="Output Character(s)">
      <p>To select another key in the keyboard, either:</p>
      <ul>
        <li>Click on the key with the mouse, or</li>
        <li>Press and release the Ctrl key to choose with the keyboard</li>
      </ul>
    </Control>

    <Control Name="chkKMWRTL" Title="Keyboard is right-to-left">
      <p>Select this option to tell KeymanWeb to flag text entered by this keyboard as right-to-left (e.g. Arabic, Hebrew)</p>
    </Control>

    <Control Name="editKMWHelpText" Title="Help Text">
      <p>A simple line of text to show under the On Screen Keyboard in KeymanWeb.  Can contain HTML formatting and links.  Mutually exclusive with the Help File box</p>
    </Control>

    <Control Name="editKMWHelpFile" Title="Help File">
      <p>More complex help can be included by including an external file.  See the European Latin keyboard in Samples for a comprehensive example.</p>
    </Control>

    <Control Name="cmdKMWBrowseHelpFile" Title="Browse Help File">
      <p>Choose a help file to include in the keyboard</p>
    </Control>

    <Control Name="cmdCompileKeymanWeb" Title="Compile to Web">
      <p>Compiles the keyboard for KeymanWeb.  Two output files will be generated: [filename].js and [filename]_load.js.  The KeymanWeb Tutorial
      contains more information about the difference between the two output files.</p>
    </Control>

    <Control Name="cmdTestKeymanWeb" Title="Test KeymanWeb Keyboard">
      <p>Tests your KeymanWeb keyboard in an Internet Explorer embedded window</p>
    </Control>

    <!-- Layout tab -->
    <!-- Icon tab -->
    <Control Name="cmdbitmapChange" Title="Change" TopicName="context/keyboard-editor#toc-icon-tab">
      <p>The Change option allows the editing of the icon filename.</p>
    </Control>
    <Control Name="cmdExport" Title="Export" TopicName="context/keyboard-editor#toc-icon-tab">
      <p>The Export option allows the exporting of the new image to a selected location.</p>
    </Control>
    <Control Name="cmdImport" Title="Import" TopicName="context/keyboard-editor#toc-icon-tab">
      <p>The import option allows for the loading of an existing icon from a selected location.</p>
    </Control>
    <Control Name="panEdit" Title="Icon Editor" TopicName="context/keyboard-editor#toc-icon-tab">
      <p>The toolbox allows for the changing of the colours, addition of text and shapes.  It also allows for the moving of the icon around the canvas and also a preview of the icon is displayed.</p>
    </Control>

    <!-- On-Screen tab: see context/keyboard-editor#toc-on-screen-tab -->
    <!-- Touch Layout tab: see context/keyboard-editor#toc-touch-layout-tab -->
    <!-- Source tab -->
    <!-- Compile tab -->

    <Control Name="chkCustomOnScreenKeyboard" Title="Include">
      <p>A custom on screen (visual) keyboard can be included with your new keyboard. Check this option to display the on screen keyboard and options available.</p>
    </Control>
    <Control Name="chkLayoutDisplay102key" Title="European Keyboards">
      <p>On European Keyboards a 102nd key is added.  This allows you to map a character on the 102nd key.</p>
    </Control>
    <Control Name="chkIncludeTaskbarIcon" Title="Taskbar">
      <p>This option allows the user to choose whether the keyboard icon is displayed on the taskbar and to customise the look of the icon. Check the Include Icon on the Taskbar to display the icon bitmap editor.</p>
    </Control>
    <Control Name="chkSplitCtrlAlt" Title="Right Ctrl/Alt">
      <p>Allows for more combinations and also leaves the left Ctrl and Alt keys for general keyboard shortcuts, for example Ctrl C for Copy and Ctrl V for Paste.</p>
    </Control>
    <Control Name="cmdAddToProject" Title="Project">
      <p>This option adds the keyboard to the current active project.</p>
    </Control>
    <Control Name="cmdCompile" Title="Compile Keyboard">
      <p>Select this option to begin the compiling of the keyboard. The success of the compile is displayed at the bottom of the screen.  If errors are displayed, click on the Start Debugging button.</p>
    </Control>
    <Control Name="cmdInsertCopyright" Title="">
      <p>Insert Copyright</p>
      <p>This allows for the insertion of a copyright symbol if needed.</p>
    </Control>
    <Control Name="cmdInstall" Title="Install">
      <p>Install the compiled keyboard on to the computer.</p>
    </Control>
    <Control Name="lbDebugHosts" Title="Debug Hosts">
      <p>To test on other platforms, open one of the debug host addresses
      on your device.  Your device will need to be on the same network as
      this computer.</p>

      <p>You can test within the web browser on your device, or in the
      native app if you have it installed: just click the Install
      button on the debugger web page.</p>
    </Control>
    <Control Name="cmdSendURLsToEmail" Title="Send URLs to Email">
      <p>The Send to email function makes it easier to open the addresses
      on your mobile device without having to enter them manually.</p>
    </Control>
    <Control Name="cmdOpenContainingFolder2" Title="Open Containing Folder">
      <p>This option will open the folder that contains all the files saved for the new keyboard project.</p>
    </Control>
    <Control Name="cmdStartDebugging" Title="Start Debugging">
      <p>This option will allow for the debugging of a keyboard that could not be compiled and specific errors are displayed. It will direct the user to the source code of the keyboard file.</p>
    </Control>
    <Control Name="cmdUninstall" Title="Uninstall">
      <p>Uninstall the keyboard from the computer.</p>
    </Control>
    <Control Name="cmdUpload" Title="Upload">
      <p>This option allows the user to upload the compiled keyboard to Tavultesoft website to allow the sharing of the keyboard files.</p>
    </Control>
    <Control Name="cmdVKChange" Title="Change">
      <p>The change button allows the change of the filename and/or location of the on screen keyboard.</p>
    </Control>
    <Control Name="editCharacterSet" Title="Unicode">
      <p>Your keyboard should be either Unicode or Codepage based. Most keyboards today will be Unicode. If you are designing in the source editor, you can create a keyboard that is includes both Unicode and Codepage (or "ANSI") rules.</p>
      <p>This corresponds to either of the following source lines:</p>
      <p>begin ANSI &gt; use(main)</p>
      <p>begin Unicode &gt; use(main)</p>
    </Control>
    <Control Name="editComments" Title="Message">
      <p>The message provides some additional information to a user of your keyboard, when they install the keyboard.</p>
      <p>This corresponds to the following source line:</p>
      <p>store(&amp;message) 'Here is a message about a keyboard''</p>
    </Control>
    <Control Name="editCopyright" Title="Keyman Configuration">
      <p>Copyright details for the keyboard are displayed when the keyboard is installed. They can also be viewed in Keyman Configuration.</p>
    </Control>
    <Control Name="editKeyOutputCode" Title="Unicode Character Value">
      <p>If the Unicode value is known, enter the value and the corresponding character will be displayed on the key.</p>
    </Control>
    <Control Name="editMessage" Title="Message">
      <p>To add additional details about the keyboard. The message will be displayed when the keyboard is selected in Keyman Configuration.</p>
    </Control>
    <Control Name="editOuputCharacters" Title="Release">
      <p>To select another key in the keyboard, either:</p>
      <p>Click on the key with the mouse, or</p>
      <p>Press and release the Ctrl key to choose with the keyboard</p>
    </Control>
    <Control Name="editVKFileName" Title="">
      <p>KVK Filename</p>
      <p>Displays the file path and file name of the Keyman Visual Keyboard (KVK). Press the END key on your keyboard to view the filename or click on the Change button to change the filename and location.</p>
    </Control>
  </Form>

  <Form Name="context/keyboard-editor#toc-on-screen-tab">
    <Control Name="chkVKDisplayUnderlyingChars" Title="Display Underlying Character Layouts">
      <p>If selected, then the visual keyboard will only be used if the current underlying layout is active. </p>
    </Control>
    <Control Name="chkVKInclude102key" Title="">
      <p>Display 102nd Key</p>
      <p>On European Keyboards a 102nd key is added.  This allows you to map a character on the 102nd key.</p>
    </Control>
    <Control Name="chkVKSplitCtrlAlt" Title="Right Ctrl/Alt">
      <p>Allows for more combinations and also leaves the left Ctrl and Alt keys for general keyboard shortcuts, for example Ctrl C for Copy and Ctrl V for Paste.</p>
    </Control>
    <Control Name="cmdBrowseKeyBitmap" Title="Browse button">
      <p>This allows for a bitmap/picture to be displayed on the selected key. Click on the Browse button to select the bitmap.</p>
    </Control>
    <Control Name="cmdExportOnScreenKeyboard" Title="XML">
      <p>Export the keyboard to other file formats (HTML, BMP, or PNG), for use in documentation. Export the structure of the keyboard to XML format for automated processing. </p>
    </Control>
    <Control Name="cmdImportOnScreenKeyboard" Title="Import">
      <p>Import an existing on screen keyboard layout.</p>
    </Control>
    <Control Name="cmdVKImportKMX" Title="Layout">
      <p>Use the same layout as the new keyboard, assigning the same characters to the same keyboard letters.</p>
    </Control>
    <Control Name="editVKKeyText" Title="Text">
      <p>Allows the user to enter text to be displayed on the selected key.</p>
    </Control>
  </Form>

  <Form Name="context/keyboard-editor#toc-touch-layout-tab">
    <Control Name="cefwp" Title="Touch Layout Editor">
      <p>The Touch Layout tab is used to create the visible representation of the keyboard layout for touch devices. It works similarly to the On Screen Keyboard Editor conceptually, but has a number of additional features specific to touch. Keys on the touch layout trigger rules within the normal Keyman keyboard; if no rule is defined for a given key, it will be given output if it has a standard code beginning with <code>K_</code>, or if it is a Unicode value code, starting with <code>U_</code>.</p>
      <ul>
        <li><a href="help:guides/develop/touch-keyboard-tutorial">Read the guide on developing touch layouts</a></li>
      </ul>
    </Control>
  </Form>

  <Form Name="context/must-include-debug">
    <Control Name="*" Title="Keyman Developer Debugger 'Include Debug Information' Confirmation Screen">
      <p>Keyman Developer Debugger</p>
      <p>Debug information must be included in the compile keyboard before the debugger process can be started. From the Keyboard menu select Include Debug Information. The debug information will display the error sources when compiling.</p>
      <p>The debugger can be used without the debug information by clicking on Test without debugger.</p>
    </Control>
  </Form>

  <Form Name="context/new-file-details">
    <Control Name="*" Title="New File">
      <p>Enter the name for your new keyboard. Click on the Browse button to change the location of the new keyboard.</p>
    </Control>
  </Form>

  <Form Name="context/package-editor">
    <Control Name="cbImageFile" Title="Image File">
      <p>You can include an image file that will be displayed to the left of the install details when the package is installed. This image should be 140 pixels wide and 250 pixels high.</p>
    </Control>
    <Control Name="cbReadmeFile" Title="Readme file">
      <p>The readme file can be displayed after the installation of the keyboard package, but can also be accessed from the keyboard folder at a later time. The file must be loaded under the Files tab, add option before being able to be selected from the drop down list.</p>
    </Control>
    <Control Name="cbStartMenuProgram" Title="Shortcut Program" />
    <Control Name="chkCreateStartMenu" Title="Start menu">
      <p>This option will allow you to create a folder on the Start menu when the keyboard package is installed.</p>
    </Control>
    <Control Name="chkStartMenuUninstall" Title="Uninstall">
      <p>The uninstall shortcut will be added automatically to the shortcut menu list when the package is installed.</p>
    </Control>
    <Control Name="cmdAddFile" Title="Add Files">
      <p>This option allows the user to add new files to the package.</p>
    </Control>
    <Control Name="cmdDeleteStartMenuEntry" Title="Delete">
      <p>To delete the selected shortcut menu item from the Start menu folder.</p>
    </Control>
    <Control Name="cmdInsertCopyright" Title="Insert Copyright">
      <p>This allows for the insertion of a copyright symbol if needed.</p>
    </Control>

    <Control Name="cbReadMe" Title="Read Me Details">
      <p>A readme file can be a text file (ANSI, UTF-8, or UTF-16), or an HTML file (recommended).  Other file types are also acceptable,
      but the package installer will load the file in a separate program.</p>
    </Control>
    <Control Name="cbKMPImageFile" Title="Package Image">
      <p>You can include an image file that will be displayed to the left of the install details when the package is
        installed.  This image should be 140 pixels wide and 250 pixels high.</p>
    </Control>
    <Control Name="cmdTestPackage" Title="Test Package">
      <p>You should try installing your package on your system before distributing it, to ensure that all files are
      installed correctly.  If you can, try installing your package on several different machines.</p>
    </Control>

    <!-- Compile Page -->

    <Control Name="editOutPath" Title="Compile">
      <p>Displays the output path and filename of the file when the package is compiled.</p>
    </Control>

    <Control Name="cmdCompileInstaller" Title="Compile Installer">
      <p>Creates a self-extracting installer consisting of the package plus Keyman or another Keyman Engine product that was created with the Branding Pack.</p>
    </Control>

    <Control Name="editInstallerOutputFilename" Title="Installer Output Filename">
      <p>Displays the output filename and path for the self-extract installer.</p>
    </Control>

    <Control Name="cmdInstallWith" Title="Select Product Installer">
      <p>Chooses a product installer, such as the Keyman installation source.  You can download Keyman installers from keyman.com.</p>
    </Control>

    <Control Name="cmdAddToProject" Title="Add to Project">
      <p>This option allows the user to add the compile package to the project, keeping all files together in the one location.</p>
    </Control>
    <Control Name="cmdBuildPackage" Title="Compile Package">
      <p>This option checks the package has all the required files and for any errors.  The success of the compilation is displayed at the bottom of the screen.</p>
    </Control>

    <Control Name="cmdInstall" Title="Install Package">
      <p>This option will install the package on the computer. A message will be displayed as to the success of the install.</p>
    </Control>

    <Control Name="cmdNewStartMenuEntry" Title="New">
      <p>To add a new menu item to the list of shortcuts to be displayed in the Start menu folder created when the keyboard package is installed.</p>
    </Control>
    <Control Name="cmdOpenContainingFolder" Title="Open Containing Folder">
      <p>Opens the source folder of the selected file.</p>
    </Control>
    <Control Name="cmdOpenContainingFolder2" Title="Open Containing Folder">
      <p>This option will open the folder the selected package is located in.</p>
    </Control>
    <Control Name="cmdOpenFile" Title="Edit">
      <p>This option allows the user to edit the selected file if the appropriate editor is available.</p>
    </Control>
    <Control Name="cmdRemoveFile" Title="Remove Files">
      <p>This option allows the user to remove a selected file from the list.</p>
    </Control>
    <Control Name="cmdUninstall" Title="Uninstall Package">
      <p>This option will uninstall the package from the computer. A message will be displayed as to the success of the uninstall.</p>
    </Control>
    <Control Name="cmdUpload" Title="Upload">
      <p>This option will enable the developer to upload the package to the Tavultesoft website.</p>
    </Control>
    <Control Name="editFilePath" Title="Path">
      <p>Displays the location of the selected file.</p>
    </Control>
    <Control Name="editFileType" Title="">
      <p>File Type</p>
      <p>Enter the details of the file type being added to the keyboard package.</p>
    </Control>
    <Control Name="editInfoAuthor" Title="Author's">
      <p>Enter the name of the author or authors of the keyboard package.</p>
    </Control>
    <Control Name="editInfoCopyright" Title="Copyright">
      <p>Enter the copyright details of the keyboard package This information will be displayed with the version, author and message information when the package is installed.</p>
    </Control>
    <Control Name="editInfoEmail" Title="Email address">
      <p>Enter the contact email address for the keyboard package.</p>
    </Control>
    <Control Name="editInfoName" Title="Package Name">
      <p>Package Name is the name that will be displayed when the package is installed. It should be a descriptive name, in any language, but remember that some applications may use a font that does not include the language you are writing the keyboard name in. Don't include a version number, help information or hotkey in the name.</p>
    </Control>
    <Control Name="editInfoVersion" Title="Package Version">
      <p>The version number allows the user to check whether they have the latest version of the keyboard.  The format should be 'major.minor[.subversion]'.  Each number should be an integer, and you should avoid non-integer version strings.  See help for more details.</p>
    </Control>
    <Control Name="editInfoWebSite" Title="Website">
      <p>The website details for the keyboard package if available.</p>
    </Control>

    <Control Name="editStartMenuDescription" Title="Start">
      <p>The text to be displayed for the selected file as a menu item in the Start up folder that is created when the package is installed.</p>
    </Control>
    <Control Name="editStartMenuParameters" Title="Shortcut Parameters" />
    <Control Name="editStartMenuPath" Title="">
      <p>Start Menu Path</p>
      <p>Enter the path of the start menu to be displayed when the keyboard package is installed.</p>
    </Control>
    <Control Name="lbFiles" Title="Package Files">
      <p>This will display all the files that have been added to the keyboard package.  It allows for the addition and removal of files, the entering of file details and the editing of any of the files listed if the appropriate editor is available.</p>
    </Control>
    <Control Name="memoFileDetails" Title="Details">
      <p>This option allows the user to enter details and other additional information about the selected file.</p>
    </Control>
  </Form>

  <Form Name="context/project">
    <Control Name="*" Title="Project Manager">
      <p>The Project Manager allows you to manage all the files related to a keyboard layout in a single location.</p>
    </Control>
  </Form>
</ContextHelp>