spiegel-keyman/common/schemas/kps/README.md
Marc Durdin 0f05da957f fix(developer): remove redundant Name and RTL fields from .kps LexicalModel
Follows on from the similar changes to `Keyboard` fields in #13600. This
deprecates the `RTL` and `Name` fields. `RTL` was never used. `Name` was
written but never presented to end users, so effectively irrelevant.
`Name` also was present in `File.Description` (already deprecated) for
the corresponding model.js _and_ `Info.Name`, so doubly redundant.

Also updates the schema documentation to mark the deprecated fields.

Relates-to: #13600
2025-04-02 05:39:09 +07:00

1.5 KiB

kps.xsd

Master version: https://github.com/keymanapp/api.keyman.com/blob/master/schemas/kps/17.0/kps.xsd

2025-04-02 18.0

  • Version 18.0 deprecates the following fields, and kmc-package does not use them (#13600):
    • Keyboards/Keyboard/Version
    • Keyboards/Keyboard/Name
    • Keyboards/Keyboard/RTL
    • LexicalModels/LexicalModel/Name
    • LexicalModels/LexicalModel/RTL (Note: was never read or written by any Keyman tooling)

2023-10-19 17.0

  • Version 17.0 adds:
    • LicenseFile - a .md file, usually named LICENSE.md
    • WelcomeFile - a .htm file, usually named welcome.htm (later versions will support .md)
    • Info/Description - a short Markdown description of the content of the package, e.g. shown in search results on keyman.com
    • RelatedPackages - a list of other packages which relate to this one, or are deprecated by it
    • Keyboards/Keyboard/Examples - a list of typing examples for the keyboard
    • Keyboards/Keyboard/WebOSKFonts - a list of font filenames (not necessarily in package) suitable for rendering the on screen keyboard
    • Keyboards/Keyboard/WebDisplayFonts - a list of font filenames (not necessarily in package) suitable for use with the keyboard
  • Version 17.0 removes:
    • LexicalModels/LexicalModel/Version - version information is not stored in the models, but only in the package metadata (was unused)

2023-04-21 7.0.1

  • Removes LexicalModels/LexicalModel/Version, as it was never read or written

2021-07-19 7.0

  • Initial version 7.0