Frankie by Creativecrap

Begin with this release. The minimum requirement is iOS 15.0.

### Fallback Fonts

Fallback fonts used when the default font missing a glyph it will try to replace with the fallback font to display the glyph if available.

To use Fallback Font feature, please install custom fonts via the FontBooth app or other font provider apps.

The fallback font support built-in text editor and keyboard candidates, however the user installed font doesn’t support under keyboard extension therefore you can not use fallback font in custom keyboard.

#### NEW

- Added a keyboard character preview option, the key label will not respond to shift state just like legacy iOS keyboard if disabled.
- Added a Fallback Font feature to support using user installed fonts and enhance the lack of Unicode CJK block of system fonts.

#### FIXED

- Fixed incorrect cursor position when moving cursor by on-screen arrow keys.
- Fixed Always open Clip Pad on launch not working issue.
- Fixed other minor bugs.

#### CHANGED

- Input Method collection classified
- Keyboard collection classified

- Fixed an issue that caused the keyboard extension to crash since v3.0.1

In this release, we've fine-tuned the learning tool and introduced a user-custom lexicon and several other improvements.

Due to the data structure and source change, this release is incompatible with the previous version.

The lexicon and various functions may not work as expected if the upgrade process is not completed.
Please enter Setting / Chinese Lexicon and follow the upgrade instructions.
If you never use a custom lexicon or have some other issue after the upgrade,
you can choose Setting / Reset / Factory Reset to get a fresh restart.

#### NEW

- Haptic feedback for 3rd party keyboard
- Emoji, Symbols, and Kaomoji also gain training behavior

#### IMPROVEMENTS

- Most common words classified and training improved
- Adjust flick keyboard sensitivity

#### CHANGED

- Separate user custom lexicon from original lexicon
- Lexicon, Emoji Training, etc., are now all enabled by default
- Setting options get a re-arrangement
- Removed some sound effects
- Removed hidden characters from a different locale
- Removed Traditional Chinese conversion during import custom lexicon

#### FIXED

- QWERTY-K14 not working as expected
- Keyboard contains shrink rows that sometimes do not display correctly
- Various bug fixes

This release contains regular updates and a few bug fixes.

#### CHANGED

- Dictate text now respect for available locales instead of only allowing English
- Emoji database update, including the new Emojis introduced on iOS 16.4
- Update the most popular Emoji list
- Update resource files, including the input method list and some keyboard layouts

#### FIXED

- Related Emoji list may have duplicate items in the candidate panel

#### NEW

- In Clip Pad mode, split the close button into a "Done" button for dismissing the keyboard, a "Close" button for saving and closing document
- Show top-ranking emoji by default in the candidate panel
- Continuously select candidates by double tap items from the candidate panel

#### FIXED

- fixed inconsistent font on pop-up keys
- fixed [1/2] key incorrect response issue
release candidate 1

#### NEW

- Added: lexicon from array30

#### FIXED

- Fixed mismatch keyboard issue of bpmf-Hus.cin

This release contains several improvements and bug fixes.
For floating keyboard on iPadOS, now it fallbacks to most suitable keyboard layout for current input method automatically.
For Array input methods, the floating keyboard will use the flick keyboard layout instead regular 10x5 keyboard layout.

** The Emoji prediction is deprecated and will be removed in the further version.

#### NEW

- Added Shift-Q fore backward selection for bpmf-hsu keyboards.
- Added multiple touches support for Shift key and Sibling key.
- Added full-width symbol collection in candidate panel.
- Added Kaomoji symbol collection in candidate panel.

#### IMPROVEMENTS

- Exclude some specified keys for sibling input mode to prevent unexpected behavior.
- Reduce the length of radicals for Array input method with numeric type of keyboards by replacing with alternative positions.
- Reduce memory impact and improve performance for filtering characters that might be the same character between Traditional and Simplified Chinese locale.
- Improve the display of tones characters of bpmf keyboards.
- Improve floating keyboard support for iPadOS.

#### CHANGED

- The "bpmf-hsu.cin" table now belongs to bpmf input method family and supports Q-key features.
- The candidate select by keys feature will be disabled while using the numeric type of keyboard to prevent conflicts.
- Removed the individual bpmf tone label from bpmf keyboards.

#### FIXED

- Fixed the Enter key has no response to physical keyboards not made by Apple on iPadOS 15.0 and above.
- Fixed incorrect results or behaviors while candidates matching locale feature enabled.
- Fixed an issue that may cause 3rd party keyboard to have incorrect keyboard height in Split view on iPadOS 15.0 and above.

Introduce the new "Matches locale" option for Candidate Bar to reducing candidates that are the same Chinese characters but different locales.

#### NEW

- Candidate Bar / Matches Locale option

#### NEW

- There is new storage for resource files, you may change the resource location to gitee from reset setting, if GitHub is not reachable

#### CHANGED

- Composer label now resized with the height of candidate bar
- Candidate items would use bigger font size when both composer label and Selkey options are turned off

#### FIXED

- Fixed an issue that may cause the content over Cloud service when the network is not stable
- Fixed the search function of the lexicon

Better stroke type input methods

#### NEW

- New keyboard layouts for stroke type input methods
- New symbols keyboard layouts

#### FIXED

- Fixed an issue that causes unable to insert symbol characters with Smart Punctuation
- Fixed an issue that shows the empty result when looking for more homophones and phonetic candidates
- Minor bug fixes

About Input Method and Keyboard

This release contains several new keypad style keyboard layouts and a new composing mode option.

#### NEW

- New keypad style keyboard layouts for Bpmf input method
- New 14 keys QWERTY keyboard layout
- New composing mode option for input method
- Display available radicals for the last candidate on the Space key

#### IMPROVEMENTS

- Array30/40 can use keypad without position keyboard layout properly
- Improve live preview for Array flick keyboard

#### CHANGED

- Optional result of radical lookups
- Popup keys changes for「-」「,」「@」
- Keyboard layout category changed
- Jyut6ping3 input method and lexicon update

#### FIXED

- Fixed unable to disable radical lookup and phonetic lookup issue
- Fixed wrong radical lookups when Bpmf input method with non-standard keyboard layout issue
- Fixed an issue that causes unexpected deleting text before cursor when selecting candidates other than radical type
- Fixed a few issues when using keypad keyboard on Array input method
- Reduce memory footprint when loading keyboard layouts
- Minor bug fixes

#### NEW

- Added Jyut6ping3 input method
- Added lexicon information before install

#### CHANGED

- Improve the result of pinyin lexicon and sorting
- Instead of updating multiple resources from multiple places, you can now update them all at once from Settings / Reset / Update Resources
- Lexicon data updates
- Remove labels for built-in numeric keypad layout
- Replace the original Cantonese input method by Jyut6ping3
- Use gradient background instead of full transparent background on keyboard extension

#### FIXED

- Fixed a bug that causes incorrect result when the candidate phrase contains mixed letter cases
- Fixed a bug that select-key may return the wrong result or unexpected behavior on Position mode
- Fixed a typo that causes the pop-up function for numeric keys missing
- Fixed an issue that causes duplicated behaviors after changed between input methods, i.e. duplicated candidate outputs
- Fixed keyboard layout margin inconsistency
- Fixed the background color issue for keyboard previews

Introduce One-Handed Keyboard

#### NEW

- One-handed keyboard support for phone devices

#### CHANGED

- Candidate panel tab style
- Candidate item selection by shortcut not longer required any Select-Key mode
- Position Select-Key ignore composition to make the ordering more nature

#### FIXED

- Keyboard keys around the edge delay issue fixes
- Minor bug fixes

It may not be visible but this update is a big one.
Some of the core functionality has been redesigned to make it more stable and benefits with performance improvements.
More custom-able behavior for different personal preferences.
Thank you for the feedback and the feature requests, we always love hearing what we can do to make Frankie/OkidoKey better.

Keep Calm And Mask On.

#### NEW

- Added Caps Lock preference for toggle input method or capitalize
- Added more shortcuts for candidate navigation for external keyboard
- Added Position Select-Key mode
- Added sibling keyboard gesture option
- Added single capital character gesture for the shift key
- Allows globe key remain in popup state
- Offers an option to make a local copy of the file on saving error

#### IMPROVEMENTS

- Clip Pad open/close performance
- Overall performance and stability improves
- Shortcut cmd-s and visual response

#### CHANGED

- Added shift key modifier for Homophones and Phonetic lookup shortcuts
- Close button of the editor always use “Done” instead of Save and Done
- Keyboard and candidate item font size adjustments
- Moved accent labels to the bottom of the key for some Bpmf keyboards
- Moved input method rebuild action to its detail view
- Synced key state across all keyboards, i.e. capitalize state

