Skip to content

Conversation

@mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Apr 1, 2025

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

TODO

User Testing

TEST_COMPILE: Load a lexical model project from the lexical models repository. Open the .kps file, make an inconsequential change, save it, and try and build the entire project. Verify that the project builds. Open the .kps file in a text editor, and verify that the field Package/LexicalModels/LexicalModel/Name has been removed.

TEST_NEW_PROJECT: Create a new lexical model project and verify that it builds correctly

…alModel`

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
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Apr 1, 2025

User Test Results

Test specification and instructions

Test Artifacts

Copy link
Contributor

@darcywong00 darcywong00 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@dinakaranr
Copy link

Test Results

I tested the PR13640 task in the Keymandeveloper-18.0.222-beta-test-13640 build in Windows 10. Here, I am sharing my observation.

  • TEST_COMPILE (Passed): notes
  1. Installed the Keymandeveloper-18.0.222.exe build.
  2. Open the "sil.jra-khmer.jarai" LDML keyboard project from the GitHub\lexical-models\release folder path.
  3. Click on the "Packaging" tab and then click the "*.kps" link button.
  4. Click on the "Source" tab.
  5. Enter some text in the "Description" tag and then save the changes.
  6. Build the entire project on the packaging.
  7. Verified that the project build folder had files(inside the build folder)
  8. Compile the changes by clicking the keyboard menu --> Compile keyboard.
  9. Open the .kps file in a notepad from the source folder.
  10. Verified that the name tags are removed in the *.kps file
  11. The "Package/Keyboards/Keyboard/Name" field disappeared after editing and compiling the *.kps file.
    It works well.
  • TEST_NEW_PROJECT (Passed): notes
  1. Installed the Keymandeveloper-18.0.222.exe build.
  2. Open an LDML keyboard project from the GitHub\lexical-models\release folder path.
  3. Create a new LDML keyboard project by clicking the project menu --> new project.
  4. Build the entire project on the packaging.
  5. Verified that the project build folder has files(inside the build folder)
  6. Compile the changes by clicking the keyboard menu --> Compile keyboard.
  7. Open the .kps file in a notepad from the source folder.
  8. Verified that the name does not appear in the *.kps file
    It works well.

@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Apr 2, 2025
Base automatically changed from fix/developer/13576-13593-remove-redundant-keyboard-fields-from-kps to beta April 2, 2025 22:40
@mcdurdin mcdurdin merged commit da5b05a into beta Apr 2, 2025
11 checks passed
@mcdurdin mcdurdin deleted the fix/developer/13600-follow-remove-redundant-lm-fields-from-kps branch April 2, 2025 22:40
mcdurdin added a commit to keymanapp/api.keyman.com that referenced this pull request Apr 2, 2025
@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 18.0.227-beta

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants