diff --git a/ios/help/basic/config/index.md b/ios/help/basic/config/index.md new file mode 100644 index 0000000000..22468a4021 --- /dev/null +++ b/ios/help/basic/config/index.md @@ -0,0 +1,60 @@ +--- +title: Using the Settings Screen - Keyman for iPhone and iPad Help +--- + +## Using the Settings Screen + +This Settings screen is used to configure keyboards and dictionaries. +It also has many of the options that are available on the 'Get Started' menu. To access the Settings screen: + +Step 1) +Open the Keyman app. + +Step 2) +Click the ellipsis (...) for additional options. Select 'Settings' + +![](../../ios_images/settings-screen.png) + +Each selection on the Keyman Settings screen is described in further detail below: + + +## Installed Languages +This displays the number of installed languages. Click this line for the 'Installed Languages' +screen where you may view the languages you have installed and, by clicking any one language, find its keyboards and dictionaries along with [more settings](../language-settings). + +![](../../ios_images/find-new.png) + +Click on this to [search for a keyboard or language](../../start/searching-for-keyboards). + +## Show Banner +This adds a banner to the top of the keyboard to allow space for pop-up keys to render above the top row of keys. + +![](../../ios_images/banner.png) + +When this is off, + +![](../../ios_images/no-banner.png) + +pop-up keys in the top row render horizontally. + +## Show "Get Started" on startup +When enabled, the Keyman app will display the 'Get Started' screen on app startup. + +## Allow error reporting +When enabled, the Keyman app will send crash reporting information to https://sentry.keyman.com. No personally identifiable information or keyboard strokes are recorded. + +## Spacebar Caption +Click on this to [change the displayed keyboard name](spacebar-caption) on the spacebar. + +## System Keyboard Settings +By default, installed Keyman keyboards are only available to use within the Keyman app. Click on this setting to +bring up the iOS system configuration so Keyman can be added as a system-wide keyboard. + +## Set Keyman as default keyboard +Select 'Keyboards' to bring up the iOS system configuration for setting Keyman as the default system-wide keyboard. Toggle both 'Keyman' and 'Allow Full Access'. + +![](../../ios_images/system-wide-setting.png) + +## Install From File +Select this to browse the files on your device and install a keyboard from a .kmp file. + diff --git a/ios/help/basic/config/spacebar-caption.md b/ios/help/basic/config/spacebar-caption.md new file mode 100644 index 0000000000..4344c83063 --- /dev/null +++ b/ios/help/basic/config/spacebar-caption.md @@ -0,0 +1,13 @@ +--- +title: Spacebar Caption - Keyman for iPhone and iPad Help +--- + +## Spacebar Caption + +This menu can be used to change the displayed keyboard name on the spacebar. The options are: +* Language name +* Keyboard name +* Language name + Keyboard name +* Blank + +![](../../ios_images/spacebar-caption.png) diff --git a/ios/help/basic/index.md b/ios/help/basic/index.md index 10df8f8300..e2c9e82d6d 100644 --- a/ios/help/basic/index.md +++ b/ios/help/basic/index.md @@ -4,6 +4,9 @@ title: Basic Help * [Switching Between Keyboards](switching-between-keyboards) +* [Using the Settings Screen](config/) + +* [Language Settings](language-settings) * [Installing Custom Keyboards/Dictionaries](installing-custom-keyboards-dictionaries) * [Sharing Keyboards and Dictionaries](sharing-keyboards) diff --git a/ios/help/basic/language-settings.md b/ios/help/basic/language-settings.md new file mode 100644 index 0000000000..af39c37f36 --- /dev/null +++ b/ios/help/basic/language-settings.md @@ -0,0 +1,58 @@ +--- +title: Language Settings - Keyman for iPhone and iPad Help +--- + +### Access "Installed Languages" +First, open the "Settings" menu. + +![](../ios_images/add-keyboard-i.png) + +The "Installed Languages" menu found here manages your installed keyboards and dictionaries. + +![](../ios_images/add-keyboard-i2.png) + +You should then see the following screen: + +![](../ios_images/add-keyboard-i3.png) + + +### Select a Language to View its Settings +After selecting a language, you will find settings in these categories: Keyboards, Language Settings, and Dictionaries. + +![](../ios_images/language-settings.png) + +### Keyboard Settings +In Keyboard settings, you will find a list of keyboards installed in the language. After clicking a keyboard, you will see + +* the version of the installed keyboard +* the link to the 'Keyboard help' screen with information about its symbols and fonts +* the option to Uninstall the keyboard +* the QR code for loading this keyboard on another device + +### Language Settings +In Language settings, you may see + +* the option to enable predictions +* if predictions are enabled, the option to enable corrections + +These predictions and corrections are given while a user types, based upon the dictionary selected under 'Dictionaries'. + +### Dictionaries +In Dictionaries, you will see a list of dictionaries installed for the language. + +![](../ios_images/find-new.png) + +Click this to select a new dictionary from a list of available dictionaries in the language. + +![](../ios_images/dictionary-select.png) + +Back in the dictionaries list, after clicking a dictionary, you will see its name again, along with a blue information icon: + +![](../ios_images/dictionary-list.png) + +After clicking the 'i' icon, you will see + +* the version of the installed dictionary +* the option to Uninstall the dictionary + + diff --git a/ios/help/index.md b/ios/help/index.md index 883d4e5112..333dafb9f2 100644 --- a/ios/help/index.md +++ b/ios/help/index.md @@ -25,6 +25,8 @@ title: Keyman for iPhone and iPad 17.0 Help ### [Using Keyman for iPhone and iPad](basic/) * [Switching Between Keyboards](basic/switching-between-keyboards) +* [Using the Settings Screen](basic/config/) +* [Language Settings](basic/language-settings) * [Installing Custom Keyboards/Dictionaries](basic/installing-custom-keyboards-dictionaries) * [Sharing Keyboards and Dictionaries](basic/sharing-keyboards) * [Using the Keyman Browser](basic/using-keyman-browser) diff --git a/ios/help/ios_images/banner.png b/ios/help/ios_images/banner.png new file mode 100644 index 0000000000..e7d38e8a2e Binary files /dev/null and b/ios/help/ios_images/banner.png differ diff --git a/ios/help/ios_images/dictionary-list.png b/ios/help/ios_images/dictionary-list.png new file mode 100644 index 0000000000..b2af2f53f5 Binary files /dev/null and b/ios/help/ios_images/dictionary-list.png differ diff --git a/ios/help/ios_images/dictionary-select.png b/ios/help/ios_images/dictionary-select.png new file mode 100644 index 0000000000..ae8300530a Binary files /dev/null and b/ios/help/ios_images/dictionary-select.png differ diff --git a/ios/help/ios_images/find-new.png b/ios/help/ios_images/find-new.png new file mode 100644 index 0000000000..b76df881b6 Binary files /dev/null and b/ios/help/ios_images/find-new.png differ diff --git a/ios/help/ios_images/language-settings.png b/ios/help/ios_images/language-settings.png new file mode 100644 index 0000000000..1cea1ffcc1 Binary files /dev/null and b/ios/help/ios_images/language-settings.png differ diff --git a/ios/help/ios_images/no-banner.png b/ios/help/ios_images/no-banner.png new file mode 100644 index 0000000000..68a19f67f6 Binary files /dev/null and b/ios/help/ios_images/no-banner.png differ diff --git a/ios/help/ios_images/settings-screen.png b/ios/help/ios_images/settings-screen.png new file mode 100644 index 0000000000..1e5c72b7f8 Binary files /dev/null and b/ios/help/ios_images/settings-screen.png differ diff --git a/ios/help/ios_images/spacebar-caption.png b/ios/help/ios_images/spacebar-caption.png new file mode 100644 index 0000000000..2577c59e81 Binary files /dev/null and b/ios/help/ios_images/spacebar-caption.png differ diff --git a/ios/help/ios_images/system-wide-setting.png b/ios/help/ios_images/system-wide-setting.png new file mode 100644 index 0000000000..126fe13ec1 Binary files /dev/null and b/ios/help/ios_images/system-wide-setting.png differ