Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions products/mac/20.0/about/history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Version History of Keyman for macOS
---

A frequent updated changelog for Keyman is kept at [help.keyman.com/version-history](https://help.keyman.com/version-history/) on the Keyman Help website.

## Related Topics
* [What's New](whatsnew)
8 changes: 8 additions & 0 deletions products/mac/20.0/about/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: About Keyman for macOS
---

* [Welcome to Keyman](welcome)
* [What's New](whatsnew)
* [System Requirements](requirements)
* [Version History](history)
23 changes: 23 additions & 0 deletions products/mac/20.0/about/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: System Requirements - Keyman for macOS Help
---

## Supported Mac Operating Systems

Keyman supports the following Mac operating systems:

* macOS High Sierra (10.13)
* macOS Mojave (10.14)
* macOS Catalina (10.15)
* macOS Big Sur (11.0)
* macOS Monterey (12.0)
* macOS Ventura (13.0)
* macOS Sonoma (14.0)
* macOS Sequoia (15.0)

Keyman should also work on future releases of macOS, even if they are not yet listed here.

## Resource Requirements

Keyman for macOS has minimal resource requirements. Any computer running
Mac OS X 10.13 or later should be able to run Keyman for macOS without trouble.
26 changes: 26 additions & 0 deletions products/mac/20.0/about/welcome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Welcome to Keyman for macOS
---

Thank you for installing Keyman for macOS. Whether you're a new or returning user,
we believe you will appreciate the significant enhancements in this latest
version of Keyman for macOS.

## What is Keyman for for macOS?

Keyman for macOS brings an extensive library of keyboards for over 1,000
languages to macOS. You can even create your own custom keyboards with
[Keyman Developer](https://keyman.com/developer) (a Windows product).

Our unique virtual keyboard technology makes it easy to type in all your programs,
including Microsoft Office, Adobe Creative Suite, internet browsers and more, as well as
supporting the latest version of macOS.

A list of new features in Keyman is available [here](whatsnew).

![](../mac_images/osk_amharic.png)

## Related Topics

- [What's New](whatsnew)
- [System Requirements](requirements)
5 changes: 5 additions & 0 deletions products/mac/20.0/about/whatsnew.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: What's New in Keyman 20.0 for macOS
---

Here are some of the new features we have added to Keyman 20.0 for macOS:
30 changes: 30 additions & 0 deletions products/mac/20.0/basic/config/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Keyman Configuration
---

The Configuration window allows you to change several things about the way
Keyman works, as well as access information about installed keyboards.

## Opening Keyman Configuration
To open Keyman Configuration:

1. ![mac OS menu bar](../../mac_images/menu-bar-with-keyman.png)

Make sure that Keyman for macOS is the active input source (as shown above).
For more information, see [Getting Started with Keyman for macOS](../../start/tutorial).
2. Click the Keyman icon to display the Input menu.
3. On the Input menu, in the section for Keyman, click **Configuration**. Note: If you just
installed Keyman and the Configuration menu is not available, please restart the computer.

![Keyman Configuration in menu](../../mac_images/keyman-configuration-menu.png)

4. The Keyman Configuration window appears:
![Keyman Configuration](../../mac_images/keyman-configuration-window.png)

## Using Keyman Configuration

Following are instructions for performing various tasks in the Configuration window:

- [Keyman Configuration - Keyboard Layouts Tab](keyboards)
- [Keyman Configuration - Support Tab](support)

54 changes: 54 additions & 0 deletions products/mac/20.0/basic/config/keyboards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Keyman Configuration - Keyboard Layouts Tab
---

## Enable and Disable a Keyboard

Keyman keyboards can be enabled and disabled. Disabling a Keyman keyboard removes
it from the Keyman menu and Keyman Toolbox but does not uninstall the keyboard.
This is useful if:

* You are using a single keyboard layout from a package with multiple
keyboards and you want to remove the extra keyboards from the Keyman
Toolbox and menu.

* You have a keyboard layout installed which you aren't currently using but don't
want to uninstall.

To disable a Keyman keyboard, untick the corresponding checkbox. To enable a
disabled keyboard, tick the checkbox.

## Remove Keyboards

Removing a Keyman keyboard package uninstalls and deletes the entire
package. Although you can disable individual keyboards (as described above),
if an installed package contains more than one keyboard, you cannot remove
them individually.

To remove a keyboard package, click the delete button
![-](../../mac_images/remove_button.png) in the far right of the row with the
package name.

## Display Keyboard Information

All Keyman keyboard packages contain some basic metadata information,
such as the name and version, included fonts, author, and copyright. To
display this information, click the information button
![(i)](../../mac_images/information_button.png) to the right of the package name.

## Display Keyboard Help

Many Keyman keyboard packages contain help files, with instructions for
learning to use the keyboard(s) to type special characters. This is
especially helpful for keyboards that use multiple key sequences to
generate characters, since it is not usually possible to convey this
information via an on-screen keyboard showing the individual characters
associated with the keys on the physical keyboard. To open a window that
will allow you to view the keyboard help, click the help button
![?](../../mac_images/help_button.png) to the right of the package name. (If
this button is disabled, it means that no help files were included in the
package.)

## Related Topics

- [Keyman Configuration](../config/)
28 changes: 28 additions & 0 deletions products/mac/20.0/basic/config/options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: Keyman Configuration - Options Tab
---

## Keyman Configuration Options

If you select the **Options** tab on the Keyman Configuration window, you
will see that there are two configuration options that affect the general
behavior of Keyman, regardless of which keyboard is active:

* **Always show on-screen keyboard**: If this option is ticked, the
on-screen keyboard will be displayed automatically whenever Keyman
becomes the active input source.

* **Use verbose Console logging**: If this option is ticked, advanced
troubleshooting information will be sent to the system log. If the
Keyman development team is assisting you to resolve a problem, they
might instruct you to enable this option so you can supply them with a
log of important debugging messages from Keyman. You can view this log
information yourself using the Console utility, by filtering to show
only messages from the Keyman process (although it probably won't be
very meaningful to you unless you are a computer programmer and you are
looking at the Keyman for macOS source code). Console is a log viewer
developed by Apple Inc. and included with macOS.

## Related Topics

- [Keyman Configuration](../config/)
12 changes: 12 additions & 0 deletions products/mac/20.0/basic/config/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Keyman Configuration - Support Tab
---


The **Support** tab on the Keyman Configuration window displays the same
program help information available on-line at
[help.keyman.com/products/mac](https://help.keyman.com/products/mac/)

## Related Topics

- [Keyman Configuration](../config/)
5 changes: 5 additions & 0 deletions products/mac/20.0/basic/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Keyman for macOS Basic Help
---

* [Keyman Configuration](config/)
14 changes: 14 additions & 0 deletions products/mac/20.0/common/adware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Does Keyman for macOS include adware or spyware?
---

Simple answer: No!

We never have and never will include adware or spyware components.

We take your privacy seriously. Keyman does include an error reporting
component, so if you find Keyman crashing, it will report the error to
our server. The error report will contain details about your system
configuration, such as operating system version and free disk space,
but contains no personal data. This information helps us to address
the problem.
7 changes: 7 additions & 0 deletions products/mac/20.0/common/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: I think I found a bug! How can I tell you about it?
---

We want to hear about problems you experience: if we don't
hear about the problem, we can't fix it! So please do send bug reports
through to the [SIL Keyman Community](https://community.software.sil.org/c/keyman)
10 changes: 10 additions & 0 deletions products/mac/20.0/common/free.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Is Keyman for macOS really free?
---

Yes! As with all Keyman products, Keyman for macOS is completely free.

The source code for Keyman is freely available as well: you can download
the code, change it, distribute your own version of Keyman, or contribute
your improvments back to the Keyman project so we can all benefit.
[Learn more](https://keyman.com/about/get-involved)
12 changes: 12 additions & 0 deletions products/mac/20.0/common/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Common Questions about Keyman for macOS
---

* [Which versions does Keyman for macOS work with?](os)
* [What are Keyman's hardware requirements?](requirements)
* [Which keyboards work on Mac?](keyboards)
* [Does Keyman for macOS include adware or spyware?](adware)
* [Does Keyman for macOS include a virtual on-screen keyboard?](osk)
* [Is Keyman for macOS really free?](free)
* [Will you help me install Keyman?](support)
* [I think I found a bug! How can I tell you about it?](bug)
11 changes: 11 additions & 0 deletions products/mac/20.0/common/keyboards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Which keyboards work on Mac?
---

Most Keyman keyboards work on Mac. A small subset of keyboards require features which
are not yet available in version 16.0. These features will be progressively implemented.
Keyman for macOS will inform you when you attempt to install a keyboard if it is using
a currently unsupported feature.

The [Keyman keyboard catalogue](https://keyman.com/keyboards) also includes information
about macOS compatibility for each keyboard.
16 changes: 16 additions & 0 deletions products/mac/20.0/common/os.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Which versions does Keyman for macOS work with?
---

## Supported Mac Operating Systems

Keyman supports the following Mac operating systems:

* macOS High Sierra (10.13)
* macOS Mojave (10.14)
* macOS Catalina (10.15)
* macOS Big Sur (11.0)
* macOS Monterey (12.0)
* macOS Ventura (13.0)
* macOS Sonoma (14.0)
* macOS Sequoia (15.0)
9 changes: 9 additions & 0 deletions products/mac/20.0/common/osk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Does Keyman for macOS include a virtual on-screen keyboard?
---

Yes, Keyman includes an on-screen keyboard. Most Keyman keyboards include
the information needed to display the on screen keyboard.

To display the on-screen keyboard for the currently selected Keyman keyboard,
in the Input menu, point to Keyman, and then click On-Screen Keyboard.
6 changes: 6 additions & 0 deletions products/mac/20.0/common/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: What are Keyman's hardware requirements?
---

Keyman for macOS has minimal resource requirements. Any computer running
Mac OS X 10.13 or later should be able to run Keyman for macOS without trouble.
8 changes: 8 additions & 0 deletions products/mac/20.0/common/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Will you help me install Keyman?
---

SIL is pleased to provide Keyman software for free. However, we do not have the resources to
provide free technical support. We do our best to monitor the
[Keyman community forum](https://community.software.sil.org/c/keyman) for technical issues that
warrant support, so if you post a question there, someone may be able to assist you.
49 changes: 49 additions & 0 deletions products/mac/20.0/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: Keyman 20.0 for macOS Help
---

Need help using Keyman for macOS? You'll find everything you need here, including product documentation,
frequently asked questions, tutorials and videos.

## [About Keyman](about/)
* [Welcome to Keyman](about/welcome)
* [What's New](about/whatsnew)
* [System Requirements](about/requirements)
* [Version History](about/history)

## [Getting Started](start/tutorial)
* [Step-by-step Guide](start/tutorial)
* [Tutorial: Installing Keyman](start/install-keyman)
* [Tutorial: Installing a keyboard](start/install-keyboard)

## [Common Questions](common/)
* [Which versions does Keyman for macOS work with?](common/os)
* [What are Keyman's hardware requirements?](common/requirements)
* [Which keyboards work on Mac?](common/keyboards)
* [Does Keyman for macOS include adware or spyware?](common/adware)
* [Does Keyman for macOS include a virtual on-screen keyboard?](common/osk)
* [Is Keyman for macOS really free?](common/free)
* [Will you help me install Keyman?](common/support)
* [I think I found a bug! How can I tell you about it?](common/bug)

## Ask for Help
[Ask other users in the SIL Keyman Community](https://community.software.sil.org/c/keyman)

## Help Topics

### [Troubleshooting](troubleshooting/)
* [Configure macOS security for Keyman](troubleshooting/configure-security)
* [Uninstalling Keyman](troubleshooting/uninstall-keyman)

### Using Keyman for macOS
* [Configuration Tasks](basic/config/)

### Advanced Topics
* [Keyman for macOS version history](https://help.keyman.com/products/mac/version-history)

## Other Resources
* [Knowledge Base](https://help.keyman.com/kb)
* [Keyman Developer Help](https://help.keyman.com/developer)
* [KeymanWeb Help](https://help.keyman.com/products/web)
* [Keyman for Windows Help](https://help.keyman.com/products/windows)
* [Keyman for Linux Help](https://help.keyman.com/products/linux)
Binary file added products/mac/20.0/mac_images/add.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/go_to_folder.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/help_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/icon-fonts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/icon-help.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/icon-intro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/icon-keyman.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/icon-osk.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/icon-unicode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/information_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/keyboards_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/keyman_install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/open-apple-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/osk_amharic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added products/mac/20.0/mac_images/remove.png
Binary file added products/mac/20.0/mac_images/remove_button.png
Binary file added products/mac/20.0/mac_images/remove_keyman.png
Binary file added products/mac/20.0/mac_images/video.png
6 changes: 6 additions & 0 deletions products/mac/20.0/start/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Getting started
---
* [Getting started with Keyman for macOS](tutorial)
* [Install Keyman for macOS](install-keyman)
* [Install a Keyman Keyboard](install-keyboard)
Loading
Loading