Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(developer): New Project - Description field and tweaks 🦕 #9950

Merged

Conversation

mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Nov 6, 2023

Fixes #9869.

Adds a 'Description' field, tweaks Copyright strings, and tweaks default content for documentation to the New Project wizards and kmconvert.

User Testing

TEST_NEW_KEYBOARD_PROJECT: Create a new keyboard project, and verify that the Description field is visible in the resulting README.md, readme.htm, welcome.htm, and in the Description field of the package. Check also that the Copyright string starts with the word 'Copyright'.

TEST_NEW_MODEL_PROJECT: Create a new lexical model project, and verify that the Description field is visible in the resulting README.md, readme.htm, welcome.htm, and in the Description field of the package. Check also that the Copyright string starts with the word 'Copyright'.

Fixes #9869.

Adds a 'Description' field, tweaks Copyright strings, and tweaks
default content for documentation to the New Project wizards and
kmconvert.
@keymanapp-test-bot keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Nov 6, 2023
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Nov 6, 2023

User Test Results

Test specification and instructions

  • TEST_NEW_KEYBOARD_PROJECT (PASSED): Tested with the attached PR build (Keyman Developer 17.0.204-alpha-test-9950) on Windows 10 OS and here is my observation: 1. Created a new keyboard project and noticed that there is a Description field under keyboard name. 2. Entered some text in the Description field. 3. Verified that the entered text in the description field appears in README.md, readme.htm, welcome.htm files, and in the description field of the package. 4. Also, checked the Copyright string started with the word 'Copyright' in the corresponding fields. Seems to be working as expected. (notes)
  • TEST_NEW_MODEL_PROJECT (PASSED): Tested with the attached PR build (Keyman Developer 17.0.204-alpha-test-9950) on Windows 10 OS and here is my observation: 1. Created a new Lexical Model project and noticed that there is a Description field under keyboard name. 2. Entered some text in the Description field. 3. Verified that the entered text in the description field appears in README.md, readme.htm, welcome.htm, and in the description field of the package. 4. Also, checked the Copyright string started with the word 'Copyright' in the corresponding fields. Seems to be working as expected. (notes)

@keymanapp-test-bot keymanapp-test-bot bot added this to the A17S25 milestone Nov 6, 2023
@mcdurdin mcdurdin linked an issue Nov 6, 2023 that may be closed by this pull request
69 tasks
@mcdurdin mcdurdin linked an issue Nov 6, 2023 that may be closed by this pull request
8 tasks
@@ -353,7 +361,8 @@ procedure TfrmNewProjectParameters.EnableControls;
e := (Trim(editKeyboardName.Text) <> '') and
(Trim(editPath.Text) <> '') and
TKeyboardUtils.IsValidKeyboardID(Trim(editKeyboardID.Text), True) and
(GetTargets <> []);
(GetTargets <> []) and
(Trim(memoDescription.Text) <> '');
Copy link
Contributor

Choose a reason for hiding this comment

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

I was thinking

Suggested change
(Trim(memoDescription.Text) <> '');
(GetDescription <> '');

would be more DRY. But then it would involve changing the other ones, and then
I saw GetKeyboardID returns a Trim(LowerCase(editKeyboardID.Text)), so maybe nvm

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

@bharanidharanj
Copy link

Test Results

  • TEST_NEW_KEYBOARD_PROJECT (PASSED): Tested with the attached PR build (Keyman Developer 17.0.204-alpha-test-9950) on Windows 10 OS and here is my observation: 1. Created a new keyboard project and noticed that there is a Description field under keyboard name. 2. Entered some text in the Description field. 3. Verified that the entered text in the description field appears in README.md, readme.htm, welcome.htm files, and in the description field of the package. 4. Also, checked the Copyright string started with the word 'Copyright' in the corresponding fields. Seems to be working as expected.

..New Description field

createpage

..README.md

..readme.htm

..welcome.htm

..Description in Package view

@bharanidharanj
Copy link

bharanidharanj commented Nov 7, 2023

Test Results

  • TEST_NEW_MODEL_PROJECT (PASSED): Tested with the attached PR build (Keyman Developer 17.0.204-alpha-test-9950) on Windows 10 OS and here is my observation: 1. Created a new Lexical Model project and noticed that there is a Description field under keyboard name. 2. Entered some text in the Description field. 3. Verified that the entered text in the description field appears in README.md, readme.htm, welcome.htm, and in the description field of the package. 4. Also, checked the Copyright string started with the word 'Copyright' in the corresponding fields. Seems to be working as expected.

..New Description field

..READMEN.md

..readme.htm

..welcome.htm

..Description in Package view

@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Nov 7, 2023
@mcdurdin mcdurdin changed the title feat(developer): New Project - Description field and tweaks feat(developer): New Project - Description field and tweaks 🦕 Nov 12, 2023
@mcdurdin mcdurdin modified the milestones: A17S25, A17S26 Nov 13, 2023
Base automatically changed from feat/developer/tike-2.0-projects to master November 15, 2023 02:46
@mcdurdin mcdurdin merged commit c060666 into master Nov 15, 2023
5 checks passed
@mcdurdin mcdurdin deleted the feat/developer/9869-new-project-description-and-tweaks branch November 15, 2023 02:46
@keyman-server
Copy link
Collaborator

Changes in this pull request will be available for download in Keyman version 17.0.211-alpha

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

Successfully merging this pull request may close these issues.

feat(developer): Improve New Project wizard
4 participants