erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
spiegel-keyman/developer/docs/help/reference/api/kmc-model.wordbreakerspec.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1.3 KiB
Raw Blame History

Home > @keymanapp/kmc-model > WordBreakerSpec

WordBreakerSpec interface

Keyman 14.0+ word breaker specification:

Can support all old word breaking specification, but can also be extended with options.

14.0

Signature:

export interface WordBreakerSpec

Properties

Property Modifiers Type Description
joinWordsAt? readonly string[]

(Optional) If present, joins words that were split by the word breaker together at the given strings. e.g.,

joinWordsAt: ['-'] // to keep hyphenated items together

14.0
overrideScriptDefaults? readonly OverrideScriptDefaults

(Optional) Overrides word splitting behaviour for certain scripts. For example, specifing that spaces break words in certain South-East Asian scripts that otherwise do not use spaces.

14.0
use readonly SimpleWordBreakerSpec