diff --git a/windows/src/desktop/help/about/credits.md b/windows/src/desktop/help/about/credits.md index 3d495a355c..2ebf779457 100644 --- a/windows/src/desktop/help/about/credits.md +++ b/windows/src/desktop/help/about/credits.md @@ -5,5 +5,5 @@ title: Credits These help files were written by Marc Durdin, Peirce Baehr and Jeremy Kirkham; updated by Makara Sok and Joshua Horton -In Australia, Keyman is a registered trademark of Summer Institute of -Linguistics Inc. +Keyman is a registered trademark of Summer Institute of Linguistics Inc in +Australia. diff --git a/windows/src/desktop/help/about/history.md b/windows/src/desktop/help/about/history.md index 04ecd6b4a8..2cd7bcd708 100644 --- a/windows/src/desktop/help/about/history.md +++ b/windows/src/desktop/help/about/history.md @@ -6,6 +6,6 @@ A frequently updated changelog for Keyman is kept at on the Keyman Help website. -**Related Topics** +## Related Topics -- [???](#about_whatsnew) +- [What's New](whatsnew) diff --git a/windows/src/desktop/help/about/requirements.md b/windows/src/desktop/help/about/requirements.md index a021c8e5c5..0f64efbedf 100644 --- a/windows/src/desktop/help/about/requirements.md +++ b/windows/src/desktop/help/about/requirements.md @@ -2,32 +2,21 @@ title: System Requirements --- -**Supported Windows Operating Systems** +## Supported Windows Operating Systems Keyman fully supports 32-bit *and* 64-bit versions of the following Windows operating systems: - Windows 7 - - Windows 8 - - Windows 8.1 - - Windows 10 - - Windows Server 2008 and 2008 R2 - - Windows Server 2012 and 2012 R2 -
+**Note:** Keyman works slightly differently in different versions of Windows. Older versions of Windows have more language limitations and need extra configuration. -Keyman works slightly differently in different versions of Windows. -Older versions of Windows have more language limitations and need extra -configuration. - -
- -**Resource Requirements** +## Resource Requirements Keyman has minimal resource requirements. Any computer that can run Windows 7 should be able to run Keyman without trouble. diff --git a/windows/src/desktop/help/about/welcome.md b/windows/src/desktop/help/about/welcome.md index 23db19e31c..5743ce6134 100644 --- a/windows/src/desktop/help/about/welcome.md +++ b/windows/src/desktop/help/about/welcome.md @@ -6,7 +6,7 @@ Thank you for installing Keyman. Whether you're a new or returning user, we believe you will appreciate the significant enhancements in this latest version of Keyman. -**What is Keyman?** +## What is Keyman? Keyman is a keyboard application that makes it easy for you to type in your language in all your favourite Windows programs and across the Web. @@ -27,16 +27,15 @@ in almost any Windows or Web application. Try it in office software like Word or Excel; browsers like Firefox or Internet Explorer; design programs like Adobe InDesign; and email services like Outlook or Gmail. -Keyman fully supports [Unicode](http://www.unicode.org/) and legacy +Keyman fully supports [Unicode](https://www.unicode.org/) and legacy standards and can be used with all standard hardware keyboards, making it the perfect solution for typing in any language on your computer. -A list of features in Keyman is available [here](#about_whatsnew). +A list of features in Keyman is available [here](whatsnew). ![](../desktop_images/osk_keyboard.png) -**Related Topics** +## Related Topics -- [???](#about_whatsnew) - -- [???](#about_requirements) +- [What's New](whatsnew) +- [System Requirements](requirements) diff --git a/windows/src/desktop/help/about/whatsnew.md b/windows/src/desktop/help/about/whatsnew.md index bbda1b7554..e579276f63 100644 --- a/windows/src/desktop/help/about/whatsnew.md +++ b/windows/src/desktop/help/about/whatsnew.md @@ -31,8 +31,7 @@ Here are some of the great things we have added to Keyman 14.0. - Breaking change: Keyman Engine no longer supports the keyboard usage page (usage.htm) -**Related Topics** +## Related Topics -- [???](#about_history) - -- [???](#basic_newways) +- [Version History](history) +- [New Ways to Use Keyman](../basic/newways) diff --git a/windows/src/desktop/help/advanced/locale_edit.md b/windows/src/desktop/help/advanced/locale_edit.md index 6786fd3220..507466d3c5 100644 --- a/windows/src/desktop/help/advanced/locale_edit.md +++ b/windows/src/desktop/help/advanced/locale_edit.md @@ -2,12 +2,12 @@ title: Translating the Keyman for Windows User Interface --- -**Online User Interface Translation Editor** +## Online User Interface Translation Editor Localization of the user interface is possible by using the online interface at [translate.keyman.com](https://translate.keyman.com/). -**Notes on editing translations** +## Notes on editing translations Nearly all strings have identifiers (e.g. SKButtonOK for the OK button). We have three different types of strings in the file - plain, HTML and @@ -39,7 +39,7 @@ The & entity is used to mark hotkeys in menu items, labels and buttons. It can be used only with strings identified as formatted messages (these mostly start with SK) and with the Menu strings. -**Hints on editing a translation** +## Hints on editing a translation First, edit the translation's language information - SKUILanguageName, SKUILanguageNameWithEnglish, and SKLanguageCode. The SKLanguageCode @@ -57,6 +57,6 @@ default file. -**Related Topics** +## Related Topics -- [???](#start_locale) +- [How To - Set the Language for Keyman Menus](../start/locale) diff --git a/windows/src/desktop/help/advanced/proxy_config.md b/windows/src/desktop/help/advanced/proxy_config.md index 5e810550c0..1d3ee0d953 100644 --- a/windows/src/desktop/help/advanced/proxy_config.md +++ b/windows/src/desktop/help/advanced/proxy_config.md @@ -14,10 +14,9 @@ you with the details required. Proxy details are used when checking for updates online and when downloading a keyboard layout. If no proxy details are entered, Keyman -Configuration will use the proxy settings from Internet Explorer. +Configuration will use the proxy settings from Windows. -**Related Topics** +## Related Topics -- [???](#start_download-install_keyboard) - -- [???](#basic_update) +- [How To - Download and Install a Keyman Keyboard](../start/download-install_keyboard) +- [Software Task - Update Keyman](../basic/engine_tasks/update) diff --git a/windows/src/desktop/help/advanced/text_services_framework.md b/windows/src/desktop/help/advanced/text_services_framework.md index 2481ab251f..c075228672 100644 --- a/windows/src/desktop/help/advanced/text_services_framework.md +++ b/windows/src/desktop/help/advanced/text_services_framework.md @@ -2,7 +2,7 @@ title: Text Services Framework --- -**What is the Text Services Framework?** +## What is the Text Services Framework? The Text Services Framework, or TSF, is a set of components for modern applications that support advanced input and text processing. It @@ -31,6 +31,6 @@ but as soon as an arrow key was pressed, or the mouse clicked, Keyman would forget the context. This means that existing text can be edited in a much more intuitive manner when using TSF. -**What applications support TSF?** +## What applications support TSF? TSF is supported by a wide range of software and Windows components. diff --git a/windows/src/desktop/help/basic/help.md b/windows/src/desktop/help/basic/help.md index 79bef6472b..3767ef9282 100644 --- a/windows/src/desktop/help/basic/help.md +++ b/windows/src/desktop/help/basic/help.md @@ -5,18 +5,10 @@ title: The Keyman Help Menu The Keyman Help menu gives you comprehensive help for every aspect of Keyman. -
+**Tip:** All of the help available through the Keyman Help menu is also available online through the Help Documentation section of the [Keyman help site](https://help.keyman.com). -All of the help available through the Keyman Help menu is also available -online through the -Help Documentation - -section of the Keyman help site. - -
- -**Opening Help** +## Opening Help To open Keyman Help: @@ -29,7 +21,7 @@ To open Keyman Help: ![](desktop_images/help-dialog.png) -**Using Help** +## Using Help Keyman Help is divided into seven sections: @@ -53,6 +45,6 @@ Keyman Help is divided into seven sections: 7. Context Help — Links context-sensitive help (accesible throughout Keyman using F1) to the correct help topics. -**Related Topics** +## Related Topics -- [???](#start_tutorial) +- [Getting Started with Keyman](../start/tutorial) diff --git a/windows/src/desktop/help/basic/languageswitcher.md b/windows/src/desktop/help/basic/languageswitcher.md index 6a4a63c7f0..fe5faf23a6 100644 --- a/windows/src/desktop/help/basic/languageswitcher.md +++ b/windows/src/desktop/help/basic/languageswitcher.md @@ -8,7 +8,7 @@ Windows layout. ![](desktop_images/languageswitcher.png) -**Opening and Using the Language Switcher** +## Opening and Using the Language Switcher To open and use the Keyman Language Switcher @@ -16,18 +16,14 @@ To open and use the Keyman Language Switcher 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 - last key in the hotkey to use the Language Switcher. When you + last key in the hotkey (Shift) to use the Language Switcher. When you release Alt, the Language Switcher will close. -
- - By default, the Language Switcher hotkey is Left.Alt + Shift. You + **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. -
- - ![](desktop_images/languageswitcher-small.png) + ![](../desktop_images/languageswitcher-small.png) 2. Navigate the Language Switcher using the arrow keys or by pressing Shift to select your Keyman keyboard. @@ -37,8 +33,7 @@ To open and use the Keyman Language Switcher the Keyman menu icon change to the icon of your Keyman keyboard. This means your Keyman keyboard is on. -**Related Topics** +## Related Topics -- [???](#basic_traymenu) - -- [???](#basic_hotkeys_tab) +- [The Keyman Menu](traymenu) +- [Keyman Configuration - Hotkeys Tab](config_tasks/hotkeys_tab) diff --git a/windows/src/desktop/help/basic/newways.md b/windows/src/desktop/help/basic/newways.md index 8c7903e748..c8d0517e5f 100644 --- a/windows/src/desktop/help/basic/newways.md +++ b/windows/src/desktop/help/basic/newways.md @@ -21,7 +21,7 @@ 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). -[???](#basic_enable_keyboard) +[Keyboard Task - Turn on a Keyboard](enable_keyboard) Most of the following changes were made in Keyman 10.0 @@ -46,7 +46,7 @@ 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** +## Other Minor Changes - In the Support tab, we have reorganised the support and diagnostics links. @@ -63,6 +63,6 @@ versions of your keyboards that adapt to your base layout. - The proxy settings dialog is now accessed through the Options tab. -**Related Topics** +## Related Topics -- [???](#about_whatsnew) +- [What's New](../about/whatsnew) diff --git a/windows/src/desktop/help/basic/text_editor.md b/windows/src/desktop/help/basic/text_editor.md index 98157f3cf0..99faf47b8c 100644 --- a/windows/src/desktop/help/basic/text_editor.md +++ b/windows/src/desktop/help/basic/text_editor.md @@ -7,15 +7,9 @@ keyboards. ![](desktop_images/texteditor.png) -
+**Note**: You do not need to use the Keyman Text Editor to type with Keyman. You can use Keyman in almost any application on your computer that accepts keyboard input. -You do not need to use the Keyman Text Editor to type with Keyman. You -can use Keyman in almost any application on your computer that accepts -keyboard input. - -
- -**Opening the Text Editor** +## Opening the Text Editor To open the Keyman Text Editor: @@ -24,7 +18,7 @@ To open the Keyman Text Editor: 2. From the Keyman menu, select Text Editor…. -**Using the Text Editor** +## Using the Text Editor To use the Keyman Text Editor: @@ -45,8 +39,7 @@ nearly all texts. You can select a font from the font dropdown menu or by clicking on the link for the font in the font panel. -**Related Topics** +## Related Topics -- [???](#start_tutorial) - -- [???](#basic_enable_keyboard) +- [Getting Started with Keyman](../start/tutorial) +- [Keyboard Task - Turn on a Keyboard](enable_keyboard) diff --git a/windows/src/desktop/help/basic/traymenu.md b/windows/src/desktop/help/basic/traymenu.md index e38f519147..03c38419cd 100644 --- a/windows/src/desktop/help/basic/traymenu.md +++ b/windows/src/desktop/help/basic/traymenu.md @@ -2,7 +2,7 @@ title: The Keyman Menu --- -**Opening the Keyman Menu** +## Opening the Keyman Menu When you start Keyman, the Keyman icon (![](desktop_images/icon-keyman.png)) is displayed on the Windows @@ -15,15 +15,11 @@ 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: -If you cannot find the Keyman menu or Keyman icon, for more help see: +[Finding a Missing Keyman Menu](***) -Finding a Missing Keyman Menu - -
- -**Using the Keyman Menu** +## Using the Keyman Menu Click the Keyman icon (![](desktop_images/icon-keyman.png)) with either mouse button to bring up the Keyman menu. @@ -34,27 +30,17 @@ 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. -You can add more Keyman keyboards to the Keyman menu through the +**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 Layouts tab - -of Keyman Configuration. - -
- -
- -To use a Keyman keyboard, the keyboard must be enabled in the Keyboard -Layouts tab of Keyman Configuration. For help enabling your keyboard, -see: - -
+TODO: missing links The right side of the Keyman menu contains links to tools and features in Keyman: +TODO: missing icons and descriptions + - – Opens or closes the On Screen Keyboard tool . @@ -78,7 +64,7 @@ in Keyman: . - – Exits Keyman. -**Finding a Missing Keyman Menu** +## 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 @@ -114,7 +100,7 @@ the icon: ![](desktop_images/win8-taskbar2.png) - 4. From the dropdown menu beside SIL International Keyman Engine + 4. From the dropdown menu beside Keyman Engine x86, select 'Show icon and notifications'. ![](desktop_images/win8-taskbar3.png) @@ -130,8 +116,7 @@ If you still cannot locate the Keyman icon and menu, visit the [SIL Keyman Community](https://community.software.sil.org/c/keyman) for further assistance. -**Related Topics** +## Related Topics -- [???](#basic_toolbox) - -- [???](#basic_enable_keyboard) +- [The Keyman Toolbox](toolbox) +- [Keyboard Task - Turn on a Keyboard](enable_keyboard) diff --git a/windows/src/desktop/help/common/adware.md b/windows/src/desktop/help/common/adware.md index 89b8f6cf82..3044251740 100644 --- a/windows/src/desktop/help/common/adware.md +++ b/windows/src/desktop/help/common/adware.md @@ -10,3 +10,9 @@ updates for both Keyman and the keyboards you have installed. In this process, the only information communicated is the current version of Keyman and the version of the keyboards. You can switch this option off in Keyman Configuration. + +## Get involved with the Keyman Project + +Keyman is a free and open source software project. Continued development of Keyman depends on the generosity of you, our users. There are many ways in which you can get involved; keep reading to find the best way you can be a part of the journey: + +* [Contribute to Keyman](https://keyman.com/about/get-involved) diff --git a/windows/src/desktop/help/common/editions.md b/windows/src/desktop/help/common/editions.md deleted file mode 100644 index f665bf2704..0000000000 --- a/windows/src/desktop/help/common/editions.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: What is new in Keyman 10.0? ---- - -Keyman 10 brings a number of features which are not available in the -Free edition of the previous Keyman. These features are: - -- [Unlimited active keyboards](#basic_enable_keyboard) - -- [Keyman Character Map](#basic_charactermap) - -- [Keyman Language Switcher](#basic_languageswitcher) - -- [Advanced Font Helper - Character Chart](#basic_fonthelper) - -- [Advanced Hotkey Support - Windows Language - Hotkeys](#basic_hotkeys_tab) - -- [Keyman Text Services Framework Addin](#advanced_tsf) - -You can review the full feature list of Keyman 10.0 online: [Keyman -Website](http://www.keyman.com/desktop/). diff --git a/windows/src/desktop/help/common/free.md b/windows/src/desktop/help/common/free.md index e0eb5cb2e2..b6172be3c1 100644 --- a/windows/src/desktop/help/common/free.md +++ b/windows/src/desktop/help/common/free.md @@ -3,4 +3,10 @@ title: Is Keyman now Free? --- Keyman 10.0 and later versions are now available under the open source -MIT license. You can access the source on GitHub. +MIT license. You can access the source on [GitHub](https://github.com/keymanapp/keyman). + +## Get involved with the Keyman Project + +Keyman is a free and open source software project. Continued development of Keyman depends on the generosity of you, our users. There are many ways in which you can get involved; keep reading to find the best way you can be a part of the journey: + +* [Contribute to Keyman](https://keyman.com/about/get-involved) diff --git a/windows/src/desktop/help/common/mac.md b/windows/src/desktop/help/common/mac.md index 942ea1949f..705de5859c 100644 --- a/windows/src/desktop/help/common/mac.md +++ b/windows/src/desktop/help/common/mac.md @@ -10,6 +10,5 @@ keyboards on a Mac: Fusion, Parallels or BootCamp) you can use Keyman through Windows. 2. We offer a web-based typing application, KeymanWeb. It works in all - major browsers (Firefox, Safari, Chrome, etc), on any OS that - supports those browsers. You can use KeymanWeb at - [https://keymanweb.com](). + major browsers (Firefox, Safari, Chrome, Edge, etc), on any OS that + supports those browsers. You can use KeymanWeb at . diff --git a/windows/src/desktop/help/common/old_version.md b/windows/src/desktop/help/common/old_version.md index 3be139e180..9232ea1f33 100644 --- a/windows/src/desktop/help/common/old_version.md +++ b/windows/src/desktop/help/common/old_version.md @@ -3,7 +3,7 @@ title: I am a registered Keyman 7.1 or Keyman Desktop 8 or Keyman Desktop 9 user --- If you are a registered user of Keyman 7.1 or Keyman Desktop 8 or Keyman -Desktop 9, you can download the most recent version these programs from -[keyman.com/downloads/archive/](http://keyman.com/downloads/archive/). +Desktop 9, you can download the most recent version these programs from the +[Keyman Download Archive](http://keyman.com/downloads/archive/). > diff --git a/windows/src/desktop/help/context/fonthelper.md b/windows/src/desktop/help/context/fonthelper.md index cedfabf1c4..f72242f2eb 100644 --- a/windows/src/desktop/help/context/fonthelper.md +++ b/windows/src/desktop/help/context/fonthelper.md @@ -1,3 +1,5 @@ --- title: Keyman Toolbox - Font Helper --- + +TODO: fill in \ No newline at end of file diff --git a/windows/src/desktop/help/context/tsactivate.md b/windows/src/desktop/help/context/tsactivate.md deleted file mode 100644 index fae7b3be8e..0000000000 --- a/windows/src/desktop/help/context/tsactivate.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Using Tavultesoft Online Activation Utility ---- diff --git a/windows/src/desktop/help/index.md b/windows/src/desktop/help/index.md index f1952fe2f9..ef35825e93 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 Keyman](about) -* Getting Started +* [Getting Started][start] -* Basic Help +* [Basic Help](basic) -* Advanced Help +* [Advanced Help](advanced) -* Common Questions +* [Common Questions](common) -* Troubleshooting +* [Troubleshooting](troubleshooting) -* Contextual Help +* [Contextual Help](context) diff --git a/windows/src/desktop/help/start/configure_computer.md b/windows/src/desktop/help/start/configure_computer.md index c08a13ee04..753e4d7942 100644 --- a/windows/src/desktop/help/start/configure_computer.md +++ b/windows/src/desktop/help/start/configure_computer.md @@ -7,7 +7,7 @@ most Keyman keyboards. However, for best performance on some keyboards you may need to manually associate your Keyman keyboard with a Windows language and layout. -**Benefits of Association** +## Benefits of Association Correctly associating your Keyman keyboard has three main benefits. @@ -36,13 +36,9 @@ Correctly associating your Keyman keyboard has three main benefits. - Applications will know which language tools to use when spell checking what you type. -**Association instructions** +## Association instructions -
- -Keyman allows you to associate multiple Windows languages to a keyboard. - -
+**Note**: Keyman allows you to associate multiple Windows languages to a keyboard. 1. Click on the Keyman icon ![](desktop_images/icon-keyman.png), on the Windows Taskbar near the clock. @@ -69,14 +65,10 @@ Keyman allows you to associate multiple Windows languages to a keyboard. 7. To remove an association, hover over the language name, and click the ![](desktop_images/icon-uninstall.png) button that appears. -**Related Topics** +## Related Topics -- [???](#start_download-install_keyboard) - -- [???](#start_configure_office) - -- [???](#start_font) - -- [???](#start_rtl) - -- [???](#basic_enable_keyboard) +- [How To - Download and Install a Keyman Keyboard](download-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) +- [How To - Type in Right-to-Left Languages](rtl) +- [Keyboard Task - Turn on a Keyboard](enable_keyboard) diff --git a/windows/src/desktop/help/start/configure_office.md b/windows/src/desktop/help/start/configure_office.md index c3981d4a28..3ccf1c5fc5 100644 --- a/windows/src/desktop/help/start/configure_office.md +++ b/windows/src/desktop/help/start/configure_office.md @@ -7,7 +7,7 @@ performance with most Keyman keyboards. However, you may need to manually adjust your MS Office language settings for some Keyman keyboards. -**Benefits to Configuring Language Settings for MS Office** +## Benefits to Configuring Language Settings for MS Office The Microsoft Office language settings control spell checking, autocorrection, and other language-specific features for the programs in @@ -17,59 +17,11 @@ any of the MS Office programs with your Keyman keyboard, in order to enjoy these features you will need to configure MS Office language settings. -**Setting up MS Office 2003** +## Setting up MS Office 2017 and MS Office 365 -To set up Microsoft Office 2003 for your Keyman keyboard: +TODO: complete this -1. Open the All Programs menu from the Windows Start menu. - -2. Select Microsoft Office › Microsoft Office Tools › Microsoft Office - 2003 Language Settings. - -3. Select your language from the Available languages list. - -4. Click Add. - -5. Click OK to confirm. - -6. Restart your Office applications. - -**Setting up MS Office 2007** - -To set up Microsoft Office 2007 for your Keyman keyboard: - -1. Open the All Programs menu from the Windows Start menu. - -2. Select Microsoft Office › Microsoft Office Tools › Microsoft Office - 2007 Language Settings. - -3. Select your language from the Available editing languages list. - -4. Click Add. - -5. Click OK to confirm. - -6. Restart your Office applications. - -**Setting up MS Office 2010** - -To set up Microsoft Office 2010 for your Keyman keyboard: - -1. Open the All Programs menu from the Windows Start menu. - -2. Select Microsoft Office › Microsoft Office 2010 Tools › Microsoft - Office 2010 Language Preferences. - -3. Find your language in the dropdown menu '\[Add additional editing - languages\]'. - -4. Click Add. - -5. Click OK to confirm. - -6. Restart your Office applications. - -**Setting up MS Office 2013** +## Setting up MS Office 2013 To set up Microsoft Office 2013 for your Keyman keyboard: @@ -87,14 +39,62 @@ To set up Microsoft Office 2013 for your Keyman keyboard: 6. Restart your Office applications. -**Related Topics** +## Setting up MS Office 2010 -- [???](#start_download-install_keyboard) +To set up Microsoft Office 2010 for your Keyman keyboard: -- [???](#start_configure_computer) +1. Open the All Programs menu from the Windows Start menu. -- [???](#start_font) +2. Select Microsoft Office › Microsoft Office 2010 Tools › Microsoft + Office 2010 Language Preferences. -- [???](#start_rtl) +3. Find your language in the dropdown menu '\[Add additional editing + languages\]'. -- [???](#basic_enable_keyboard) +4. Click Add. + +5. Click OK to confirm. + +6. Restart your Office applications. + +## Setting up MS Office 2007 + +To set up Microsoft Office 2007 for your Keyman keyboard: + +1. Open the All Programs menu from the Windows Start menu. + +2. Select Microsoft Office › Microsoft Office Tools › Microsoft Office + 2007 Language Settings. + +3. Select your language from the Available editing languages list. + +4. Click Add. + +5. Click OK to confirm. + +6. Restart your Office applications. + +## Setting up MS Office 2003 + +To set up Microsoft Office 2003 for your Keyman keyboard: + +1. Open the All Programs menu from the Windows Start menu. + +2. Select Microsoft Office › Microsoft Office Tools › Microsoft Office + 2003 Language Settings. + +3. Select your language from the Available languages list. + +4. Click Add. + +5. Click OK to confirm. + +6. Restart your Office applications. + +## Related Topics + +- [How To - Download and Install a Keyman Keyboard](download-install_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) diff --git a/windows/src/desktop/help/start/download-install_keyboard.md b/windows/src/desktop/help/start/download-install_keyboard.md index b0788cd680..6eaa6cc2c7 100644 --- a/windows/src/desktop/help/start/download-install_keyboard.md +++ b/windows/src/desktop/help/start/download-install_keyboard.md @@ -5,13 +5,12 @@ title: How To - Download and Install a Keyman Keyboard You must have a Keyman keyboard installed to type with Keyman in your language. You can download and install a Keyman keyboard at the same time you download and install Keyman. For more information, see: -[???](#start_download-install_keyman). +[How To - Download and Install Keyman](download-install_keyman). You can also add keyboards to Keyman after you have installed Keyman. For more information, keep reading. -**Downloading & Installing a Keyman -Keyboard within Keyman** +## Downloading & Installing a Keyman Keyboard within Keyman Here's how to download and install a Keyman keyboard within Keyman: @@ -31,41 +30,23 @@ Here's how to download and install a Keyman keyboard within Keyman: 6. Click Install Keyboard for the keyboard you want to install. -
- - The icons to the right of each keyboard name show valuable + **Tip:** The icons to the right of each keyboard name show valuable information about what the keyboard includes: +TODO: missing images + - – means that the keyboard is a Unicode keyboard. - – means the keyboard has a virtual On Screen Keyboard. - – means the keyboard contains help documentation. - – means the keyboard comes with fonts. - – means the keyboard has introductory help. -
- -
- - You may also download the keyboard without installing it. Tick + **Note:** You may also download the keyboard without installing it. Tick 'Don't install, just download' in the Download Keyboard window. -
- -
- - If the keyboard you want doesn't have an Install Keyboard button, - then the keyboard has been made available from a third-party site. - You can download the keyboard by following the links provided. If - the keyboard doesn't install automatically, follow the instructions - below to [install a keyboard from your computer](#install_folder). - -
- 7. Click Install at the Install Keyboard or Package dialog. -
- - The Install Keyboard/Package dialog includes some helpful + **Tip:** The Install Keyboard/Package dialog includes some helpful information about the keyboard you are installing. In addition to the name, encoding standard, and version of the keyboard, the dialog may also show: @@ -77,31 +58,20 @@ Here's how to download and install a Keyman keyboard within Keyman: - Other details. -
- -
- - Install installs the keyboard for anyone who can log on to your + **Note:** Install installs the keyboard for anyone who can log on to your computer. You may be prompted by User Account Control to allow Keyman to make changes to your computer -- click 'Yes'. -
- -
- - If a keyboard with the same name is already installed, Keyman will + **Note:** If a keyboard with the same name is already installed, Keyman will ask you if you want to replace the old keyboard or cancel the installation. -
- -8. Click OK if asked to configure you computer to work with your new +8. Click OK if asked to configure your computer to work with your new keyboard. 9. Click OK to save your settings and exit Keyman Configuration. -**Installing a Keyman Keyboard from a -Folder on Your Computer** +## Installing a Keyman Keyboard from a Folder on Your Computer There are two ways you can install a Keyman keyboard from a folder on your computer. The easiest way is to find the keyboard on your computer @@ -130,9 +100,7 @@ how: prompted by User Account Control to allow Keyman to make changes to your computer -- click 'Yes'. -
- - The Install Keyboard/Package dialog includes some helpful + **Tip:** The Install Keyboard/Package dialog includes some helpful information about the keyboard you are installing. In addition to the name, encoding standard, and version of the keyboard, the dialog may also show: @@ -144,38 +112,26 @@ how: - Other details. -
+ **Note:** Install installs the keyboard for anyone who can log on to your computer. -
- - Install installs the keyboard for anyone who can log on to your - computer. - -
- -
- - If a keyboard with the same name is already installed, Keyman will + **Note:** If a keyboard with the same name is already installed, Keyman will ask you if you want to replace the old keyboard or cancel the installation. -
- -8. Click OK if asked to configure you computer to work with your new +8. Click OK if asked to configure your computer to work with your new keyboard. 9. Click OK to save your settings and exit Keyman Configuration. -**Related Topics** +## Related Topics -- [???](#start_download-install_keyman) +- [How To - Download and Install Keyman](download-install_keyman) +- [Keyboard Task - Turn on a Keyboard](../basic/enable_keyboard) -- [???](#basic_enable_keyboard) +- [Keyboard Task - Enable and Disable a Keyboard](../basic/disable_keyboard) -- [???](#basic_disable_keyboard) +- [Keyboard Task - Uninstall a Keyboard](../basic/uninstall_keyboard) -- [???](#basic_uninstall_keyboard) +- [Keyman Configuration - Keyboard Layouts Tab](../basic/config_tasks/keyboards_tab) -- [???](#basic_keyboards_tab) - -- [???](#basic_config_menu) +- [Keyman Configuration](../basic/config_tasks/config_menu) diff --git a/windows/src/desktop/help/start/download-install_keyman.md b/windows/src/desktop/help/start/download-install_keyman.md index b14a9a982e..bc622e2a69 100644 --- a/windows/src/desktop/help/start/download-install_keyman.md +++ b/windows/src/desktop/help/start/download-install_keyman.md @@ -2,12 +2,14 @@ title: How To - Download and Install Keyman --- -**Downloading Keyman** +## Downloading Keyman You can download Keyman with a keyboard for your language from the -[Keyman Website](https://keyman.com/desktop/). +[Keyman Website](https://keyman.com/keyboards/). -**Installing Keyman** +## Installing Keyman + +TODO: rewrite for 14.0 UX After you download Keyman, to install the program: @@ -21,18 +23,14 @@ After you download Keyman, to install the program: ![](desktop_images/setup-click1.png) -4. Once you have read and agree to the license terms, click Install +4. Once you have read and agreed to the license terms, click Install Keyman to continue. ![](desktop_images/setup-click2.png) -
- - You can select advanced installation options from the Install + **Note:** You can select advanced installation options from the Install Options link on the bottom left. -
- 5. At the end of the installation, click Start Keyman to begin using Keyman or click Take the tour for the Getting Started tutorial. @@ -42,8 +40,7 @@ When you finish your installation of Keyman, you can delete or move the installation's executable file. It doesn't need to remain on your computer for Keyman to work. -**Related Topics** +## Related Topics -- [???](#start_download-install_keyboard) - -- [???](#basic_uninstall) +- [How To - Download and Install a Keyman Keyboard](download-install_keyboard) +- [Software Task - Uninstall Keyman](../basic/uninstall) diff --git a/windows/src/desktop/help/start/font.md b/windows/src/desktop/help/start/font.md index 5257cab4f6..ad2a33f225 100644 --- a/windows/src/desktop/help/start/font.md +++ b/windows/src/desktop/help/start/font.md @@ -23,25 +23,17 @@ which letters and symbols from your keyboard are supported by each font. ![](desktop_images/fonthelper.png) -
- -The Font Helper tool is designed to tell you which fonts support the +**Note:** The Font Helper tool is designed to tell you which fonts support the letters and characters in your language. It is not intended to show you which fonts will look the nicest for your language or text. You can use the Font Helper tool to see how different fonts display the individuals letters and characters in your language. You should test the fonts in your text to see which fonts look the best for your entire text. -
+## Related Topics -**Related Topics** - -- [???](#troubleshooting_font) - -- [???](#start_download-install_keyboard) - -- [???](#basic_fonthelper) - -- [???](#basic_hotkeys_tab) - -- [???](#basic_enable_keyboard) +- [How To - Fix Font Issues](../troubleshooting/font) +- [How To - Download and Install a Keyman Keyboard](download-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) diff --git a/windows/src/desktop/help/start/hotkey_set.md b/windows/src/desktop/help/start/hotkey_set.md index 602a33e537..8b4a903dbb 100644 --- a/windows/src/desktop/help/start/hotkey_set.md +++ b/windows/src/desktop/help/start/hotkey_set.md @@ -23,27 +23,15 @@ language: 4. Select a default hotkey or click Custom and type the hotkey you wish to use. -
- - If you press a single letter or Shift plus a single letter, the + **Note:** If you press a single letter or Shift plus a single letter, the hotkey will default to Ctrl + Alt plus the letter you pressed, in order to avoid conflicts with standard keyboard input. -
- -
- - To clear a hotkey that has been set previously, click Clear Hotkey + **Note:** To clear a hotkey that has been set previously, click Clear Hotkey or press Backspace. -
+ **Note:** Be aware that you can set the hotkey to replace common Windows hotkeys (Ctrl + C, Ctrl + V, etc). -
- - Be aware that you can set the hotkey to replace common Windows - hotkeys (Ctrl + C, Ctrl + V, etc). - -
5. Click OK to save your selection. @@ -51,6 +39,6 @@ language: The new hotkey will now be available. -**Related Topics** +## Related Topics -- [???](#basic_hotkeys_tab) +- [Keyman Configuration - Hotkeys Tab](../basic/config_tasks/hotkeys_tab) diff --git a/windows/src/desktop/help/start/locale.md b/windows/src/desktop/help/start/locale.md index 3212217f0b..38a61f5215 100644 --- a/windows/src/desktop/help/start/locale.md +++ b/windows/src/desktop/help/start/locale.md @@ -2,7 +2,7 @@ title: How To - Set the Language for Keyman Menus --- -**Setting a Language for Keyman Menus** +## Setting a Language for Keyman Menus If you would like the menus in Keyman to be in a language other than English: @@ -17,20 +17,14 @@ English: 3. Select your language from the list. If your language is not in the list, click Find other display languages online…. -
- - If your language is not available online, you can write your own + **Note:** If your language is not available online, you can write your own translation for your language using our locale editor. For more - information, see - . - -
+ information, see [Translating the Keyman for Windows User Interface](../advanced/locale_edit). 4. Restart Keyman for the language changes to take effect for the entire program. -**Related Topics** +## Related Topics -- [???](#basic_config_menu) - -- [???](#advanced_locale_edit) +- [Keyman Configuration](../basic/config_tasks/config_menu) +- [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 1d29b31af8..a56da5a8cd 100644 --- a/windows/src/desktop/help/start/rtl.md +++ b/windows/src/desktop/help/start/rtl.md @@ -38,14 +38,10 @@ get started. - To toggle between right-to-left and left-to-right, press: Ctrl + Shift + X -**Related Topics** +## Related Topics -- [???](#start_configure_computer) - -- [???](#start_download-install_keyboard) - -- [???](#start_configure_office) - -- [???](#start_font) - -- [???](#basic_enable_keyboard) +- [How To - Set up Your Computer for a Keyman Keyboard](configure_computer) +- [How To - Download and Install a Keyman Keyboard](download-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) diff --git a/windows/src/desktop/help/start/tutorial.md b/windows/src/desktop/help/start/tutorial.md index 8cfb72f723..569afa4632 100644 --- a/windows/src/desktop/help/start/tutorial.md +++ b/windows/src/desktop/help/start/tutorial.md @@ -4,27 +4,16 @@ 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-install_keyman). -Keyman - -must be installed first. For help on installing - -Keyman - -, please see: - -. - -
- -**Step 1** +## Step 1 Check the Windows Taskbar near the clock to see if Keyman is running. If it is running you will see the Keyman icon: ![](desktop_images/icon-keyman.png) -**Step 2** +## Step 2 If the Keyman icon is in the Windows Taskbar near the clock, continue on to [Step 5](#tutorial_step5). @@ -48,7 +37,7 @@ the arrow or triangle next to the clock: 2. In the search field, type and enter: Notification Area Icons - 3. From the dropdown menu beside SIL International Keyman + 3. From the dropdown menu beside Keyman Engine x86, select 'Show icon and notifications'. ![](desktop_images/7-taskbar.png) @@ -105,60 +94,51 @@ the arrow or triangle next to the clock: 6. Continue on to [Step 5](#tutorial_step5) of this guide. -**Step 3** +## Step 3 To Start Keyman, click on the Windows Start Menu, select All Programs, and select Keyman. -**Step 4** +## Step 4 Keyman will now be running and the Keyman icon will be on the Windows Taskbar near the clock. -**Step 5** +## Step 5 Open a typing application, like Microsoft Word. -**Step 6** +## Step 6 Select a Keyman keyboard from the Keyman menu. You will notice the Keyman menu icon change to the icon of your Keyman keyboard. This means your Keyman keyboard is on. -
+**Tip:** If there are no Keyman keyboards in the Keyman menu, you can learn how to install one here: -If there are no Keyman keyboards in the Keyman menu, you can learn how -to install one here: +- [How To - Download and Install a Keyman Keyboard](download-install_keyboard) -
- -**Step 7** +## Step 7 To learn how to type with your new Keyman keyboard, open the On Screen Keyboard tool of the Keyman Toolbox. You can open the On Screen Keyboard tool from the On Screen Keyboard link in the Keyman menu. -
- -Some Keyman keyboards do not include an On Screen Keyboard. You can +**Tip:** Some Keyman keyboards do not include an On Screen Keyboard. You can usually find help for these keyboards from the Keyboard Usage tool of the Keyman Toolbox. You can open the Keyboard Usage tool from the Keyboard Usage link in the Keyman menu. -
- -**Step 8** +## Step 8 You can now start typing in your language in almost any application. Use your hardware keyboard or click the On Screen Keyboard keys to type. -**Step 9** +## Step 9 -To return to using your normal keyboard, open the Keyman menu and click -'Switch Keyman Off'. +To return to using your normal keyboard, open the Keyman menu and select your default language from the list presented to you. -**Related Topics** +## Related Topics -- [???](#start_download-install_keyman) - -- [???](#start_download-install_keyboard) +- [How To - Download and Install Keyman](../basic/download-install_keyman) +- [How To - Download and Install a Keyman Keyboard](download-install_keyboard) diff --git a/windows/src/desktop/help/troubleshooting/bootstrapper.md b/windows/src/desktop/help/troubleshooting/bootstrapper.md index ee8150df00..3a0f95d3c5 100644 --- a/windows/src/desktop/help/troubleshooting/bootstrapper.md +++ b/windows/src/desktop/help/troubleshooting/bootstrapper.md @@ -2,7 +2,9 @@ title: How To - Use the Keyman Setup Bootstrapper --- -**About the Bootstrapper** +## About the Bootstrapper + +TODO: rewrite for 14.0 content The Keyman installation bootstrapper is a self-extracting executable file that contains a Windows Installer technology MSI file, and @@ -23,7 +25,7 @@ The bootstrapper: 5. Starts Keyman after the install completes. -**Command Line Options** +## Command Line Options The following command line parameters are supported in the bootstrapper: @@ -39,6 +41,6 @@ The following command line parameters are supported in the bootstrapper: self-extracting executable to the path extractpath and exit the bootstrapper. -**Related Topics** +## Related Topics -- [???](#start_download-install_keyman) +- [How To - Download and Install Keyman](../start/download-install_keyman) diff --git a/windows/src/desktop/help/troubleshooting/excel.md b/windows/src/desktop/help/troubleshooting/excel.md index 4addd3573a..1c690a924d 100644 --- a/windows/src/desktop/help/troubleshooting/excel.md +++ b/windows/src/desktop/help/troubleshooting/excel.md @@ -2,19 +2,19 @@ title: How To - Use Keyman in Excel --- -**Using Keyman in Excel with the / Key** +## Using Keyman in Excel with the / Key Keyboard layouts which rely on the '/' key cause difficulty in Microsoft Excel. In order to provide legacy compatibility with Lotus 1-2-3, by default using the '/' key in Excel activates keyboard shortcuts. There are two solutions to this problem. -**Solution 1** +### Solution 1 Press F2 -- Whenever you type text in Excel using a layout which relies on '/', press the F2 key to enter the cell before typing. -**Solution 2** +### Solution 2 Disable '/' shortcuts -- In the Microsoft Office Excel menu, disable the use of '/' as a shortcut key. @@ -31,7 +31,7 @@ In Excel 2007: 5. Click OK. -**Keeping Context in Excel** +## Keeping Context in Excel The first key typed into any cell in Excel causes Excel to switch input into a new window. The switch of windows between the first and second diff --git a/windows/src/desktop/help/troubleshooting/font.md b/windows/src/desktop/help/troubleshooting/font.md index 08a934a44c..a1a595a900 100644 --- a/windows/src/desktop/help/troubleshooting/font.md +++ b/windows/src/desktop/help/troubleshooting/font.md @@ -4,7 +4,7 @@ title: How To - Fix Font Issues If you are having font issues, you should first try: [???](#start_font) -**Fix Characters Appearing Smaller than the Selected Font Size** +## Fix Characters Appearing Smaller than the Selected Font Size If you are typing with a font that does not include all character glyphs, some characters may appear at a smaller size than the selected @@ -21,8 +21,7 @@ EXAMPLE: In Notepad, using the SIL IPA Unicode keyboard, type 'hat\_'. With the standard Notepad font selected (Lucida Console) the 't\_' appears at a smaller size to the 'ha'. -**Related Topics** +## Related Topics -- [???](#start_font) - -- [???](#basic_fonthelper) +- [How To - Find the Best Fonts for a Keyman Keyboard](../start/font) +- [Keyman Toolbox - Font Helper](../basic/toolbox_tasks/fonthelper) diff --git a/windows/src/desktop/help/troubleshooting/hidden.md b/windows/src/desktop/help/troubleshooting/hidden.md deleted file mode 100644 index ffeea40d16..0000000000 --- a/windows/src/desktop/help/troubleshooting/hidden.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: How To - Fix A Problem with an Active Keyman Keyboard Not Typing ---- - -**Symptoms** - -You may experience an issue in Windows 7 where: - -- Keyman is on; and -- your Keyman keyboard is active, with its icon showing in the Keyman - menu; but -- your Keyman keyboard does not work. - -**Resolution** - -Unhide the Keyman menu as described in [Step 2](#tutorial_step2) of the -Getting Started tutorial. - -This can also be resolved by switching language using the Windows -Language Bar or the Language Icon - -**Background** - -When the Keyman icon is in the hidden notification area of the Windows -taskbar, opening the notification area and selecting the icon causes it -to change the keyboard for the taskbar, not for your active application. -Clicking back to the active application results in the keyboard turning -off again. - -**Related Topics** - -- [???](#basic_enable_keyboard) diff --git a/windows/src/desktop/help/troubleshooting/sigma.md b/windows/src/desktop/help/troubleshooting/sigma.md index 3c6320dfdc..f8724af299 100644 --- a/windows/src/desktop/help/troubleshooting/sigma.md +++ b/windows/src/desktop/help/troubleshooting/sigma.md @@ -2,26 +2,32 @@ title: How To - Fix Greek Medial Sigma Changing to Final Sigma Unexpectedly in MS Word --- -**Symptoms** +## Symptoms When typing Greek in Microsoft Word using any Polytonic Greek-script keyboard, entering a diacritic or breathing mark on a vowel after a Sigma immediately causes the Sigma to incorrectly change to a final Sigma. For instance, if you typed ησὴ you would get ηςὴ. -**Resolution** +## Resolution This is due to a bug with the Microsoft Word "AutoFormat As You Type" Ordinals setting. -In Microsoft Word 2003: +TODO: check with Office 2017? -1. In Word, click Tools menu, AutoCorrect Options…, and select the - AutoFormat As You Type tab. +In Microsoft Word 2010: -2. Find the entry titled Ordinals (1st) with superscript and untick it. +1. In Word, click File, and select Options. -3. Click OK to save changes. +2. Click Proofing and AutoCorrect Options. + +3. Select the AutoFormat As You Type tab. + +4. Find the check box titled Ordinals (1st) with superscript and untick + it. + +5. Click OK to save changes. In Microsoft Word 2007: @@ -37,19 +43,15 @@ In Microsoft Word 2007: 5. Click OK to save changes. -In Microsoft Word 2010: +In Microsoft Word 2003: -1. In Word, click File, and select Options. +1. In Word, click Tools menu, AutoCorrect Options…, and select the + AutoFormat As You Type tab. -2. Click Proofing and AutoCorrect Options. +2. Find the entry titled Ordinals (1st) with superscript and untick it. -3. Select the AutoFormat As You Type tab. +3. Click OK to save changes. -4. Find the check box titled Ordinals (1st) with superscript and untick - it. +## Related Topics -5. Click OK to save changes. - -**Related Topics** - -- [???](#start_configure_office) +- [How To - Set up MS Office for a Keyman Keyboard](../start/configure_office)