#### FIXED

- Bpmf-Hsu input method radical and "G" key mismatch issue
- Document content syncing when editing the same document on multiple devices
- Highlighted candidate item jumping issue on keyboard navigation
- Incorrect keyboard size under iPadOS when app state changed
- Keyboard label color incorrect on dark mode
- Open In Place not working issue
- Some HUD response covered by keyboard issue
- Unexpected sibling keyboard behavior

OkidoKey has a new name: Introducing Frankie

We’re changing the name and logo, but everything else stays the same.

- Allows to change Sel-key for each input method
- Added Q-Key support for Hsu-bpmf input method
- Fixed a bug that cause Sel-Key return wrong candidate on Array input method
- Other bug fixes and adjustments

#### IMPROVEMENTS

- Allows selecting the first candidate by Return key and keyboard shortcut.
- Rename OkidoKey "Clipboard" to "Clip Pad" to reduce confusion with the system clipboard.
- Added two new keyboard layout for array10.
- Added Haptic feedback for keyboard, it "feels" more like the native keyboard.
- Added Simplified Chinese lexicon from Jeiba.
- Add Universal Clipboard and Clear option for Clip Pad.

#### FIXED

- Fixed a bug that causes selecting a candidate may return multiple times after switching between keyboards.
- Fixed a bug that causes Array context to have extra candidates while having duplicate compositions in shortcut mode.
- Fixed icon or key color mismatch in dark mode.
- Fixed incorrect icon for caps lock under iOS12 and below.
- Fixed the space key not display correct state after cursor moving mode.
- Fixed the w and arrow keys caused keyboard no response issue from the Array flick and position1 keyboards.
- Fixed various bugs for install and import Chinese Lexicon.
- Fixed various issues from the text editor, including English mode and emoji issues.

It's been a while since our last release, thank you for the feedback and the feature requests.

This release contains lots of bug fixes and compatibility for iOS13.

To make keyboard shortcuts easy to use and manageable, we have redesigned the key combinations for all shortcuts, please review them from Setting / Shortcuts.

Alone with the release, all lexicon databases updates all phrases with incorrect pronunciations, for example, 恐嚇 "konghe" was previously "kongxia", 龜裂 "junlie" was previously "guilie", etc. It's recommended to update your current lexicon database from Setting / Lexicon, choose the proper lexicon and update with replace option.

#### NEW

- All icons use built-in SF Symbol on iOS13.
- Dark mode supported on iOS13.
- You can now arrange the priority of predictive candidates from Setting / Candidate Priority.
- You can use cmd-s to save the document without close the document.

#### IMPROVEMENTS

- Increase the space key size for choco and some keyboard layouts that have more than 4 keys at the last row.
- Clipboard auto-copy visual feedback.
- Lexicon search behavior now the same as a keyboard.
- Improved the stability of text editor.
- Redesigned keyboard shortcuts.

#### FIXED

- Fixed a bug where radicals not transformed into the specified Chinese locale.
- Fixed a bug that returns the wrong candidate by select-keys on Array Context.
- Fixed a bug that causes on-screen keyboard with the wrong size when awaking from the docked mode.
- Fixed a bug that input method imported with file extension name other than .cin not identified as a valid input method.
- Fixed a bug that lexicon training not working.
- Fixed an issue that causes document scrolled to the top while saving.
- Fixed an issue that causes text editor not drawing lines properly.
- Fixed an issue that pasting text from the clipboard at a wrong position.
- Fixed crashes that could occur when accessing the lexicon database.
- Fixed wrong pronunciation of phrases from each lexicon database.

added: text editor margin and line spacing preference
added: custom lexicon weight
added: keyboard live preview
fixed: missing visual response for auto-copy button
fixed: missing descriptions

fixed: Incomplete result in candidate panel for Array input method
changed: Increased the range of keyboard height

Candidate bar became heavy and not easy to navigate while more and more resource appears.

Introduce New Candidate Panel

To open the new Candidate Panel by select “…” from the candidate bar.
Candidate Panel sort candidate resources into different tabs. It can display more items at once and easy to navigate for more items.

The candidate bar only displays most recently candidates for each category, to reduce resource usage and gain performance improvements at the same time. The behavior also applies to candidates form input method itself.

