diff --git a/windows/src/desktop/help/about/whatsnew.md b/windows/src/desktop/help/about/whatsnew.md index c080414cbc..d8fcdda6cc 100644 --- a/windows/src/desktop/help/about/whatsnew.md +++ b/windows/src/desktop/help/about/whatsnew.md @@ -40,4 +40,4 @@ Here are some of the new features we have added to Keyman 14.0 for Windows: ## Related Topics - [Version History](history) -- [New Ways to Use Keyman](../basic/newways) +- [New Ways to Use Keyman](../basic/new-ways-to-use-keyman) diff --git a/windows/src/desktop/help/advanced/proxy_config.md b/windows/src/desktop/help/advanced/proxy_config.md index 3e46e830b4..42f0371384 100644 --- a/windows/src/desktop/help/advanced/proxy_config.md +++ b/windows/src/desktop/help/advanced/proxy_config.md @@ -19,4 +19,4 @@ Configuration will use the proxy settings from Windows. ## Related Topics - [How To - Download and Install a Keyman Keyboard](../start/download-and-install-keyboard) -- [Software Task - Update Keyman](../basic/engine_tasks/update) +- [Software Task - Update Keyman](../basic/engine/update) diff --git a/windows/src/desktop/help/basic/config_tasks/hotkeys_tab.md b/windows/src/desktop/help/basic/config/hotkeys.md similarity index 64% rename from windows/src/desktop/help/basic/config_tasks/hotkeys_tab.md rename to windows/src/desktop/help/basic/config/hotkeys.md index 6b59997741..860f51e21a 100644 --- a/windows/src/desktop/help/basic/config_tasks/hotkeys_tab.md +++ b/windows/src/desktop/help/basic/config/hotkeys.md @@ -1,17 +1,17 @@ --- -title: Keyman Configuration - Hotkeys Tab {#basic_hotkeys_tab} +title: Keyman Configuration - Hotkeys Tab --- The Hotkeys tab of Keyman Configuration lets you set hotkeys for Keyman functions, Keyman keyboards and Windows languages. -![](../desktop_images/tab-hotkeys.png) +![](../../desktop_images/tab-hotkeys.png) -**Opening the Hotkeys Tab** +## Opening the Hotkeys Tab To open the Hotkeys tab of Keyman Configuration: -1. Click on the Keyman icon ![](../desktop_images/icon-keyman.png), on the +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the Windows Taskbar near the clock. 2. From the Keyman menu, select Configuration.... @@ -21,15 +21,15 @@ To open the Hotkeys tab of Keyman Configuration: **Tip:** Keyman Configuration opens in the same tab you last closed it in. -**Setting Hotkeys** +## Setting Hotkeys For help setting hotkeys in the Hotkeys tab of Keyman Configuration, -see: [???](#start_hotkey_set) +see: [How To - Set Hotkeys for Keyman, Keyman Keyboards and Windows Languages](../../start/hotkey_set) **Note:** By default, hotkeys only turn on a function or keyboard. If you prefer hotkeys to turn on or off a function or keyboard, you can change this -behaviour in the [Options tab](#basic_options_tab) of Keyman +behaviour in the [Options tab](options) of Keyman Configuration. Tick \'Keyboard hotkeys toggle keyboard activation\' and click OK. @@ -37,45 +37,31 @@ Some hotkeys do not toggle even if this option is enabled. Only the following hotkeys will toggle with this option enabled: - Show On Screen Keyboard Pane - - Show Keyboard Usage Pane - - Show Font Helper Pane - - Show Character Map Pane - - Any Keyman Keyboard Hotkey -**About Hotkeys** +## About Hotkeys The General Hotkeys section of the Hotkeys tab lists hotkeys for Keyman functions: - Switch Keyman Off --- Switches to your default Windows keyboard, but does not exit Keyman. - -- Open Keyboard Menu --- Opens the [Keyman Menu](#basic_traymenu). - +- Open Keyboard Menu --- Opens the [Keyman Menu](../tray-menu). - Open Language Switcher --- Opens the [Language - Switcher](#basic_languageswitcher). - + Switcher](../language-switcher). - Show On Screen Keyboard Pane --- Opens or shows the [On Screen - Keyboard](#basic_osk) tool of the Keyman Toolbox. - -- Show Keyboard Usage Pane --- Opens or shows the [Keyboard - Usage](#basic_usage) tool of the Keyman Toolbox. - + Keyboard](../toolbox/osk) tool of the Keyman Toolbox. - Show Font Helper Pane --- Opens or shows the [Font - Helper](#basic_fonthelper) tool of the Keyman Toolbox. - + Helper](../toolbox/font-helper) tool of the Keyman Toolbox. - Show Character Map Pane --- Opens or shows the [Character - Map](#basic_charactermap) tool of the Keyman Toolbox. - + Map](../toolbox/character-map) tool of the Keyman Toolbox. - Open Text Editor --- Opens the [Keyman Text - Editor](#basic_text_editor). - + Editor](../text-editor). - Open Configuration --- Opens [Keyman - Configuration](#basic_config_menu). + Configuration](../config/). The Keyboards section of the Hotkeys tab lists hotkeys for all currently installed Keyman keyboards. @@ -83,10 +69,8 @@ installed Keyman keyboards. The Windows Languages section of the Hotkeys tab lists hotkeys for all currently installed Windows languages. -**Related Topics** +## Related Topics -- [???](#start_hotkey_set) - -- [???](#basic_config_menu) - -- [???](#basic_options_tab) +- [How To - Set Hotkeys for Keyman, Keyman Keyboards and Windows Languages](../../start/hotkey_set) +- [Keyman Configuration](../config/) +- [Keyman Configuration - Options Tab](options) diff --git a/windows/src/desktop/help/basic/config/index.md b/windows/src/desktop/help/basic/config/index.md new file mode 100644 index 0000000000..0c5c50e9f5 --- /dev/null +++ b/windows/src/desktop/help/basic/config/index.md @@ -0,0 +1,30 @@ +--- +title: Keyman Configuration +--- + +Keyman Configuration is the central control panel for Keyman. Use Keyman +Configuration to install and uninstall keyboards, change options, set +hotkeys, disable addins, associate languages, check for updates, +switch the language of Keyman user interface, and run support diagnostics. + +![](../../desktop_images/tab-support.png) + +## Opening Keyman Configuration + +To open Keyman Configuration: + +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the + Windows Taskbar near the clock. + +2. From the Keyman menu, select Configuration.... + +## Using Keyman Configuration + +For more information on using Keyman Configuration, see: + +- [How To - Set the Language for Keyman Menus](../../start/locale) +- [Keyman Configuration - Keyboard Layouts Tab](keyboards) +- [Keyman Configuration - Options Tab](options) +- [Keyman Configuration - Hotkeys Tab](hotkeys) +- [Keyman Configuration - Support Tab](support) +- [Keyman Configuration - Keep in Touch Tab](keep-in-touch) diff --git a/windows/src/desktop/help/basic/config/keep-in-touch.md b/windows/src/desktop/help/basic/config/keep-in-touch.md new file mode 100644 index 0000000000..4c852db551 --- /dev/null +++ b/windows/src/desktop/help/basic/config/keep-in-touch.md @@ -0,0 +1,6 @@ +--- +title: Keep in touch tab +--- + +This page provides options to engage with the Keyman community and +follow the Keyman team to learn more about development on Keyman. diff --git a/windows/src/desktop/help/basic/config/keyboards.md b/windows/src/desktop/help/basic/config/keyboards.md new file mode 100644 index 0000000000..fdc4c5a638 --- /dev/null +++ b/windows/src/desktop/help/basic/config/keyboards.md @@ -0,0 +1,105 @@ +--- +title: Keyman Configuration - Keyboard Layouts Tab +--- + +The Keyboard Layouts tab of Keyman Configuration lists all the Keyman +keyboards which are currently installed on your computer. You can use +the Keyboard Layouts tab to install and uninstall keyboards, enable and +disable keyboards, set keyboard hotkeys, show keyboard help and view +keyboard details. + +![](../../desktop_images/tab-layout.png) + +## Opening the Keyboard Layouts Tab + +To open the Keyboard Layouts tab of Keyman Configuration: + +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the + Windows Taskbar near the clock. + +2. From the Keyman menu, select Configuration.... + +3. Select the Keyboard Layouts tab. + + **Tip:** + Keyman Configuration opens in the same tab you last closed it in. + +## Installing a Keyboard + +To install a keyboard layout in Keyman, see: [Installing a Keyman Keyboard within Keyman](../../start/download-and-install-keyboard) + +## Uninstalling a Keyboard + +To uninstall a Keyman keyboard from the Keyboard Layouts tab of Keyman +Configuration, see: [Keyboard Task - Uninstall a Keyboard](../uninstall-keyboard) + +## Enabling and Disabling a Keyboard + +To enable or disable a Keyman keyboard from the Keyboard Layouts tab of +Keyman Configuration, see: [Keyboard Task - Enable or Disable a Keyboard](../enable-or-disable-keyboard) + +## Setting a Hotkey + +To set a hotkey for a Keyman keyboard, use the [Hotkeys tab](hotkeys). + +## Showing Introductory Help + +To show introductory help for a Keyman keyboard from the Keyboard +Layouts tab of Keyman Configuration: + +1. Find a keyboard in the keyboard list. + +2. Click on the question mark icon + (![](../../desktop_images/icon-introductory-help.png)) beside the keyboard + name. The keyboard help documentation will be shown. + +## Viewing Keyboard Details + +To view details for a Keyman keyboard from the Keyboard Layouts tab of +Keyman Configuration: + +1. Find a keyboard in the keyboard list. + +2. Click on the down arrow + (![](../../desktop_images/keyboards-downarrow.png)) beside the keyboard + name. The keyboard information window will expand. + + ![](../../desktop_images/keyboards-hotkey.png) + +3. In the information window you can view keyboard details, including: + + - Keyboard filename. + - Keyboard package name. + - Keyboard version number. + - Keyboard encodings. + - Keyboard layout type. + - On Screen Keyboard status. + - Documentation status. + - Copyright details. + - Installation details. + +## Sharing a keyboard with other users and devices + +If you installed a keyboard layout using the Download keyboard button, +then you can share the keyboard with other devices and users using a QR +Code. + +1. Expand the keyboard details for the keyboard you wish to share, and + click Share keyboard. + +2. A popup will appear with a QR Code. This QR Code can be scanned with + a mobile phone camera to automatically open a web page with a + download link to install the keyboard. + + ![](../../desktop_images/keyboard-share.png) + +## Associating a keyboard with a Windows language + +All Keyman keyboards are associated with a Windows language by default. +To change the association, or add a new association, see the following: + +- [How To - Set up Your Computer for a Keyman Keyboard](../../start/configure-computer) + +## Related Topics + +- [Keyman Configuration](../config/) diff --git a/windows/src/desktop/help/basic/config_tasks/options_tab.md b/windows/src/desktop/help/basic/config/options.md similarity index 61% rename from windows/src/desktop/help/basic/config_tasks/options_tab.md rename to windows/src/desktop/help/basic/config/options.md index d1d4dedc4f..4e79c23ae3 100644 --- a/windows/src/desktop/help/basic/config_tasks/options_tab.md +++ b/windows/src/desktop/help/basic/config/options.md @@ -1,18 +1,18 @@ --- -title: Keyman Configuration - Options Tab {#basic_options_tab} +title: Keyman Configuration - Options Tab --- The Options tab of Keyman Configuration includes the Keyman application options. You can use the Options tab to set general, startup, Keyman Toolbox On Screen Keyboard and advanced options. -![](../desktop_images/tab-options2.png) +![](../../desktop_images/tab-options2.png) -**Opening the Options Tab** +## Opening the Options Tab To open the Options tab of Keyman Configuration: -1. Click on the Keyman icon ![](../desktop_images/icon-keyman.png), on the +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the Windows Taskbar near the clock. 2. From the Keyman menu, select Configuration.... @@ -22,9 +22,9 @@ To open the Options tab of Keyman Configuration: **Tip:** Keyman Configuration opens in the same tab you last closed it in. -**Using General Options** +## Using General Options -![](../desktop_images/options-general.png) +![](../../desktop_images/options-general.png) - Keyboard hotkeys toggle keyboard activation @@ -34,20 +34,35 @@ To open the Options tab of Keyman Configuration: will only turn the Keyman keyboard on. **Tip:** - Set hotkeys in the - Hotkeys tab - of Keyman Configuration. + Set hotkeys in the Hotkeys tab of Keyman Configuration. - Simulate AltGr with Ctrl+Alt - Some hardware keyboards do not have a designated AltGr key (Right - Alt key). Some Keyman keyboards require AltGr. Tick this option to - allow Ctrl+Alt to be used for AltGr. Untick this option and Ctrl+Alt - will not be used for AltGr. + Some hardware keyboards do not have a designated AltGr key + (Right Alt key). Some Keyman keyboards require + AltGr. Tick this option to allow Ctrl + + Alt to be used for AltGr>. Untick this option + and Ctrl + Alt will not be used for + AltGr. -- Select keyboard layout for all applications +- Show hint messages - Unlike Windows default behaviour, Keyman allows you to select one + You can turn on and off the beginner hint messages which appear + while using Keyman. Tick this option to show all hint messages. + Untick this option to hide all hint messages. + + **Note:** + You can also hide hint messages on a case-by-case basis by ticking + at the bottom of each hint. + +- Reset Hints + + Click the Reset Hints button to switch all hint messages on again, + even those that you have switched off on a case-by-case basis. + +- Select keyboard layout for all applications (Windows 7) + + Unlike Windows 7 default behaviour, Keyman allows you to select one Windows language and Keyman keyboard for all open applications and text fields across your entire system. Tick this option to select one Windows language and Keyman keyboard across your entire system. @@ -58,43 +73,55 @@ To open the Options tab of Keyman Configuration: because Windows has this functionality built in. The setting can be changed in Windows, with the following steps: - - Open Control Panel - - Select Language, Advanced Settings + - Search for "Advanced Keyboard Settings" - Check the \"Let me set a different input method for each app window\" checkbox. -- Show hint messages +- Automatically report errors to keyman.com - You can turn on and off the beginner hint messages which appear - while using Keyman. Tick this option to show all hint messages. - Untick this option to hide all hint messages. + If Keyman crashes, then it can automatically send a report to the + development team. This report is anonymous and contains only + technical details relating to the crash. It does not include + keystroke data or personally identifying data. - **Note:** - You can also hide hint messages on a case-by-case bases by ticking - at the bottom of each hint. +- Share anonymous usage statistics with keyman.com -- Reset Hints + In order to understand how users engage with different parts of + the Keyman program, anonymous usage statistics may be periodically + sent to keyman.com. These statistics do not include keystroke data + or any personally identifying data. If you would prefer not to + share these statistics, uncheck this box. - Click the Reset Hints button to switch all hint messages on again, - even those that you have switched off on a case-by-case basis. + **Note:** In Keyman 14.0, no statistics are currently sent, + although the infrastructure is in place. -**Using Startup Options** +## Using Startup Options -![](../desktop_images/options-startup.png) +![](../../desktop_images/options-startup.png) + +- Test for conflicting applications when Keyman starts + + Some applications are not written according to the Windows software + development standards and can cause problems with Keyman keyboard + input. Tick this option to have Keyman detect problem applications + and attempt to work around them. - Start when Windows starts - You can have Keyman start when Windows starts. Tick this option to - have Keyman start when Windows starts. Untick this option to start - Keyman manually. + You can have Keyman start when you login to Windows. Tick this + option to have Keyman start automatically after you have logged in. + When you use this option, Keyman will not show its startup screen. + If you untick this option, you can start Keyman yourself from the + Start Menu. - Show splash screen - You can turn on and off the Keyman splash screen that appears when - Keyman starts. Tick this option to show the splash screen on - startup. Untick this option to remove the splash screen. + You can turn on and off the Keyman startup screen that appears when + Keyman starts. Tick this option to show the startup screen when + Keyman is started. Note that the startup screen will not show when + Keyman is started automatically with Windows. -- Automatically check www.keyman.com weekly for updates. +- Automatically check keyman.com weekly for updates. Keyman can automatically check for application and keyboard updates once a week. No personally identifiable information is sent to @@ -107,26 +134,19 @@ To open the Options tab of Keyman Configuration: Keyman can be updated manually through the Support tab in the Configuration menu. -- Test for conflicting applications when Keyman starts +## Using On Screen Keyboard Options - Some applications are not written according to the Windows software - development standards and can cause problems with Keyman keyboard - input. Tick this option to have Keyman detect problem applications - and work around them. Untick this option to prevent Keyman from - working around problem applications. - -**Using On Screen Keyboard Options** - -![](../desktop_images/options-osk.png) +![](../../desktop_images/options-osk.png) - Release Shift/Ctrl/Alt on On Screen Keyboard after clicking a key By default, the On Screen Keyboard of the Keyman Toolbox uses - \'sticky\' Ctrl, Shift or Alt keys. This means Ctrl, Shift, and Alt + \'sticky\' Ctrl, Shift or Alt + keys. This means Ctrl, Shift and Alt stay down on the On Screen Keyboard until they are clicked again or until you press the actual keys on your hardware keyboard. Tick this - option to disable the default sticky key behaviour. Untick this - option to enable the default sticky key behaviour. + option to release these keys after any key is clicked on the + On Screen Keyboard. - Always show On Screen Keyboard Window when Keyman keyboard is selected @@ -139,16 +159,11 @@ To open the Options tab of Keyman Configuration: - Switch to appropriate On Screen Keyboard/Help automatically when a keyboard is selected - Each time you turn on a Keyman keyboard, Keyman can automatically - detect and switch to the Keyman Toolbox tool which is best for that - Keyman keyboard: either the On Screen Keyboard or Keyboard Usage. - Tick this option to have Keyman automatically detect and display the - best view for your Keyman keyboard. Untick this option to prevent - Keyman from switching its display automatically. + This option is deprecated in Keyman 14.0 and has no function. -**Using Advanced Options** +## Using Advanced Options -![](../desktop_images/options-advanced.png) +![](../../desktop_images/options-advanced.png) - Debugging @@ -170,24 +185,21 @@ To open the Options tab of Keyman Configuration: tool. Debug log files are in binary format and can be imported into - Windows Event Viewer for viewing, or Microsoft Message Analyzer - (recommended). + Windows Performance Analyzer for viewing. **Note:** It is highly recommended that you switch off this option after obtaining the debug log. The log files can grow very large very quickly! - ::: {.warning} + **Warning:** Privacy Warning - The debug log records every keystroke you type, even if a Keyman keyboard is not active. This includes logins and passwords! For this reason, we recommend only switching the debug log on for short and isolated tests as specifically requested by Keyman Technical Support. - ::: -**Related Topics** +## Related Topics -- [???](#basic_config_menu) - -- [???](#basic_hotkeys_tab) +- [Keyman Configuration](../config/) +- [Hotkeys tab](hotkeys) diff --git a/windows/src/desktop/help/basic/config_tasks/support_tab.md b/windows/src/desktop/help/basic/config/support.md similarity index 62% rename from windows/src/desktop/help/basic/config_tasks/support_tab.md rename to windows/src/desktop/help/basic/config/support.md index 78f0659b9d..1123c2a447 100644 --- a/windows/src/desktop/help/basic/config_tasks/support_tab.md +++ b/windows/src/desktop/help/basic/config/support.md @@ -1,5 +1,5 @@ --- -title: Keyman Configuration - Support Tab {#basic_support_tab} +title: Keyman Configuration - Support Tab --- The Support tab of Keyman Configuration displays Keyman version @@ -7,13 +7,13 @@ information and support tools. You can use the Support tab to send a support request, check Windows language settings, check for updates, and view Keyman version information. -![](../desktop_images/tab-support.png) +![](../../desktop_images/tab-support.png) -**Opening the Support Tab** +## Opening the Support Tab To open the Support tab of Keyman Configuration: -1. Click on the Keyman icon ![](../desktop_images/icon-keyman.png), on the +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the Windows Taskbar near the clock. 2. From the Keyman menu, select Configuration.... @@ -23,30 +23,29 @@ To open the Support tab of Keyman Configuration: **Tip:** Keyman Configuration opens in the same tab you last closed it in. -**Collecting Diagnostic Information** +## Collecting Diagnostic Information You can collect diagnostic information about Keyman by clicking the \'Diagnostics\' link under the \'Useful Links\' section. The support diagnostic will collect critical diagnostic information from your computer and generate a report. -**Checking for Updates** +## Checking for Updates To check for Keyman updates, from the Support tab of Keyman Configuration click the \'Check for Updates\' link. You can also download and install Keyman again from the Keyman website. -**About Version Information** +## About Version Information You can view version details from the Support tab of Keyman -Configuration. In the Support tab you will see: +Configuration. In the Support tab you will see a version +number beneath the Keyman logo. This version number will show +whether you are using a stable or pre-release version of Keyman +and should be reported in its entirety if you are ever requesting +help from the Keyman Community. -- Version Detals - - Edition --- Details on your current edition of Keyman. - - - Version --- The current Keyman version number - -**Accessing the Keyman Community** +## Accessing the Keyman Community [Keyman Community](https://community.software.sil.org/c/keyman) @@ -54,8 +53,7 @@ Configuration. In the Support tab you will see: internet browser. You will need to have internet access for this to open successfully. -**Related Topics** +## Related Topics -- [???](#basic_config_menu) - -- [???](#start_download-and-install-keyman) +- [Keyman Configuration](../config/) +- [How To - Download and Install Keyman](../../start/download-and-install-keyman) diff --git a/windows/src/desktop/help/basic/config_tasks/config_menu.md b/windows/src/desktop/help/basic/config_tasks/config_menu.md deleted file mode 100644 index a10f5337fe..0000000000 --- a/windows/src/desktop/help/basic/config_tasks/config_menu.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: Keyman Configuration {#basic_config_menu} ---- - -Keyman Configuration is the central control panel for Keyman. Use Keyman -Configuration to purchase and activate Keyman, switch the language of -Keyman menus, install and uninstall keyboards, change options, set -hotkeys, disable addins, associate languages, check for updates and run -support diagnostics. - -![](../desktop_images/tab-support.png) - -**Opening Keyman Configuration** - -To open Keyman Configuration: - -1. Click on the Keyman icon ![](../desktop_images/icon-keyman.png), on the - Windows Taskbar near the clock. - -2. From the Keyman menu, select Configuration.... - -**Using Keyman Configuration** - -For more information on using Keyman Configuration, see: - -- [???](#start_locale) - -- [???](#basic_keyboards_tab) - -- [???](#basic_options_tab) - -- [???](#basic_hotkeys_tab) - -- [???](#basic_support_tab) diff --git a/windows/src/desktop/help/basic/keyboard_tasks/disable_keyboard.md b/windows/src/desktop/help/basic/enable-or-disable-keyboard.md similarity index 72% rename from windows/src/desktop/help/basic/keyboard_tasks/disable_keyboard.md rename to windows/src/desktop/help/basic/enable-or-disable-keyboard.md index e2e0774d80..0d9fb6733c 100644 --- a/windows/src/desktop/help/basic/keyboard_tasks/disable_keyboard.md +++ b/windows/src/desktop/help/basic/enable-or-disable-keyboard.md @@ -1,10 +1,12 @@ --- -title: Keyboard Task - Enable and Disable a Keyboard {#basic_disable_keyboard} +title: Keyboard Task - Enable or Disable a Keyboard --- -Keyman keyboards can be enabled and disabled. +Keyman keyboards can be enabled and disabled. When disabled, they are +removed from the list of keyboards you can select from, but they are +not uninstalled. -**Disabling a Keyman keyboard** +## Disabling a Keyman keyboard Disabling a Keyman keyboard removes it from the Keyman menu and Keyman Toolbox but does not uninstall the keyboard. This is useful if: @@ -38,7 +40,7 @@ To disable a Keyman keyboard: When a keyboard layout is disabled, its name appears in grey and its checkbox is unticked. -**Enabling a Keyman keyboard** +## Enabling a Keyman keyboard To enable a Keyman keyboard: @@ -59,10 +61,8 @@ To enable a Keyman keyboard: 6. Click OK. -**Related Topics** +## Related Topics -- [???](#basic_uninstall_keyboard) - -- [???](#basic_enable_keyboard) - -- [???](#basic_keyboards_tab) +- [Keyboard Task - Uninstall a Keyboard](uninstall-keyboard) +- [Keyboard Task - Turn on a Keyboard](select-keyboard) +- [Keyman Configuration - Keyboard Layouts Tab](config/keyboards) diff --git a/windows/src/desktop/help/basic/engine_tasks/uninstall.md b/windows/src/desktop/help/basic/engine_tasks/uninstall.md deleted file mode 100644 index b999d5deb9..0000000000 --- a/windows/src/desktop/help/basic/engine_tasks/uninstall.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Software Task - Uninstall Keyman {#basic_uninstall} ---- - -To uninstall Keyman: - -1. Close Keyman. - -2. Open Windows Control Panel. - -3. Select \'Add or Remove Programs\' or \'Programs and Features\' or - \'Uninstall a program\'. - -4. Click Keyman in the list. - -5. Click Remove or Uninstall or right-click \'Uninstall\'. - -6. Follow the prompts to complete the uninstall. diff --git a/windows/src/desktop/help/basic/index.md b/windows/src/desktop/help/basic/index.md index f7d9f2dfee..0267f1ccc3 100644 --- a/windows/src/desktop/help/basic/index.md +++ b/windows/src/desktop/help/basic/index.md @@ -2,30 +2,21 @@ title: Basic Help --- -* [newways](newways) +* [New Ways to Use Keyman](new-ways-to-use-keyman) -* [update](update) -* [uninstall](uninstall) +* [Update Keyman](update) +* [Uninstall Keyman](uninstall) -* [enable_keyboard](enable_keyboard) -* [disable_keyboard](disable_keyboard) -* [uninstall_keyboard](uninstall_keyboard) +* [Keyboard Task - Turn on a Keyboard](select-keyboard) +* [Keyboard Task - Enable or Disable a Keyboard](enable-or-disable-keyboard) +* [Keyboard Task - Uninstall a Keyboard](uninstall-keyboard) -* [traymenu](traymenu) -* [toolbox](toolbox) -* [osk](osk) -* [usage](usage) -* [fonthelper](fonthelper) -* [charactermap](charactermap) +* [The Keyman Menu](tray-menu) +* [The Keyman Toolbox](toolbox/) +* [Keyman Configuration](config/) +* [Language Switcher](language-switcher) +* [Keyman Text Editor](text-editor) -* [languageswitcher](languageswitcher) +* [How To - Make the Keyman icon visible](make-taskbar-icon-visible) -* [text_editor](text_editor) - -* [config_menu](config_menu) -* [keyboards_tab](keyboards_tab) -* [options_tab](options_tab) -* [hotkeys_tab](hotkeys_tab) -* [support_tab](support_tab) - -* [help](help) +* [About Keyman Help](help) diff --git a/windows/src/desktop/help/basic/languageswitcher.md b/windows/src/desktop/help/basic/language-switcher.md similarity index 89% rename from windows/src/desktop/help/basic/languageswitcher.md rename to windows/src/desktop/help/basic/language-switcher.md index fd4e5e6af2..67a432ef3f 100644 --- a/windows/src/desktop/help/basic/languageswitcher.md +++ b/windows/src/desktop/help/basic/language-switcher.md @@ -21,7 +21,7 @@ To open and use the Keyman Language Switcher **Note:** By default, the Language Switcher hotkey is Left.Alt + Shift. You can view or change the current Language Switcher hotkey from the - [Hotkeys tab](#basic_hotkeys_tab) of Keyman Configuration. + [Hotkeys tab](config/hotkeys) of Keyman Configuration. ![](../desktop_images/languageswitcher-small.png) @@ -35,5 +35,5 @@ To open and use the Keyman Language Switcher ## Related Topics -- [The Keyman Menu](traymenu) -- [Keyman Configuration - Hotkeys Tab](config_tasks/hotkeys_tab) +- [The Keyman Menu](tray-menu) +- [Keyman Configuration - Hotkeys Tab](config/hotkeys) diff --git a/windows/src/desktop/help/basic/newways.md b/windows/src/desktop/help/basic/new-ways-to-use-keyman.md similarity index 78% rename from windows/src/desktop/help/basic/newways.md rename to windows/src/desktop/help/basic/new-ways-to-use-keyman.md index c8d0517e5f..af2f259168 100644 --- a/windows/src/desktop/help/basic/newways.md +++ b/windows/src/desktop/help/basic/new-ways-to-use-keyman.md @@ -8,6 +8,8 @@ you can or should access some of Keyman's features. These changes have been implemented as part of enhancing how Keyman integrates with modern versions of Windows. +## Keyman 14 + Keyman Configuration no longer requires you to click the OK to save changes. All changes are applied instantly. @@ -15,13 +17,18 @@ Keyman keyboards are no longer hidden from the Windows language picker when you exit Keyman. Rather, if you select a Keyman keyboard, Keyman will be restarted for you automatically. +The 'Usage Page' option has been removed as it posed a potential +security risk. + +## Keyman 10-13 + The key change in your usage will be how you access keyboard layouts. With version 9.0 and later, all keyboard layouts are registered as Windows Text Services, and are always available through Windows language -interfaces as well as with the [Keyman menu](#basic_traymenu), [language -switcher](#basic_languageswitcher) and [hotkeys](#basic_hotkeys_tab). +interfaces as well as with the [Keyman menu](tray-menu), [language +switcher](language-switcher) and [hotkeys](config/hotkeys). -[Keyboard Task - Turn on a Keyboard](enable_keyboard) +[Keyboard Task - Turn on a Keyboard](select-keyboard) Most of the following changes were made in Keyman 10.0 @@ -29,7 +36,7 @@ When you install a keyboard layout, it will be registered under the language for which the keyboard has been designed, or if this has not been specified by the keyboard designer, then it will be installed under your default language. You can always change the language registration -in the [Keyboards tab](#basic_keyboards_tab). +in the [Keyboards tab](config/keyboards). In earlier versions of Keyman, language association was controlled in the Languages tab in Keyman Configuration. With the new model of @@ -46,23 +53,6 @@ European Latin-script keyboard. You can change the base layout in the Options tab, which will allow Keyman to automatically generate new versions of your keyboards that adapt to your base layout. -## Other Minor Changes - -- In the Support tab, we have reorganised the support and diagnostics - links. - - - -- The Addins tab has been eliminated as it is no longer required. - - - -- A number of obsolete options have been removed. - - - -- The proxy settings dialog is now accessed through the Options tab. - ## Related Topics - [What's New](../about/whatsnew) diff --git a/windows/src/desktop/help/basic/keyboard_tasks/enable_keyboard.md b/windows/src/desktop/help/basic/select-keyboard.md similarity index 52% rename from windows/src/desktop/help/basic/keyboard_tasks/enable_keyboard.md rename to windows/src/desktop/help/basic/select-keyboard.md index bfd50beff0..f660235def 100644 --- a/windows/src/desktop/help/basic/keyboard_tasks/enable_keyboard.md +++ b/windows/src/desktop/help/basic/select-keyboard.md @@ -1,5 +1,5 @@ --- -title: Keyboard Task - Turn on a Keyboard {#basic_enable_keyboard} +title: Keyboard Task - Turn on a Keyboard --- Here are five simple ways to turn on a Keyman keyboard. @@ -7,17 +7,17 @@ Here are five simple ways to turn on a Keyman keyboard. **Note:** To use a Keyman keyboard, the keyboard must be enabled in the Keyboard Layouts tab of Keyman Configuration. For help enabling your keyboard, -see: +see [Keyboard Task - Enable or Disable a Keyboard](enable-or-disable-keyboard). -**Turning on a Keyboard from the Keyman Menu** +## Turning on a Keyboard from the Keyman Menu To turn on a keyboard from the Keyman menu: 1. Open an application to type in, like MS Word. **Note:** - You need to have an application open for your Keyman keyboard to - load correctly. + You should open an application before you select a Keyman keyboard, + depending on your Windows settings. 2. Start Keyman. @@ -30,7 +30,7 @@ To turn on a keyboard from the Keyman menu: Keyman menu icon change to the icon of your Keyman keyboard. This means your Keyman keyboard is on. -**Turning on a Keyboard from the Keyman Toolbox** +## Turning on a Keyboard from the Keyman Toolbox To turn on a keyboard from the Keyman Toolbox: @@ -51,41 +51,38 @@ To turn on a keyboard from the Keyman Toolbox: Toolbox. You will notice the Keyman menu icon change to the icon of your Keyman keyboard. This means your Keyman keyboard is on. -**Turning on a Keyboard from the Language Switcher** +## Turning on a Keyboard from the Language Switcher -Here\'s how to turn on a keyboard using the Language Switcher: +Here's how to turn on a keyboard using the Language Switcher: 1. Open an application to type in, like MS Word. - **Note:** - You need to have an application open for your Keyman keyboard to - load correctly. - 2. Start Keyman. 3. Press the Language Switcher hotkey to bring up the Language Switcher. If you are using the default Language Switcher hotkey - (Left.Alt + Shift) or another hotkey with Alt, you will need to - press and HOLD the Alt part of the hotkey and press and RELEASE the + (Left Alt + Shift) or another hotkey with + Alt, you will need to press and HOLD the Alt + part of the hotkey and press and RELEASE the last key in the hotkey to use the Language Switcher. When you - release Alt, the Language Switcher will close. + release Alt, the Language Switcher will close. **Note:** - By default, the Language Switcher hotkey is Left.Alt + Shift. You - can view or change the current Language Switcher hotkey from the - [Hotkeys tab](#basic_hotkeys_tab) of Keyman Configuration. + By default, the Language Switcher hotkey is Left Alt + + Shift. You can view or change the current Language Switcher + hotkey from the [Hotkeys tab](config/hotkeys) of Keyman Configuration. ![](../desktop_images/languageswitcher-small.png) 4. Navigate the Language Switcher using the arrow keys or by pressing Shift to select your Keyman keyboard. -5. Release the Language Switcher hotkey or press Enter to activate the - selected keyboard and close the Language Switcher. You will notice - the Keyman menu icon change to the icon of your Keyman keyboard. - This means your Keyman keyboard is on. +5. Release the Language Switcher hotkey or press Enter to + activate the selected keyboard and close the Language Switcher. You + will notice the Keyman menu icon change to the icon of your Keyman + keyboard. This means your Keyman keyboard is on. -**Turning on a Keyboard with a Hotkey** +## Turning on a Keyboard with a Hotkey To turn on a keyboard from the Keyman menu: @@ -98,37 +95,28 @@ To turn on a keyboard from the Keyman menu: **Note:** You can find the current hotkey for your keyboard in the Keyman menu. You can set or reset a hotkey for your keyboard from the - Hotkeys tab - of Keyman Configuration. + Hotkeys tab of Keyman Configuration. ![](../desktop_images/menu.png) 4. You will notice the Keyman menu icon change to the icon of your Keyman keyboard. This means your Keyman keyboard is on. -**Turning on a Keyboard by switching Windows languages** +## Turning on a Keyboard by switching Windows languages Because Keyman keyboards are always associated with a Windows language, -turning on that Windows language will automatically turn on the Keyman -keyboard. If a Windows keyboard is also associated with the language, or -multiple Keyman keyboards are associated with the language, an extra -icon will appear next to the Windows language that will allow you to -choose the keyboard you want to use. +you can also switch Keyman keyboards using the Windows language switcher, +located near the clock in the Taskbar. The default hotkey for the Windows +language switcher is Win + spacebar. Hold the +Win key and press spacebar repeatedly until you +reach the desired keyboard, then release spacebar. -**Related Topics** +## Related Topics -- [???](#basic_traymenu) - -- [???](#basic_toolbox) - -- [???](#basic_languageswitcher) - -- [???](#basic_hotkeys_tab) - -- [???](#basic_keyboards_tab) - -- [???](#start_download-and-install-keyboard) - -- [???](#basic_disable_keyboard) - -- [???](#troubleshooting_hidden) +- [The Keyman Menu](tray-menu) +- [The Keyman Toolbox](toolbox/index) +- [Language Switcher](language-switcher) +- [Keyman Configuration - Hotkeys Tab](config/hotkeys) +- [Keyman Configuration - Keyboard Layouts Tab](config/keyboards) +- [How To - Download and Install a Keyman Keyboard](../start/download-and-install-keyboard) +- [Keyboard Task - Enable or Disable a Keyboard](enable-or-disable-keyboard) \ No newline at end of file diff --git a/windows/src/desktop/help/basic/text_editor.md b/windows/src/desktop/help/basic/text-editor.md similarity index 90% rename from windows/src/desktop/help/basic/text_editor.md rename to windows/src/desktop/help/basic/text-editor.md index 3bf4ac9fcc..8e08fab5f4 100644 --- a/windows/src/desktop/help/basic/text_editor.md +++ b/windows/src/desktop/help/basic/text-editor.md @@ -30,7 +30,7 @@ To use the Keyman Text Editor: When you select a Unicode Keyman keyboard, the Text Editor brings up a font panel. This font panel behaves like the [Font Helper -tool](#basic_fonthelper) in the Keyman Toolbox. Each font listed in the +tool](toolbox/font-helper) in the Keyman Toolbox. Each font listed in the panel includes a percentage value. This value indicates how many characters in the current Keyman keyboard are available from the font. Most of the time, fonts with greater than 90% coverage will work for @@ -42,4 +42,4 @@ link for the font in the font panel. ## Related Topics - [Getting Started with Keyman](../start/tutorial) -- [Keyboard Task - Turn on a Keyboard](enable_keyboard) +- [Keyboard Task - Turn on a Keyboard](select-keyboard) diff --git a/windows/src/desktop/help/basic/toolbox/character-map.md b/windows/src/desktop/help/basic/toolbox/character-map.md new file mode 100644 index 0000000000..b4c7d84644 --- /dev/null +++ b/windows/src/desktop/help/basic/toolbox/character-map.md @@ -0,0 +1,238 @@ +--- +title: Keyman Toolbox - Character Map +--- + +The Character Map tool in the [Keyman Toolbox](../toolbox/) can be +used to find and insert any standard Unicode character into your text. + +![](../../desktop_images/charmap.png) + +## Opening the Character Map + +To open the Keyman Character Map: + +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the + Windows Taskbar near the clock. + +2. From the Keyman menu, select Character Map. + +## Using the Character Map + +To insert a character from the Character Map into a document: + +1. Position the text cursor in your document where you want to insert + the character. + +2. Locate the character in the Character Map. + +3. Insert the character by: + + - Selecting the character and pressing the Enter key. + + - Double-clicking on the character. + + - Right-clicking on the character and selecting Insert Character. + +**Note:** +If the Insert Mode is set to Code or Name, pressing Enter or +double-clicking on a character will insert the Unicode code or Unicode +name of the character, not the character itself! + +**Note:** +You can also hold Ctrl and then a single click on a character will +insert it into the document. This allows for smoother insertion of +multiple characters from the Character Map. + +## Character Map Options + +![](../../desktop_images/charmap-options.png) + +Right click on the Character Map to display a menu with the following +options: + +Insert Character +: Inserts the selected character at the cursor position in your document. + +Filter... +: Sends the curser to the \'Filter by\' Character Map search field. +: See [Filtering](#filtering) below. + +Goto... +: Displays the Goto dialog box. See [Goto](#goto) below. + +Font... +: Allows you to choose a different font for use in +: the Character Map. This will not affect the font +: being used in your document! See [Fonts and +: Characters](#fonts) below. + +Insert Mode +: Allows you to select your desired character insert +: mode. See [Insert Modes](#insertmodes) below. + +Display Quality +: Allows you to set the desired display quality for +: the characters in the Character Map. See +: [Display Quality](#displayquality) below. + +## Character Map Options - Filter... + +You can search the Character Map by using the Filter by search field at +the bottom of the Character Map window. + +![](../../desktop_images/charmap-filter.png) + +When no search filter is applied, the Character Map shows all characters +from the Unicode standard. If a filter has been applied, the name of the +filter will appear in the upper left corner of the Character Map window. + +![](../../desktop_images/charmap-big.png) + +The following parameters define how the search filter in the Character +Map works: + +- When searching by Unicode name, the filter field searches within of + the Unicode name. + +- When searching by Unicode code point or range, the filter field + allows 2, 3, and 4 digit partial code points. For example, all of + the following will give the Latin Capital Letter E (U+0045): + + - 45 + - 045 + - 0045 + - U+45 + - U+045 + - U+0045 + +- Filter entries can use the letters A-Z, the numerals 0-9 and the + characters underscore (\_), hyphen (-) and plus (+). + +- Filter entries are NOT case sensitive. + +- Spaces between words in a filter entry can be represented by either + underscore (\_) or space ( ). Spaces at the end of a filter entry + must be represented by underscore; otherwise they will be discarded + during the search. + +- Filters can be entered by Unicode character names or Unicode + character ranges. + +- The filtering format for a character range is given below, where U+ + is optional, XXXX is the starting Unicode value and YYYY is the + finishing Unicode value. + + [U+]XXXX-[U+]YYYY + +- The filtering options for character names are: + + - `>` placed at the start of an entry will only show characters + in the currently selected Character Map font. This is helpful + when trying to determine which characters a given font supports. + + - `<` placed at the start of an entry will search Unicode block + names instead of character names. This is helpful when searching + for characters within related blocks (e.g. all Latin blocks). + + - Words are searched in order, so for example `latin capital letter b` + will not find different results than `latin letter capital b`. + + - Using `?` anywhere in an entry serves as a wildcard for that + single place in the entry. For example, searching for `s???e` + will return both the SPACE and the SMILE characters, among + others. + + - `[ - ]` is used to match any character in a set. For + instance, `[ac-z]` matches all letters except "b". A set can + be made up of ranges and individual characters, but cannot be + made up of `?` or `*`. + + - `$` placed at the end of an entry will match from the end of + a Unicode character name. This option works best when used with + `*` or `?`. + + - As noted above, when no filtering options are in use, the filter + field searches for characters within their Unicode names. + +The following chart provides examples of filtering. + +| Filter Entry | Filter Result | +|-----------------------|-----------------------------------------------| +| `latin capital letter a` | Searches for all Unicode characters whose names contain the words starting with "latin", "capital", "letter", and "a". Thus, finds all variations of the Latin capital letter A, plus the Latin capital letter Alpha and the Latin capital letter African d. +| `latin letter a` | Searches for all Unicode characters whose names contain words starting with "latin", "letter", and "a". Thus, finds all variations of the Latin letter A capital and lower case, along with a small selection of other characters whose names fit the search. +| `_[aeu]_ acute` | Matches all letter "a", "e", or "u" with an acute mark. The `_` matches a space. +| `latin letter [aeiou]` | Searches for all Unicode characters whose names contains words starting with "latin", "letter", and "a", "e", "i", "o", or "u". Finds all variations of the Latin vowels A,E,I,O,U, both upper and lower case, along with a small selection of other characters whose names fit the search. +| `lao` | Searches the current Character Map font for all available characters whose names begin with the sequence "Lao". +| `YI_` | Searches for all characters whose Unicode names begin with the sequence "YI" followed by a space. Finds all YI syllables and YI radicals. Note: You must use underscore (`_`) and not space (` `) at the end of a filter entry. Spaces at the end of a filter entry are discarded. If you had used `YI ` (with space) instead of `YI_`, the search would also return the character YIN_YANG. +| `latin letter _a$` | Searches for all Unicode characters whose names contain word starting with "latin" and "letter", and end with the word "a". +| `1000-109F` | Searches for all Unicode characters in the range from U+1000 to U+109F (inclusive). Finds all characters - in this case, the Myanmar block. + + +To help you edit filters, the Filter dialog is available from the +Character Map by clicking the ![...](../../desktop_images/charmap-button.png) +button. + +![](../../desktop_images/charmap-filterdialog.png) + +## Character Map Options - Goto... + +The Goto tool can be used to move directly to a specific Unicode +character or value. + +1. Right click on a character and select Goto. The Enter Unicode + character value or namedialog box will be displayed: + + ![](../../desktop_images/charmap-goto.png) + +2. Enter a Unicode character value (e.g. `6B` or `U+006B`) OR enter + the start of the character name (e.g. `Lao letter`, which will go + to the first matching character, "LAO_LETTER_KO") + +3. Click OK. The Character Map will move to the chosen character, if + available. + +## Character Map Options - Font... + +You can choose the font for use in the Character Map tool by right +clicking on the Character Map window and selecting Font. + +![](../../desktop_images/charmap-font.png) + +From the Font dialog, you can select to display the Character Map using +any of the fonts available on your system. If a character is not +available in the selected font, the Character Map will use font linking +to attempt to find a character from other fonts installed on your system. +As a last resort, the Character Map will show square boxes or question +marks if no suitable font can be found for a character. + +## Character Map Options - Insert Mode + +Characters can be inserted from the Character Map using one of three +insert modes - Code, Character and Name: + +- Code - Inserts the character's Unicode code. +- Character - Inserts the character itself. +- Name - Inserts the character's Unicode name. + +To change the character insert mode: + +1. Right-click on the Character Map. +2. Highlight the Insert Mode submenu. + ![](../../desktop_images/charmap-insert.png) +3. Choose the desired insert mode from the submenu. + +## Character Map Options - Display Quality + +![](../../desktop_images/charmap-quality.png) + +There are three options for the display quality of characters in the +Character Map. + +- Plain - Uses no font smoothing. +- Antialiased - Uses the Windows standard font smoothing. +- ClearType - Uses the Windows ClearType font smoothing. + +## Related Topics + +- [The Keyman Toolbox](../toolbox/) diff --git a/windows/src/desktop/help/basic/toolbox_tasks/fonthelper.md b/windows/src/desktop/help/basic/toolbox/font-helper.md similarity index 72% rename from windows/src/desktop/help/basic/toolbox_tasks/fonthelper.md rename to windows/src/desktop/help/basic/toolbox/font-helper.md index 62483fb761..4d19984771 100644 --- a/windows/src/desktop/help/basic/toolbox_tasks/fonthelper.md +++ b/windows/src/desktop/help/basic/toolbox/font-helper.md @@ -1,23 +1,23 @@ --- -title: Keyman Toolbox - Font Helper {#basic_fonthelper} +title: Keyman Toolbox - Font Helper --- -The Font Helper tool in the [Keyman Toolbox](#basic_toolbox) identifies +The Font Helper tool in the [Keyman Toolbox](../toolbox/) identifies fonts on your system that should work with the currently selected keyboard layout. -![](../desktop_images/fonthelper.png) +![](../../desktop_images/fonthelper.png) -**Opening the Font Helper** +## Opening the Font Helper To open the Font Helper: -1. Click on the Keyman icon ![](../desktop_images/icon-keyman.png), on the +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the Windows Taskbar near the clock. 2. From the Keyman menu, select Font Helper. -**Using the Font Helper** +## Using the Font Helper To use the Font Helper: @@ -41,8 +41,7 @@ If no fonts are listed in the Font Helper, check the documentation of the keyboard layout to see if it includes information on where to obtain the fonts you need. -**Related Topics** +## Related Topics -- [???](#basic_toolbox) - -- [???](#basic_enable_keyboard) +- [The Keyman Toolbox](../toolbox/) +- [Keyboard Task - Turn on a Keyboard](../select-keyboard) diff --git a/windows/src/desktop/help/basic/toolbox/index.md b/windows/src/desktop/help/basic/toolbox/index.md new file mode 100644 index 0000000000..42f850763e --- /dev/null +++ b/windows/src/desktop/help/basic/toolbox/index.md @@ -0,0 +1,85 @@ +--- +title: The Keyman Toolbox +--- + +The Keyman Toolbox contains a collection of tools for working with +Keyman. + +![](../../desktop_images/osk_keyboard.png) + +## Opening the Keyman Toolbox + +To display the Keyman Toolbox: + +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the + Windows Taskbar near the clock. + +2. From the Keyman menu, select On Screen Keyboard. + +**Note:** +The Keyman Toolbox is displayed by default in the last position it was +used. It will be displayed initially in the bottom right hand corner of +the screen. + +**Note:** +The Keyman Toolbox opens automatically when you select a Keyman keyboard +layout. You can change this behaviour in the Options tab of Keyman Configuration. + +## Using the Keyman Toolbox + +Along the top of the Keyman Toolbox is a toolbar. + +![](../../desktop_images/toolbox-toolbar.png) + +Any of the following buttons may appear in the toolbar: + +| Icon | Button Name | Description | +|---|---------------------|--------------------------------------------| +| ![](../../desktop_images/toolboxicon-osk.png) | View On Screen Keyboard | Opens the [On Screen Keyboard](osk) for the currently selected Keyman keyboard or Windows layout. +| ![](../../desktop_images/toolboxicon-fonthelper.png) | View Font Helper | Opens the [Font Helper](font-helper) for the selected Keyman keyboard. +| ![](../../desktop_images/toolboxicon-charmap.png) | View Character Map | Opens the [Keyman Character Map](character-map). +| ![](../../desktop_images/toolboxicon-config.png) | Open Keyman Configuration | Opens [Keyman Configuration](../config/), where you can install or uninstall keyboard layouts and change various Keyman options and settings. +| ![](../../desktop_images/toolboxicon-help.png) | Open Help | Opens [Keyman Help](../help). +| ![](../../desktop_images/toolboxicon-close.png) | Close Keyman Toolbox | Closes the Keyman Toolbox but does not exit Keyman. The Keyman Toolbox can be displayed again by following the instructions at the top of this help topic. + +You can move the Keyman Toolbox around your screen by clicking and +dragging anywhere on the Keyman Toolbox toolbar not covered by a button. + +You can resize the Keyman Toolbox by clicking and dragging on a corner +of the Keyman Toolbox. + +**Note:** +When the On Screen Keyboard tool is selected, the Keyman Toolbox will +only resize according to the proportions of the keyboard. + +## Toolbox Options + +![](../../desktop_images/toolbox-options.png) + +Right click on the Keyman Toolbox to display a menu with the following +options: + +Fade When Inactive +: If this option is enabled, the Keyman Toolbox appears partially transparent + when the mouse is not over it. + +Show Toolbar +: This option hides or displays the toolbar at the top of the Keyman Toolbox. + +Save as Web Page... +: This option saves the keyboard view of the current + keyboard layout as a web page for easy reference. + The new web page will include diagrams for every state + of the current keyboard layout, including shift states. + +Print... +: This option prints the keyboard view of the current + keyboard layout for easy reference. The printout + will include diagrams for every state of the + current keyboard layout, including shift states. + +## Related Topics + +- [On Screen Keyboard](osk) +- [Font Helper](font-helper) +- [Character Map](character-map) diff --git a/windows/src/desktop/help/basic/toolbox_tasks/osk.md b/windows/src/desktop/help/basic/toolbox/osk.md similarity index 51% rename from windows/src/desktop/help/basic/toolbox_tasks/osk.md rename to windows/src/desktop/help/basic/toolbox/osk.md index 806e59fd99..02de5aac6f 100644 --- a/windows/src/desktop/help/basic/toolbox_tasks/osk.md +++ b/windows/src/desktop/help/basic/toolbox/osk.md @@ -1,82 +1,73 @@ --- -title: Keyman Toolbox - On Screen Keyboard {#basic_osk} +title: Keyman Toolbox - On Screen Keyboard --- -The On Screen Keyboard tool of the [Keyman Toolbox](#basic_toolbox) +The On Screen Keyboard tool of the [Keyman Toolbox](../toolbox/) shows the currently selected Keyman keyboard or Windows layout. -![](../desktop_images/osk-tibetan.png) +![](../../desktop_images/osk-tibetan.png) **Note:** Some Keyman keyboards do not contain an On Screen Keyboard view. You can -find more help for those keyboards from the +find more help for those keyboards from the Help icon on the Keyman Toolbox toolbar. -Keyboard Usage tool - -of the Keyman Toolbox. - -**Opening the On Screen Keyboard** +## Opening the On Screen Keyboard To open the On Screen Keyboard: -1. Click on the Keyman icon ![](../desktop_images/icon-keyman.png), on the +1. Click on the Keyman icon ![](../../desktop_images/icon-keyman.png), on the Windows Taskbar near the clock. 2. From the Keyman menu, select On Screen Keyboard. -**Using the On Screen Keyboard** +## Using the On Screen Keyboard You can use the On Screen Keyboard in two ways: - As a reference help, to teach you how to type all the letters in your Keyman keyboard. - - To enter text by point-and-click. To use the On Screen Keyboard as a reference help: 1. Open the On Screen Keyboard - 2. Type on your physical keyboard, using the On Screen Keyboard as a guide. **Note:** The On Screen Keyboard will match the Shift state of your hardware - keyboard. This means you can press any combination of Shift, Ctrl, - Alt and AltGr (or RightAlt) and the On Screen Keyboard will change - to show you the Shift state of your hardware keyboard. + keyboard. This means you can press any combination of Shift, + Ctrl, Alt and AltGr (or + RightAlt) and the On Screen Keyboard will change + to show you the modifier state of your hardware keyboard. To enter text using the On Screen Keyboard: 1. Position your text cursor where you want to type in your application. -2. On the On Screen Keyboard, click Shift, Ctrl or Alt if you need them - to type your desired character. +2. On the On Screen Keyboard, click Shift, Ctrl or + Alt if you need them to type your desired character. 3. On the On Screen Keyboard, click the key with the character you want to enter. When a Keyman keyboard is on, the black font on the keycaps shows the -characters assigned to each key. The blue font on the keycaps shows the -characters of the Windows layout currently associated with the Keyman -keyboard. +characters assigned to each key. The smaller grey font on the keycaps +shows the characters of the Windows layout currently associated with the +Keyman keyboard. -When no Keyman keyboard is on, the blue font on the keycaps shows the +When no Keyman keyboard is on, the grey font on the keycaps shows the characters of your active Windows layout. **Note:** Some Keyman keyboards do not have an On Screen Keyboard view. For keyboards designed phonetically, this is because there is not a simple 1-1 correspondence between each key and the letter you want to type. The -Keyboard Usage tool is often helpful for these keyboards and Keyman will switch to this view -by default. This option can be changed in Keyman Configuration. +keyboard help will usually provide more information on how to use these +keyboards. +## Related Topics -**Related Topics** - -- [???](#basic_toolbox) - -- [???](#basic_usage) - -- [???](#basic_options_tab) +- [The Keyman Toolbox](../toolbox/) +- [Keyman Configuration - Options tab](../config/options) diff --git a/windows/src/desktop/help/basic/toolbox_tasks/usage.md b/windows/src/desktop/help/basic/toolbox_tasks/usage.md deleted file mode 100644 index 1c198dcfc0..0000000000 --- a/windows/src/desktop/help/basic/toolbox_tasks/usage.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Keyman Toolbox - Keyboard Usage {#basic_usage} ---- - -The Keyboard Usage tool of the [Keyman Toolbox](#basic_toolbox) shows -helpful hints on how to use the currently selected Keyman keyboard. - -Keyman allows you to select either Keyboard Usage or the On-Screen -Keyboard - -![](../desktop_images/usage.png) - -**Opening Keyboard Usage** - -To open the Keyboard Usage tool: - -1. Click on the Keyman icon ![](../desktop_images/icon-keyman.png), on the - Windows Taskbar near the clock. - -2. From the Keyman menu, select Keyboard Usage. - -**Using Keyboard Usage** - -The content of the Keyboard Usage tool changes depending on the active -Keyman keyboard: - -- Some keyboards include dynamic help in Keyboard Usage. This help - allows you to click on a letter to insert it into your document - directly. - - ![](../desktop_images/usage-dynamic.png) - -- Some keyboards include static help in Keyboard Usage. This help will - give you important information about the keyboard. - - ![](../desktop_images/usage-static.png) - -- Some keyboards include links to help documentation in Keyboard - Usage. Click Keyboard Help to find the help document for the - keyboard. - - ![](../desktop_images/usage-help.png) - -- Some keyboards include links to the On Screen Keyboard tool in - Keyboard Usage. This means that the keyboard has an On Screen - Keyboard view. - - ![](../desktop_images/usage-osk.png) - -- Some keyboards do not include Keyboard Usage. You may find help for - these keyboards by looking in the Windows Start menu, under the name - of the keyboard. - - ![](../desktop_images/usage-none.png) - -**Related Topics** - -- [???](#basic_toolbox) - -- [???](#basic_osk) - -- [???](#basic_enable_keyboard) diff --git a/windows/src/desktop/help/basic/tray-menu.md b/windows/src/desktop/help/basic/tray-menu.md new file mode 100644 index 0000000000..e3cf87f597 --- /dev/null +++ b/windows/src/desktop/help/basic/tray-menu.md @@ -0,0 +1,79 @@ +--- +title: The Keyman Menu +--- + +## Opening the Keyman Menu + +When you start Keyman, the Keyman icon +(![](../desktop_images/icon-keyman.png)) is displayed on the Windows +Taskbar near the clock. This area is called the System Tray or System +Notification Area. + +![](../desktop_images/start_tray.png) + +To display the Keyman menu, click on the Keyman icon. + +![](../desktop_images/menu.png) + +**Note**: If you cannot find the Keyman menu or Keyman icon, for more help see: + +[Finding a Missing Keyman Menu](make-taskbar-icon-visible) + +## Using the Keyman Menu + +Click the Keyman icon (![](../desktop_images/icon-keyman.png)) with either +mouse button to bring up the Keyman menu. + +![](../desktop_images/menu.png) + +The left side of the Keyman menu lists the Keyman keyboards currently +installed and enabled on your computer. Click on a keyboard to turn it +on and start using it. + +**Note**: You can add more Keyman keyboards to the Keyman menu through the Keyboard +Layouts tab of Keyman Configuration. + +**Note**: To use a Keyman keyboard, the keyboard must be enabled in the Keyboard Layouts +tab of Keyman Configuration. For help enabling your keyboard, see +[Keyboard Task - Enable or Disable a Keyboard](enable-or-disable-keyboard). + +The right side of the Keyman menu contains links to tools and features +in Keyman: + +![](../desktop_images/menuicon-osk.png) +: Opens or closes the On Screen Keyboard tool + +![](../desktop_images/menuicon-fonthelper.png) +: Opens or closes the Font Helper tool + +![](../desktop_images/menuicon-charmap.png) +: Opens or closes the Character Map tool + +![](../desktop_images/menuicon-texteditor.png) +: Opens the Keyman Text Editor + +![](../desktop_images/menuicon-config.png) +: Opens Keyman Configuration + +![](../desktop_images/menuicon-help.png) +: Opens Keyman Help + +![](../desktop_images/menuicon-exit.png) +: Exits Keyman + +## Finding a Missing Keyman Menu + +If you cannot find the Keyman icon for the Keyman menu, it may be in the +hidden notifications area of the Windows Taskbar. Check for the Keyman +icon by clicking the arrow or triangle next to the Windows clock. + +If the Keyman icon is in this collection, you can optionally +[move it permanently to the Windows Taskbar](make-taskbar-icon-visible), +to make it more easily accessible. However, Keyman will run +correctly even if the icon is left in this collection. + +## Related Topics + +- [The Keyman Toolbox](toolbox/) +- [Keyboard Task - Turn on a Keyboard](select-keyboard) +- [How To - Make the Keyman icon visible](make-taskbar-icon-visible) \ No newline at end of file diff --git a/windows/src/desktop/help/basic/keyboard_tasks/uninstall_keyboard.md b/windows/src/desktop/help/basic/uninstall-keyboard.md similarity index 62% rename from windows/src/desktop/help/basic/keyboard_tasks/uninstall_keyboard.md rename to windows/src/desktop/help/basic/uninstall-keyboard.md index 59618a4919..f98c6daaac 100644 --- a/windows/src/desktop/help/basic/keyboard_tasks/uninstall_keyboard.md +++ b/windows/src/desktop/help/basic/uninstall-keyboard.md @@ -1,13 +1,12 @@ --- -title: Keyboard Task - Uninstall a Keyboard {#basic_uninstall_keyboard} +title: Keyboard Task - Uninstall a Keyboard --- Uninstalling a Keyman keyboard removes it from Keyman. If you want to use the Keyman keyboard again it must be reinstalled. -**Note:** -You can disable a keyboard temporarily, instead of uninstalling it. For -more help, see: +**Note:** You can disable a keyboard temporarily, instead of uninstalling it. For +more help, see: [Keyboard Task - Enable or Disable a Keyboard](enable-or-disable-keyboard). To uninstall a Keyman keyboard: @@ -34,10 +33,8 @@ To uninstall a Keyman keyboard: The Keyman keyboard is now removed from Keyman. -**Related Topics** +## Related Topics -- [???](#basic_disable_keyboard) - -- [???](#basic_enable_keyboard) - -- [???](#start_download-and-install-keyboard) +- [Keyboard Task - Enable or Disable a Keyboard](enable-or-disable-keyboard) +- [Keyboard Task - Turn on a Keyboard](select-keyboard) +- [How To - Download and Install a Keyman Keyboard](../start/download-and-install-keyboard) diff --git a/windows/src/desktop/help/basic/uninstall.md b/windows/src/desktop/help/basic/uninstall.md new file mode 100644 index 0000000000..d9952a4279 --- /dev/null +++ b/windows/src/desktop/help/basic/uninstall.md @@ -0,0 +1,32 @@ +--- +title: Software Task - Uninstall Keyman +--- + +## Uninstall Keyman from Windows 10 + +1. Exit Keyman. + +2. Open Windows Start Menu and type "Add or Remove Programs", and open that app. + +3. In the App & features search box, type "Keyman". + +4. Click Keyman in the list. + +5. Click Uninstall. + +6. Follow the prompts to complete the uninstall. + +## Uninstall Keyman from Windows 7 or 8 + +1. Exit Keyman. + +2. Open Windows Control Panel. + +3. Select \'Add or Remove Programs\' or \'Programs and Features\' or + \'Uninstall a program\'. + +4. Click Keyman in the list. + +5. Click Remove or Uninstall or right-click \'Uninstall\'. + +6. Follow the prompts to complete the uninstall. diff --git a/windows/src/desktop/help/basic/engine_tasks/update.md b/windows/src/desktop/help/basic/update.md similarity index 69% rename from windows/src/desktop/help/basic/engine_tasks/update.md rename to windows/src/desktop/help/basic/update.md index 33c4e899a5..37e4e3237f 100644 --- a/windows/src/desktop/help/basic/engine_tasks/update.md +++ b/windows/src/desktop/help/basic/update.md @@ -1,8 +1,8 @@ --- -title: Software Task - Update Keyman {#basic_update} +title: Software Task - Update Keyman --- -**Check for Updates Automatically** +## Check for Updates Automatically Keyman can check for updates automatically once a week. Here\'s how: @@ -21,18 +21,18 @@ Keyman can check for updates automatically once a week. Here\'s how: 5. Click OK to apply changes. -**Check for Updates Manually** +## Check for Updates Manually You can check for updates at any time by clicking \'Check for Updates...\' from the Support tab of Keyman Configuration. ![](../desktop_images/tab-support.png) -**Updating Manually** +## Updating Manually You can manually update Keyman at any time by downloading and installing -it again from the [Keyman Website](https://keyman.com/). +Keyman for Windows again from the [Keyman Website](https://keyman.com/windows/download). -**Related Topics** +## Related Topics -- [???](#advanced_proxy_config) +- [Proxy Configuration](../advanced/proxy_config) diff --git a/windows/src/desktop/help/context/index.md b/windows/src/desktop/help/context/index.md index 0b929f0619..7ca83be11c 100644 --- a/windows/src/desktop/help/context/index.md +++ b/windows/src/desktop/help/context/index.md @@ -26,7 +26,7 @@ title: Contextual Help * [osk_keyboard](osk_keyboard) * [osk_usage](osk_usage) * [fonthelper](fonthelper) -* [charactermap](charactermap) +* [character-map](character-map) * [psrtwindowslanguage](psrtwindowslanguage) * [psrtmsofficelanguage](psrtmsofficelanguage) \ No newline at end of file diff --git a/windows/src/desktop/help/context/manualactivate.md b/windows/src/desktop/help/context/manualactivate.md deleted file mode 100644 index cf14d9c77b..0000000000 --- a/windows/src/desktop/help/context/manualactivate.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Manually Activate Keyman ---- diff --git a/windows/src/desktop/help/desktop_images/menu.png b/windows/src/desktop/help/desktop_images/menu.png index 84924c8bfb..759e93c390 100644 Binary files a/windows/src/desktop/help/desktop_images/menu.png and b/windows/src/desktop/help/desktop_images/menu.png differ diff --git a/windows/src/desktop/help/desktop_images/options-advanced.png b/windows/src/desktop/help/desktop_images/options-advanced.png index 153a05a9de..f208cd9581 100644 Binary files a/windows/src/desktop/help/desktop_images/options-advanced.png and b/windows/src/desktop/help/desktop_images/options-advanced.png differ diff --git a/windows/src/desktop/help/desktop_images/options-general.png b/windows/src/desktop/help/desktop_images/options-general.png index 7a5cc8d9fe..cb17931e68 100644 Binary files a/windows/src/desktop/help/desktop_images/options-general.png and b/windows/src/desktop/help/desktop_images/options-general.png differ diff --git a/windows/src/desktop/help/desktop_images/options-osk.png b/windows/src/desktop/help/desktop_images/options-osk.png index 02b382806b..3d04af6353 100644 Binary files a/windows/src/desktop/help/desktop_images/options-osk.png and b/windows/src/desktop/help/desktop_images/options-osk.png differ diff --git a/windows/src/desktop/help/desktop_images/options-startup.png b/windows/src/desktop/help/desktop_images/options-startup.png index 821e01375e..19e04e2183 100644 Binary files a/windows/src/desktop/help/desktop_images/options-startup.png and b/windows/src/desktop/help/desktop_images/options-startup.png differ diff --git a/windows/src/desktop/help/desktop_images/tab-options.png b/windows/src/desktop/help/desktop_images/tab-options.png index 06c068699e..8f443bcac3 100644 Binary files a/windows/src/desktop/help/desktop_images/tab-options.png and b/windows/src/desktop/help/desktop_images/tab-options.png differ diff --git a/windows/src/desktop/help/desktop_images/tab-options2.png b/windows/src/desktop/help/desktop_images/tab-options2.png index 302d286ae7..16b4e5816a 100644 Binary files a/windows/src/desktop/help/desktop_images/tab-options2.png and b/windows/src/desktop/help/desktop_images/tab-options2.png differ diff --git a/windows/src/desktop/help/desktop_images/tab-support.png b/windows/src/desktop/help/desktop_images/tab-support.png index 13af121735..b77aa34174 100644 Binary files a/windows/src/desktop/help/desktop_images/tab-support.png and b/windows/src/desktop/help/desktop_images/tab-support.png differ diff --git a/windows/src/desktop/help/desktop_images/toolbox-hints.png b/windows/src/desktop/help/desktop_images/toolbox-hints.png deleted file mode 100644 index 8c962b4da2..0000000000 Binary files a/windows/src/desktop/help/desktop_images/toolbox-hints.png and /dev/null differ diff --git a/windows/src/desktop/help/desktop_images/toolbox-toolbar.png b/windows/src/desktop/help/desktop_images/toolbox-toolbar.png index ea97cf4b99..01e9c623c0 100644 Binary files a/windows/src/desktop/help/desktop_images/toolbox-toolbar.png and b/windows/src/desktop/help/desktop_images/toolbox-toolbar.png differ diff --git a/windows/src/desktop/help/desktop_images/usage-dynamic.png b/windows/src/desktop/help/desktop_images/usage-dynamic.png deleted file mode 100644 index 244e03bcb0..0000000000 Binary files a/windows/src/desktop/help/desktop_images/usage-dynamic.png and /dev/null differ diff --git a/windows/src/desktop/help/desktop_images/usage-help.png b/windows/src/desktop/help/desktop_images/usage-help.png deleted file mode 100644 index 3bf3c0893c..0000000000 Binary files a/windows/src/desktop/help/desktop_images/usage-help.png and /dev/null differ diff --git a/windows/src/desktop/help/desktop_images/usage-none.png b/windows/src/desktop/help/desktop_images/usage-none.png deleted file mode 100644 index 34b0dd5a59..0000000000 Binary files a/windows/src/desktop/help/desktop_images/usage-none.png and /dev/null differ diff --git a/windows/src/desktop/help/desktop_images/usage-osk.png b/windows/src/desktop/help/desktop_images/usage-osk.png deleted file mode 100644 index d89e76cc03..0000000000 Binary files a/windows/src/desktop/help/desktop_images/usage-osk.png and /dev/null differ diff --git a/windows/src/desktop/help/desktop_images/usage-static.png b/windows/src/desktop/help/desktop_images/usage-static.png deleted file mode 100644 index b1fc20f124..0000000000 Binary files a/windows/src/desktop/help/desktop_images/usage-static.png and /dev/null differ diff --git a/windows/src/desktop/help/desktop_images/usage.png b/windows/src/desktop/help/desktop_images/usage.png deleted file mode 100644 index 9a952a65c5..0000000000 Binary files a/windows/src/desktop/help/desktop_images/usage.png and /dev/null differ diff --git a/windows/src/desktop/help/htmlink.lua b/windows/src/desktop/help/htmlink.lua index f5641f57c2..d74d974c2d 100644 --- a/windows/src/desktop/help/htmlink.lua +++ b/windows/src/desktop/help/htmlink.lua @@ -1,10 +1,18 @@ function Link(elem) - if isLocalElem(elem) then - return pandoc.Link(elem.content, elem.target .. '.html', elem.title, elem.attr) + if isLocalLink(elem) then + if isFolderLink(elem) then + return pandoc.Link(elem.content, elem.target .. 'index.html', elem.title, elem.attr) + else + return pandoc.Link(elem.content, elem.target .. '.html', elem.title, elem.attr) + end end return elem end -function isLocalElem(elem) +function isLocalLink(elem) return string.match(elem.target, "://") == nil -end \ No newline at end of file +end + +function isFolderLink(elem) + return not ( string.match(elem.target, "/$") == nil ) +end diff --git a/windows/src/desktop/help/index.md b/windows/src/desktop/help/index.md index 9fea314536..8f9a439770 100644 --- a/windows/src/desktop/help/index.md +++ b/windows/src/desktop/help/index.md @@ -2,16 +2,16 @@ title: Keyman 14.0 Help --- -* [About Keyman](about) +* [About Keyman](about/) -* [Getting Started](start) +* [Getting Started](start/) -* [Basic Help](basic) +* [Basic Help](basic/) -* [Advanced Help](advanced) +* [Advanced Help](advanced/) -* [Common Questions](common) +* [Common Questions](common/) -* [Troubleshooting](troubleshooting) +* [Troubleshooting](troubleshooting/) -* [Contextual Help](context) +* [Contextual Help](context/) diff --git a/windows/src/desktop/help/start/configure-computer.md b/windows/src/desktop/help/start/configure-computer.md index ff9fcc0b79..65728969e4 100644 --- a/windows/src/desktop/help/start/configure-computer.md +++ b/windows/src/desktop/help/start/configure-computer.md @@ -71,4 +71,4 @@ Correctly associating your Keyman keyboard has three main benefits. - [How To - Set up MS Office for a Keyman Keyboard](configure_office) - [How To - Find the Best Fonts for a Keyman Keyboard](font) - [How To - Type in Right-to-Left Languages](rtl) -- [Keyboard Task - Turn on a Keyboard](enable_keyboard) +- [Keyboard Task - Turn on a Keyboard](../basic/select-keyboard) diff --git a/windows/src/desktop/help/start/configure_office.md b/windows/src/desktop/help/start/configure_office.md index 7f5a3340a6..972b7d2c2f 100644 --- a/windows/src/desktop/help/start/configure_office.md +++ b/windows/src/desktop/help/start/configure_office.md @@ -107,4 +107,4 @@ To set up Microsoft Office 2003 for your Keyman keyboard: - [How To - Set up Your Computer for a Keyman Keyboard](configure-computer) - [How To - Find the Best Fonts for a Keyman Keyboard](font) - [How To - Type in Right-to-Left Languages](rtl) -- [Keyboard Task - Turn on a Keyboard](enable_keyboard) +- [Keyboard Task - Turn on a Keyboard](../basic/select-keyboard) diff --git a/windows/src/desktop/help/start/download-and-install-keyboard.md b/windows/src/desktop/help/start/download-and-install-keyboard.md index bb42d4831f..096f4fd285 100644 --- a/windows/src/desktop/help/start/download-and-install-keyboard.md +++ b/windows/src/desktop/help/start/download-and-install-keyboard.md @@ -126,8 +126,8 @@ how: ## Related Topics - [How To - Download and Install Keyman](download-and-install-keyman) -- [Keyboard Task - Turn on a Keyboard](../basic/enable_keyboard) -- [Keyboard Task - Enable and Disable a Keyboard](../basic/disable_keyboard) -- [Keyboard Task - Uninstall a Keyboard](../basic/uninstall_keyboard) -- [Keyman Configuration - Keyboard Layouts Tab](../basic/config_tasks/keyboards_tab) -- [Keyman Configuration](../basic/config_tasks/config_menu) +- [Keyboard Task - Turn on a Keyboard](../basic/select-keyboard) +- [Keyboard Task - Enable or Disable a Keyboard](../basic/enable-or-disable-keyboard) +- [Keyboard Task - Uninstall a Keyboard](../basic/uninstall-keyboard) +- [Keyman Configuration - Keyboard Layouts Tab](../basic/config/keyboards) +- [Keyman Configuration](../basic/config/) diff --git a/windows/src/desktop/help/start/font.md b/windows/src/desktop/help/start/font.md index 34beb2a3a6..2d97e26c04 100644 --- a/windows/src/desktop/help/start/font.md +++ b/windows/src/desktop/help/start/font.md @@ -34,6 +34,6 @@ your text to see which fonts look the best for your entire text. - [How To - Fix Font Issues](../troubleshooting/font) - [How To - Download and Install a Keyman Keyboard](download-and-install-keyboard) -- [Keyman Toolbox - Font Helper](../basic/toolbox_tasks/fonthelper) -- [Keyman Configuration - Hotkeys Tab](../basic/config_tasks/hotkeys_tab) -- [Keyboard Task - Turn on a Keyboard](../basic/enable_keyboard) +- [Keyman Toolbox - Font Helper](../basic/toolbox/font-helper) +- [Keyman Configuration - Hotkeys Tab](../basic/config/hotkeys) +- [Keyboard Task - Turn on a Keyboard](../basic/select-keyboard) diff --git a/windows/src/desktop/help/start/hotkey_set.md b/windows/src/desktop/help/start/hotkey_set.md index 2b501b3099..b960c92a5f 100644 --- a/windows/src/desktop/help/start/hotkey_set.md +++ b/windows/src/desktop/help/start/hotkey_set.md @@ -40,4 +40,4 @@ The new hotkey will now be available. ## Related Topics -- [Keyman Configuration - Hotkeys Tab](../basic/config_tasks/hotkeys_tab) +- [Keyman Configuration - Hotkeys Tab](../basic/config/hotkeys) diff --git a/windows/src/desktop/help/start/locale.md b/windows/src/desktop/help/start/locale.md index 133623e745..00469bb567 100644 --- a/windows/src/desktop/help/start/locale.md +++ b/windows/src/desktop/help/start/locale.md @@ -26,5 +26,5 @@ English: ## Related Topics -- [Keyman Configuration](../basic/config_tasks/config_menu) +- [Keyman Configuration](../basic/config/) - [Translating the Keyman for Windows User Interface](../advanced/locale_edit) diff --git a/windows/src/desktop/help/start/rtl.md b/windows/src/desktop/help/start/rtl.md index 9fd998f86c..5a9e037c5c 100644 --- a/windows/src/desktop/help/start/rtl.md +++ b/windows/src/desktop/help/start/rtl.md @@ -44,4 +44,4 @@ get started. - [How To - Download and Install a Keyman Keyboard](download-and-install-keyboard) - [How To - Set up MS Office for a Keyman Keyboard](configure_office) - [How To - Find the Best Fonts for a Keyman Keyboard](font) -- [Keyboard Task - Turn on a Keyboard](../basic/enable_keyboard) +- [Keyboard Task - Turn on a Keyboard](../basic/select-keyboard) diff --git a/windows/src/desktop/help/start/tutorial.md b/windows/src/desktop/help/start/tutorial.md index 4f5a16b3fc..ce033f082d 100644 --- a/windows/src/desktop/help/start/tutorial.md +++ b/windows/src/desktop/help/start/tutorial.md @@ -5,7 +5,7 @@ title: Getting Started with Keyman Follow these steps for a basic introduction to Keyman: **Note:** Keyman must be installed first. For help on installing -Keyman, please see: [How To - Download and Install Keyman](../basic/download-and-install-keyman). +Keyman, please see: [How To - Download and Install Keyman](download-and-install-keyman). ## Step 1 @@ -80,5 +80,5 @@ To return to using your normal keyboard, open the Keyman menu and select your de ## Related Topics -- [How To - Download and Install Keyman](../basic/download-and-install-keyman) +- [How To - Download and Install Keyman](download-and-install-keyman) - [How To - Download and Install a Keyman Keyboard](download-and-install-keyboard) diff --git a/windows/src/desktop/help/troubleshooting/font.md b/windows/src/desktop/help/troubleshooting/font.md index a1a595a900..a69540c867 100644 --- a/windows/src/desktop/help/troubleshooting/font.md +++ b/windows/src/desktop/help/troubleshooting/font.md @@ -24,4 +24,4 @@ appears at a smaller size to the 'ha'. ## Related Topics - [How To - Find the Best Fonts for a Keyman Keyboard](../start/font) -- [Keyman Toolbox - Font Helper](../basic/toolbox_tasks/fonthelper) +- [Keyman Toolbox - Font Helper](../basic/toolbox/font-helper)