ReadViewSDK/Doc/index.md
shen c0aac56083 docs: 同步 Doc 文档与当前代码状态
- 更新模块文件数(EPUBCore 31+2, EPUBTextRendering 13, ReaderView 5, EPUBUI 19)
- 更新 Swift 版本(5.10)、iOS 版本(15.0)、行数等基本信息
- 补充新增文件文档(TextAnchor, RenderRequest, WebViewDebug, AssetRepository,
  TextIndexTable, TextPerformanceSampler, ChapterData, PageInteractionController 等)
- 更新 RDEPUBLocation 模型(新增 rangeAnchor 字段)
- 更新 RDEPUBReaderConfiguration(13 项配置)、Delegate 签名、Persistence(8 方法)
- 修正 RDURLReaderController 归属(ReaderView → EPUBUI)
- 移除过时的 LegacyRDReaderController 引用
- 标记 SS→RD 命名迁移为已完成
2026-05-25 20:31:10 +08:00

2.6 KiB
Raw Blame History

ReadViewSDK 文档索引

架构与规范

文档 说明
ARCHITECTURE.md 四层架构总览EPUBCore → EPUBTextRendering → RDReaderView → EPUBUI、数据流、分页模式、位置模型、已知限制
CODING_STYLE.md 命名规范RD/RDEPUB 前缀、分层规则、UI 布局规范、代码风格细则、extension 拆分、SS→RD 迁移计划
EPUB_MAINTENANCE.md 文件职责表、DTCoreText 渲染管线、常见排查场景、推荐日志断点、阅读器后续能力规划

模块功能实现逻辑

文档 对应模块 说明
EPUBCore_功能实现逻辑.md Sources/RDReaderView/EPUBCore/31 Swift + 2 资源) EPUB 解析全流程ZIP→container.xml→OPF→spine/TOC、阅读会话状态机、离屏分页测量、ss-reader:// 资源协议、JS 桥接6 种消息、WebView 渲染管线、文本锚点定位、渲染请求模型、缓存策略
EPUBTextRendering_功能实现逻辑.md Sources/RDReaderView/EPUBTextRendering/13 文件) DTCoreText HTML→NSAttributedString 渲染管线、片段标记注入/提取、CoreText 分页引擎含语义边界调整、文本索引表、Location↔PageNumber 双向转换、分页缓存、性能采样、全文搜索引擎、纯文本构建器
RDReaderView_功能实现逻辑.md Sources/RDReaderView/ReaderView/5 文件) 四种显示模式pageCurl/horizontalScroll/verticalScroll/horizontalCoverScroll、DataSource/Delegate 协议、点击三区域翻页、工具栏动画、双页配对与哨兵页、横竖屏适配、RTL 支持
EPUBUI_功能实现逻辑.md Sources/RDReaderView/EPUBUI/19 文件) RDEPUBReaderController 全生命周期、三条渲染路径分发、配置变更检测与响应、工具栏/目录/高亮/书签/搜索/设置面板交互流、阅读位置持久化、主题管理、CoreText 页面交互

方案讨论文档

文档 说明
ReflowableEPUB_WXReadRenderer_Design.md 基于读书反编译的 CoreText 渲染架构,设计 Reflowable EPUB 的增强文本渲染方案CSS 分层、类型器升级)

目录约定

  • Doc/:项目级文档(架构、规范、维护指南、模块实现逻辑)
  • Doc/FeatureSolution/:方案讨论文档(由 discuss-sdk-feature-solution skill 生成)