- Added: New Candidate Panel
- Added: Initial input for lexicon, i.e. mmm -> 莫名其妙、密密麻麻、某某某
- Changed: Remove up/down directions and speed gravity effects from Spacebar cursor control, allows only left/right directions in a certain range of current content
- Fixed: user lexicon not working properly
- Fixed: array-flick keyboard wrong behavior introduce in v2.2.0

Introduce the new lexicon and custom keyboard height

The 2.2.0 Release notes were:

You can now:

- Bring your own lexicon from CSV file
- Add or remove phrases on the fly
- Custom keyboard height
- Long press on space key to move the cursor

=== Lexicon ===

To make lexicon more manageable, the original lexicon database was removed and no longer installed by default. You can download and install new lexicon database or brings your own phrases from CSV file.

Visit FAQ for more information about the new lexicon.

*** NEW ***
- New lexicon database
- Edit phrases on device
- Import or export lexicon database
- Long press on space key to move the cursor on the keyboard
- Custom keyboard height for both portrait and landscape mode

*** FIXED ***
- Input numeric issue on Array input method
- Keyboard size incorrect and compatibility improves

*** REMOVED ***
- Custom keyboard bottom margin
- Original lexicon database

Keyboard visible state incorrect issue fixes

This release contains a few new features, bugs fixes, reliability and stability improves.
Some default value of preferences changed, please review setting if needed.
If you have strange issue after upgrade, please try Setting / Reset / Rest All to reset the preference and remove all input methods to factory mode.

Some default value may changed related to input method.
Some keyboard layout name changed.
Array10 input method has a new version update, please re-install it from setting.
Array30 has two new telephone style keyboard, flick and position keyboard.
The ibus2cin tool for Boshimay input method also updated, if you ever use previous version please update the tool then generate a new cin data table for install.

fixed: Editor may crash when text selected range changed
fixed: iCloud document version conflict
fixed: Input method memory usage and stability

added: Sibling keyboard is back
added: Introduce Key Flicks for iPad for half or full-width symbols
added: Sound and vibration error feedback options
added: Support for number type keyboards for custom keyboard
added: Custom extra keyboard bottom margin

changed: Each input method now has its own training, composition and other (shortcode, special…) preferences
changed: Install custom input method from Setting / Input Method instead of file browser
changed: Keyboard interface preference preview and others
changed: Keyboard background color adjustments
changed: Delay option for Emoji and lexicon predictive
changed: Remove invisible blank for Emoji

removed: Entire sentence input
removed: Migrations for Notes from v1
removed: No need to install custom input method from file browser
removed: Analytics

This release contains a few bugs fixes, reliability and stability improves
Lite version also contains advertising experience improved

While having other 3rd-party custom keyboard app installed, may case OkidoKey unrecognized the file type and unable to open or install. If unfortunately this happened to you, please try to rename the file extension from .cin to either .gcin, .xcin, .csv or .okidokey then try again, or please try remove other 3rd-party custom keyboard app first.

Also please notice that document migrations will be removed in next release, include export notes from iCloud and device, if you have’t done that please do before next release.

- Composition mode other than space key not working well with Zhuyin issue fixes
- Better memory management that improves the stability of keyboard extension
- Compatibility issues that affects on iPhone X
- New file type associations for input method data table as well as Markdown and other plain text documents
- New flat keyboard style

Candidates white background in Instagram.app issue fixes
Selkey behavior fixes

Keyboard layouts separate into 3 categories, previous “iPad” layout renames to “Full-size” remains suitable for bigger size iPad Pro, the new “iPad” layout more suitable for iPad 9.7” and iPad mini.

** Please review keyboard setting if anything changed
** For more information, please review https://github.com/ethanliu/OkidoKeyCharsets/tree/v2.1

Keyboard interface add shrink and appearance options
Full-sized keyboard layout now has caps lock key for toggle between English and input method

New learning feature for both input method and lexicon
Syllable correction for Zhuyin input method
More emoji
New entire sentence input feature for phonetic input methods, i.e. Zhuyin or Pinyin

Other stability and bug fixes

fixed: rebuild or install custom input method failed issue
added: phonetic, homophone and lexicon lookup for editor

This release contains stability and bug fixes

- Array input method improved and fixes
- Clipboard has some new options, please review them in Setting
- Allows turn off some shortcuts
- Fixes a few keyboard render issues on both iPad and iPhone X
- and a few bug fixes

This release contains a few bug fixes.

