fix: unify shortcut key notation in en_US help manual - #320
Closed
LiHua000 wants to merge 3 commits into
Closed
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: LiHua000 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR standardizes the shortcut-key notation in the en_US Document Viewer help manuals so they match the canonical key name used in the application (Ctrl+Shift+/). Sequence diagram for viewing shortcut keys with Ctrl+Shift/sequenceDiagram
actor User
participant DocumentViewer
participant ShortcutViewer
User->>DocumentViewer: Press Ctrl+Shift/
DocumentViewer->>ShortcutViewer: key_ctrl_shift_slash
ShortcutViewer-->>User: Display shortcut keys
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
The "View Shortcut Keys" section in the en_US help manual documents the shortcut as "Ctrl + Shift+ ?", while the canonical key name defined in code is "Ctrl+Shift+/" (reader/app/Global.h:142, key_ctrl_shift_slash), which is also the value passed to deepin-shortcut-viewer for display. Unify the notation to "Ctrl+Shift+/" for consistency between the manual and the application. Log: 统一英文帮助手册快捷键文案与代码键名 Bug: https://pms.uniontech.com/bug-view-373443.html
The en_US help manual's hotkey.png was stale (from 2021, commit 3186eca), missing shortcuts added in the 2023 v23 merge (Move to the beginning/end) and using the old "Files" group name (renamed to "File" in 2026). Regenerate the image from the current shortcut definitions in ShortCutShow.cpp initPDF() at baseline 47fffc9. The image is rendered offline via Qt (not a real UI screenshot) and reproduces the two-column layout with dark theme matching the deepin-shortcut-viewer style. Content checklist (all verified): - Group names: Settings, File (not Files), Display, Tools, Edit - Display includes Move to the beginning (Ctrl+Home) and Move to the end (Ctrl+End) - Tools includes Fullscreen (F11) - Edit does not include Save (Save is only in File group) Log: 重新生成英文帮助手册快捷键截图，基于现行快捷键定义离线渲染 Bug: https://pms.uniontech.com/bug-view-373443.html
Previous fix accidentally dropped the "+" between Shift and "/", producing "Ctrl+Shift/" instead of the canonical "Ctrl+Shift+/" (Global.h:142, key_ctrl_shift_slash). Restore the missing separator so the manual matches the code and the in-app viewer display exactly. Log: 补回英文帮助手册快捷键文案缺失的 "+" 分隔符 Bug: https://pms.uniontech.com/bug-view-373443.html
LiHua000
force-pushed
the
fix/en-us-shortcut-help-373443
branch
from
August 20, 2026 05:56
e9e12c8 to
4d2ca55
Compare
deepin pr auto review★ 总体评分：100分■ 【总体评价】
■ 【详细分析】
■ 【改进建议代码示例】 无需修改，当前文档更新已符合规范。 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does
Fixes the en_US help manual shortcut help content for PMS 373443:
1. Shortcut key notation (commit 583473c)
Unifies the shortcut-key notation in the "View Shortcut Keys" section with the canonical key name used in code:
Ctrl + Shift+ ?Ctrl+Shift+/The canonical key name is defined as
key_ctrl_shift_slash = "Ctrl+Shift+/"(reader/app/Global.h:142) and is the value passed todeepin-shortcut-viewerfor display (reader/widgets/ShortCutShow.cpp:109).Applied to all three en_US manual files:
assets/deepin-reader/document-viewer/en_US/document-viewer.mdassets/deepin-reader/document-viewer/en_US/eu_document-viewer.mdassets/deepin-reader/document-viewer/en_US/i_document-viewer.md2. Regenerate hotkey.png (commit 475eb0c)
The previous
hotkey.pngwas stale (from 2021, commit3186ecab), missing shortcuts added in the 2023 v23 merge and using the oldFilesgroup name (renamed toFilein 2026).Content checklist (all verified via OCR):
Scope
Only en_US scope (PMS 373443). zh_CN/zh_TW have the same stale-image issue but are tracked as a separate concern.
No runtime shortcut logic is changed.
Bug: https://pms.uniontech.com/bug-view-373443.html
Summary by Sourcery
Align the en_US Document Viewer shortcut documentation and reference image with the current shortcut definitions.
Bug Fixes:
Ctrl+Shift+/key combination.Enhancements:
Documentation: