mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 16:35:33 +00:00
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
26 lines
1.3 KiB
Markdown
26 lines
1.3 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [@keymanapp/kmc-model](./kmc-model.md) > [WordBreakerSpec](./kmc-model.wordbreakerspec.md)
|
|
|
|
## 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:**
|
|
|
|
```typescript
|
|
export interface WordBreakerSpec
|
|
```
|
|
|
|
## Properties
|
|
|
|
| Property | Modifiers | Type | Description |
|
|
| --- | --- | --- | --- |
|
|
| [joinWordsAt?](./kmc-model.wordbreakerspec.joinwordsat.md) | <code>readonly</code> | string\[\] | <p>_(Optional)_ If present, joins words that were split by the word breaker together at the given strings. e.g.,</p><p>joinWordsAt: \['-'\] // to keep hyphenated items together</p><p> 14.0</p> |
|
|
| [overrideScriptDefaults?](./kmc-model.wordbreakerspec.overridescriptdefaults.md) | <code>readonly</code> | OverrideScriptDefaults | <p>_(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.</p><p> 14.0</p> |
|
|
| [use](./kmc-model.wordbreakerspec.use.md) | <code>readonly</code> | [SimpleWordBreakerSpec](./kmc-model.simplewordbreakerspec.md) | |
|
|
|