Make WordPress Core

Opened 20 months ago

Closed 17 months ago

Last modified 17 months ago

#56920 closed enhancement (fixed)

Illogical placement link to shortcuts in comments help section.

Reported by: nekojonez's profile NekoJonez Owned by: audrasjb's profile audrasjb
Milestone: 6.2 Priority: normal
Severity: normal Version:
Component: Help/About Keywords: good-first-bug has-patch commit
Focuses: ui, accessibility, docs, administration Cc:

Description

At the moment, there is a shortcut to the help section in the comments that leads to this page: https://wordpress.org/support/article/keyboard-shortcuts/

When you read this, it starts with explanation about other shortcuts that are also handy in the editor and such.

This might be confusing since it even says "editor shortcuts".

That leads me to do a quick thinking exercise where I think we should split this page into two somewhat... Where the usual shortcuts of the editor are also mentioned and those can maybe added to the help section of posts/pages?
Or make it a bit more clear...?

Or am I overthinking things here?

Change History (13)

#1 @NekoJonez
20 months ago

  • Component changed from General to Help/About

#2 follow-up: @SergeyBiryukov
20 months ago

  • Milestone changed from Awaiting Review to 6.2

Thanks for the ticket!

Maybe linking directly to the Keyboard Shortcuts for Comments section would help?

Just noting that the same link also exists on Edit User screen, next to the "Enable keyboard shortcuts for comment moderation" option, and would need to be updated there as well.

#3 in reply to: ↑ 2 @NekoJonez
20 months ago

Replying to SergeyBiryukov:

Thanks for the ticket!

Maybe linking directly to the Keyboard Shortcuts for Comments section would help?

Just noting that the same link also exists on Edit User screen, next to the "Enable keyboard shortcuts for comment moderation" option, and would need to be updated there as well.

That's an excellent idea I think!

#4 @sabernhardt
20 months ago

  • Focuses accessibility added
  • Keywords needs-patch good-first-bug added

I would like to use exactly the same translatable string for both links. "Documentation on Keyboard Shortcuts" explains the link better than "More information" does, and the user profile link could open in the same tab. We already need a different way to prevent data loss when clicking any other link on the page (#40493).

History of the target attribute:

  • r16448 started opening the "More information" link in a new tab.
  • r38718 removed target="_blank" from the help link, yet it's still on the profile page.
  • @juhise opened #33303 and then moved the patch to ticket:23432#comment:20.

This ticket was mentioned in PR #3563 on WordPress/wordpress-develop by @dennisatyoast.


20 months ago
#5

  • Keywords has-patch added; needs-patch removed

Make links for "Keyboard Shortcuts" about comments go to the specific section on the support page. This also changes the link on user-edit.php by using the same phrasing and opening in the same window by default. That's done in a separate commit so it can be left out of this change.

Trac ticket: https://core.trac.wordpress.org/ticket/56920

#6 @dennisatyoast
20 months ago

I've created a PR to update both links to point immediately to the section about Keyboard Shortcuts for Comments.

This PR also includes the suggestion from @sabernhardt to make the translations exactly the same, by using the text "Documentation on Keyboard Shortcuts" and having the links open in the same tab. Since I'm unsure about the status of that suggestion, I did that in a separate commit in the PR so it can also be left out if preferred.

#7 @robinwpdeveloper
19 months ago

Test Report

This report validates that the indicated patch addresses the issue.

Patch tested: https://patch-diff.githubusercontent.com/raw/WordPress/wordpress-develop/pull/3563.diff

Environment

  • OS: macOS 11.2.3
  • Web Server: Nginx
  • PHP: 7.4.29
  • WordPress: 6.1-alpha-53344-src
  • Browser: Chrome 108.0.5359.94
  • Theme: Twenty Twenty-Two
  • Active Plugins:
    • None

Actual Results

  • ✅ Links are updated with the section id and opened in the same tab after applying the patch.

Additional Notes

  • I have tested both links and both links are fine. Also opened in the same tab as expected.

Supplemental Artifacts

This ticket was mentioned in Slack in #core-test by robinwpdeveloper. View the logs.


19 months ago

#9 @audrasjb
17 months ago

  • Keywords commit added
  • Owner set to audrasjb
  • Status changed from new to accepted

Thanks everyone!
The PR is good to ship.
Self assigning for commit.

#10 @audrasjb
17 months ago

  • Resolution set to fixed
  • Status changed from accepted to closed

In 55042:

Help/About: Improve comments keyboard shortcuts HelpHub links.

This changeset adds an anchor in Comments keyboard shortcut documentation links to direct the user to a more specific section of the HelpHub documentation. It also removes `target="_blank" from a link, since preventing data loss when clicking any on User Edit and Comment Edit screens is already handled by another existing ticket (#40493).

Props NekoJonez, SergeyBiryukov, sabernhardt, dennisatyoast, robinwpdeveloper.
Fixes #56920.

@dennisatyoast commented on PR #3563:


17 months ago
#12

Thanks, @audrasjb! 🙏

@dennisatyoast commented on PR #3563:


17 months ago
#13

Thanks, @audrasjb! 🙏

Note: See TracTickets for help on using tickets.