Skip to content

docs(manual): update user manual for OFD support and new features - #419

Merged
deepin-bot[bot] merged 1 commit into
linuxdeepin:masterfrom
add-uos:docs/manual-update
Oct 13, 2026
Merged

deepin-bot[bot] merged 1 commit into
linuxdeepin:masterfrom
add-uos:docs/manual-update

Conversation

@add-uos

@add-uos add-uos commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

变更说明

更新 deepin-manual 帮助文档(assets/deepin-reader/document-viewer),内容同步自文档组最新版本:

  • 新增 OFD(国家版式文档)格式支持说明,包含功能范围及限制说明(暂不支持注释、高亮、搜索及打印)
  • 新增「恢复阅读位置」章节:自动记录页码、滚动位置、缩放比例、显示模式、旋转角度等,重新打开文档自动恢复
  • 新增「批量打印」章节:文件管理器右键一键批量提交打印(CUPS 任务独立处理、默认参数、系统通知反馈说明)
  • 删除旧索引文件 document-viewer.md(4 种语言),新版格式已由 d_/p_ 文件承载全部内容
  • 文案微调(XPS/DJVU 支持说明等)

影响范围

  • 仅影响帮助手册资源(安装路径 share/deepin-manual/manual-assets/application/deepin-reader),不影响应用代码与构建
  • 四种语言(zh_CN/zh_HK/zh_TW/en_US)同步更新,common 图标与截图无变化

统计

12 files changed, 376 insertions(+), 1229 deletions(-)

Log: 更新帮助文档

Summary by Sourcery

Update the localized Document Viewer manuals to reflect current formats, reading, printing, and viewing features.

New Features:

  • Document the newly supported OFD format and its current viewing limitations.
  • Add user guidance for restoring reading positions, batch printing, and eye-protection modes.

Enhancements:

  • Clarify document-format capabilities and update printing, annotation, search, and highlighting support notes across all supported locales.
  • Consolidate the manual content by removing obsolete localized index files and updating the maintained document pages.

Documentation:

  • Synchronize the Document Viewer manual across Chinese and English locales with current feature and format support information.

@sourcery-ai

sourcery-ai Bot commented Oct 13, 2026

Copy link
Copy Markdown

Sorry @add-uos, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 2 days and 15 hours by commenting @sourcery-ai review. Upgrade to get a review now.

@sourcery-ai

sourcery-ai Bot commented Oct 13, 2026

Copy link
Copy Markdown

Reviewer's Guide

Updates the Document Viewer help resources in zh_CN, zh_HK, zh_TW, and en_US to document OFD support, reading-position restoration, batch printing, and eye-protection modes, while removing obsolete index files and applying related editorial corrections; no application code is changed.

Flow diagram for restoring the reading position

flowchart LR
    A[Open previously viewed document] --> B[Match saved reading state]
    B --> C[Restore page and interface state]
    C --> D[Show restored-position prompt]
    D --> E[Return to first page if selected]
Loading

Flow diagram for OFD support and limitations

flowchart LR
    A[Open OFD document] --> B[Basic viewing]
    B --> C[Zoom and page turning]
    B --> D[View document information]
    B --> E[Annotations unavailable]
    B --> F[Highlights unavailable]
    B --> G[Search unavailable]
    B --> H[Printing unavailable]
Loading

File-Level Changes

Change Details Files
Synchronize the Document Viewer manual across four locales with the latest supported formats and feature behavior.
  • Document OFD support and its unsupported operations, plus clarified XPS capabilities.
  • Update related annotation, search, highlight, and format-support notes to reflect OFD behavior.
  • Apply corresponding terminology and wording updates in Simplified Chinese, Traditional Chinese, Hong Kong Chinese, and English.
assets/deepin-reader/document-viewer/zh_CN/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_CN/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/p_document-viewer.md
assets/deepin-reader/document-viewer/en_US/d_document-viewer.md
assets/deepin-reader/document-viewer/en_US/p_document-viewer.md
Add documentation for reading-state restoration and eye-protection display modes.
  • Describe automatic restoration of page, scroll, zoom, display, rotation, sidebar, and tab state, including recovery after files are moved or renamed.
  • Document the three eye-protection presets and clarify that they affect only the reading view and not document content or printing.
  • Add eye-protection links to the main-menu descriptions.
assets/deepin-reader/document-viewer/zh_CN/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_CN/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/p_document-viewer.md
assets/deepin-reader/document-viewer/en_US/d_document-viewer.md
assets/deepin-reader/document-viewer/en_US/p_document-viewer.md
Expand printing guidance with regular-printing structure and File Manager batch printing behavior.
  • Separate regular printing from batch printing instructions.
  • Document supported batch-print formats, direct CUPS submission, default print parameters, independent task queuing, and system notification feedback.
  • Add or restore locale-specific printer illustrations where applicable.
assets/deepin-reader/document-viewer/zh_CN/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_CN/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/p_document-viewer.md
assets/deepin-reader/document-viewer/en_US/d_document-viewer.md
assets/deepin-reader/document-viewer/en_US/p_document-viewer.md
Remove obsolete per-locale index manuals now that the d_/p_ documents contain the complete content.
  • Delete the legacy document-viewer.md index file for each supported locale.
  • Retain the d_document-viewer.md and p_document-viewer.md resources as the active manual content.
assets/deepin-reader/document-viewer/zh_CN/document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/document-viewer.md
assets/deepin-reader/document-viewer/en_US/document-viewer.md
Clean up outdated manual content and minor formatting or wording inconsistencies.
  • Remove the obsolete shortcut-key screenshot.
  • Fix shortcut spacing, punctuation, numbering, and other small editorial issues.
  • Update locale-specific wording and format references without changing application code or shared assets.
assets/deepin-reader/document-viewer/zh_CN/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_CN/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_HK/p_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/d_document-viewer.md
assets/deepin-reader/document-viewer/zh_TW/p_document-viewer.md
assets/deepin-reader/document-viewer/en_US/d_document-viewer.md
assets/deepin-reader/document-viewer/en_US/p_document-viewer.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@deepin-bot

deepin-bot Bot commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

This pr cannot be merged! (status: blocked)

Update deepin-manual help documents with OFD format support, reading
position restore, and batch print sections. Drop legacy index files
superseded by the new d_/p_ document format.

更新帮助文档:新增OFD格式支持、恢复阅读位置、批量打印等章节,
删除被新版d_/p_文档格式取代的旧索引文件。

Log: 更新帮助文档
Influence: 帮助手册展示新版功能说明(OFD/恢复阅读位置/批量打印),旧索引文件不再打包。
@add-uos
add-uos force-pushed the docs/manual-update branch from 64bf925 to 05f8c48 Compare October 13, 2026 12:27
@add-uos

add-uos commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

/merge

@deepin-bot
deepin-bot Bot merged commit 439f73c into linuxdeepin:master Oct 13, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants