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

docs(developer): add help site links #10939

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

mcdurdin
Copy link
Member

@mcdurdin mcdurdin commented Mar 5, 2024

Fixes #10550.

Also fixes an inadvertent issue where F1 was not opening context help in the text editor anywhere in Keyman Developer. This means that pressing F1 while a keyword is highlighted in a .kmn keyboard will not re-open the context help for that keyword once more (yay!)

User Testing

Wait for keymanapp/help.keyman.com#1090 to be merged before doing this test.

  • TEST_NEW_PROJECT_HELP: In the New Project, New LDML Keyboard Project window, press F1. The help for the window should open in your browser.
  • TEST_LDML_EDITOR_HELP: Open an LDML XML keyboard and press F1. The help for the LDML editor window should open in your browser.
  • TEST_LDML_DEBUGGER_HELP: Open an LDML XML keyboard, compile and start testing (F5) and press F1. The help for the LDML debug window should open in your browser.
  • TEST_KMN_CONTEXT_HELP: Open a Keyman .kmn keyboard, click on a keyword in the source view (e.g. begin, store, index, etc) and press F1. The help for that topic should open in your browser. You may wish to try with a few keywords.

Also fixes an inadvertent issue where F1 was not opening context help in
the text editor anywhere in Keyman Developer. This means that pressing
F1 while a keyword is highlighted in a .kmn keyboard will not re-open
the context help for that keyword once more (yay!)
@mcdurdin mcdurdin requested a review from darcywong00 as a code owner March 5, 2024 09:16
@keymanapp-test-bot keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed labels Mar 5, 2024
@keymanapp-test-bot
Copy link

keymanapp-test-bot bot commented Mar 5, 2024

User Test Results

Test specification and instructions

  • TEST_NEW_PROJECT_HELP (PASSED): Retested as per Marc's suggestion and here is my observation: 1. Opened a new LDML project dialog. 2. Pressed F1 key. Verified that the New LDML project help topic was displayed on the screen. Seems to be working as expected. (notes)
  • TEST_LDML_EDITOR_HELP (PASSED): 1. Opened LDML XML keyboard window. 2. Pressed F1 key and verified that it opens the the relevant help topic in a browser. (notes)
  • TEST_LDML_DEBUGGER_HELP (PASSED): 1. Opened the LDML XML keyboard window. 2. Compiled it. Opened the debugger window. 3. Pressed F1 key. Verified that it opened the relevant help topic. (notes)
  • TEST_KMN_CONTEXT_HELP (PASSED): 1. Opened the .kmn Keyboard. 2. Opened the Source window. 3. Clicked near the 'begin' word then pressed the F1 key. Verified that it opens the corresponding help topic in a browser. 4. Clicked 'store' word then pressed the F1 key. Verified that it opens the corresponding help topic in a browser. (notes)

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

@darcywong00 darcywong00 modified the milestones: B17S3, B17S4 Mar 16, 2024
@bharanidharanj
Copy link

Test Results

  • TEST_NEW_PROJECT_HELP (FAILED): Tested with the attached PR build (Keyman 17.0.282-beta-test-10939) on Windows 10 OS and here is my observation: 1. Created a new LDML keyboard project. 2. Pressed F1 key in the Keyboard project Window. Noticed that there is no help topic opened after pressing F1 key.

englishproj

@bharanidharanj
Copy link

  • TEST_LDML_EDITOR_HELP (PASSED): 1. Opened LDML XML keyboard window. 2. Pressed F1 key and verified that it opens the the relevant help topic in a browser.

ldmleditor

  • TEST_LDML_DEBUGGER_HELP (PASSED): 1. Opened the LDML XML keyboard window. 2. Compiled it. Opened the debugger window. 3. Pressed F1 key. Verified that it opened the relevant help topic.

debuggerhelp

  • TEST_KMN_CONTEXT_HELP (PASSED): 1. Opened the .kmn Keyboard. 2. Opened the Source window. 3. Clicked near the 'begin' word then pressed the F1 key. Verified that it opens the corresponding help topic in a browser. 4. Clicked 'store' word then pressed the F1 key. Verified that it opens the corresponding help topic in a browser.

..begin help topic

..group help topic

..store help topic

@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Mar 21, 2024
@mcdurdin
Copy link
Member Author

  • 🟥 TEST_NEW_PROJECT_HELP (FAILED): Tested with the attached PR build (Keyman 17.0.282-beta-test-10939) on Windows 10 OS and here is my observation: 1. Created a new LDML keyboard project. 2. Pressed F1 key in the Keyboard project Window. Noticed that there is no help topic opened after pressing F1 key. (notes)

@bharanidharanj thank you for running through these tests. That is certainly an issue that you identified (I will raise a separate issue), but actually I was hoping you'd test the F1 function in the New LDML Project Parameters dialog box that appears when you select New Project, LDML Keyboard:
image

@keymanapp-test-bot retest TEST_NEW_PROJECT_HELP

@bharanidharanj
Copy link

Test Results

  • TEST_NEW_PROJECT_HELP (PASSED): Retested as per Marc's suggestion and here is my observation: 1. Opened a new LDML project dialog. 2. Pressed F1 key. Verified that the New LDML project help topic was displayed on the screen. Seems to be working as expected.

@keymanapp-test-bot keymanapp-test-bot bot removed the user-test-required User tests have not been completed label Mar 25, 2024
@mcdurdin mcdurdin merged commit 9cba6e7 into beta Mar 26, 2024
5 checks passed
@mcdurdin mcdurdin deleted the docs/developer/10550-ldml-window-help-links branch March 26, 2024 00:37
@keyman-server
Copy link
Collaborator

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

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.

docs(developer): add context help for New LDML Project, LDML Keyboard Editor, LDML Test Window
4 participants