keyman icon indicating copy to clipboard operation
keyman copied to clipboard
verified publisher icon keymanapp

docs(developer): add help site links

Open mcdurdin opened this issue 1 year ago • 1 comments

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.

mcdurdin avatar Mar 05 '24 09:03 mcdurdin

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

keymanapp-test-bot[bot] avatar Mar 05 '24 09:03 keymanapp-test-bot[bot]

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 avatar Mar 21 '24 12:03 bharanidharanj

  • 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

bharanidharanj avatar Mar 21 '24 12:03 bharanidharanj

  • 🟥 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

mcdurdin avatar Mar 22 '24 02:03 mcdurdin

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.

bharanidharanj avatar Mar 25 '24 08:03 bharanidharanj

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

keyman-server avatar Mar 26 '24 18:03 keyman-server