- Unable install cin file from other file providers issue fixes
- Unable close files from "sharing" issue fixes
- "bpmf-hsu" fixes
- Other bug fixes and adjustments

** Input method and Notes from v1 is not compatible to v2, please re-install input method or migrating notes from setting **

OkidoKey input method get lighter and smarter

- Install input method on the fly
- Allows to install multiple input methods and switching directly from keyboard
- Navigation pad for cursor control
- Pop-up keys
- Zhuyin input method now support ET26, ET41, Hsu, IBM keyboard layouts

OkidoKey Notes replaced by Files

- No more worry about which document is news anymore, just access the same plain text document from anywhere on any device directly
- Works better in split-view on iPad with bluetooth keyboard

This is an iOS11 compatibility update.
Please notice that this might be the last version supports iOS8~iOS10, if there is no any serious issue.
The next major release will taking advantage of Files.app that requires iOS11, for the reason I decided to drop supports for iOS10 and under.
Thank you all for continue support OkidoKey and all the feedbacks.

This release contains iOS 10.3 compatibility and other bug fixes.

We are sorry about the input method which import data table by v1.3.3 not working, please update to v1.3.4 then import the data table again, if you have the issue.

You can now use arrow keys to navigate between candidates and choose one by space or enter key without leaving keyboard while using Note or Clipboard.

Besides the regular selection keys, i.e. 1234 defined by input method itself, use Ctrl + Left/Right arrows to navigate between candidates then use space or enter key to select the candidate. While navigating candidates, use Ctrl + Up to trigger homophones and Ctrl + Down to trigger reverse lookup, also support escape key to clear current inputs.

There's a new keyboard layout for Boshiamy input method, and Array30 had been update a few times silently, download and install again from collection to upgrade. For more information about keyboard layout or input method data tables, please visit: https://github.com/ethanliu/OkidoKeyCharsets

This release also contains bug fixes and less memory footprint, thanks for everyone who report issues and suggestions.

Tips
Just in case you haven’t figured this out already. You don’t have to copy content from Clipboard manually, not event tap the Done button, once you leave Clipboard, say switching to another app right away, all you need to do is just paste it manually to anywhere you need.

v1.3.2 contains bug fixes and other improvements for iOS 10.

- Allow smaller candidate bar for iPad

v1.3.1 has a few new features besides bug fixes, including Traditional and Simplified Chinese conversion and Clipboard for multitasking.

## Traditional and Simplified Chinese Outputs

When Traditional and Simplified Chinese Conversion enabled, the original globe key will display current output locale. Same as shift key, use double tap to switch CHT / CHS output state.
When connected with bluetooth keyboard, use Ctrl + Shift shortcut to switch between CHT / CHS output locale.
* Please make sure the input method locale matches your .cin data table.
* There’s only Traditional Chinese lexicon available.

## Clipboard

Clipboard doesn’t have any store functionality, instead it will copy the content while closing, then you can paste it from any other apps.
With Split View Multitasking, you can now use bluetooth keyboard to input Chinese with any input method without launch OkidoKey Note.

## OkidoKey Note and Input Method State

It will now display current input method and locale in title when a bluetooth keyboard connected.

## Bluetooth Keyboard and Full Width Character

Some bluetooth keyboards using full width characters that case input method not working correctly, to solve this problem please enable this setting.
* Known bluetooth keyboards from Logitech® have this kinds of behaviour.

- Array30 input method lookup correction
- Cache performance and stability improved

- 5^ "的" exception for Array input method
- .cin data table viewer

- bug fixes
- Max Number of Components behavior changes

- Notes with hardware keyboard supports
- Keyboard layout preview and display preferences
- Traditional Chinese lexicon
- Emoji predicts
- Smart parentheses
- Two finger cursor control
- Optimised Array30 with short-code and special mode supports (re-downloa data table and install requried)
- A few keyboard layouts changes, includes array, keypad, symbol, etc.

For better performance and memory management, it requires to transform the data table to database structure, therefore it will reset your input method after install, please re-select you input method again.

This release includes bug fixes, increased stability and performance improvements, including:

- New candidate bar with a new configuration option
- Display more information about data table file
- Adds a collection of open source data tables
- Only shows keyboard layouts for current device model

- Return key now always send component from candidate bar.
- Optional vibration feedback.
- Fixes key b,v mismatched for qcode keyboard.
- Bugs fixes.