4.3 KiB
4.3 KiB
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/(30 文件) |
EPUB 解析全流程(ZIP→container.xml→OPF→spine/TOC)、阅读会话状态机、离屏分页测量、ss-reader:// 资源协议、JS 桥接(6 种消息)、WebView 渲染管线、缓存策略 |
| EPUBTextRendering_功能实现逻辑.md | Sources/RDReaderView/EPUBTextRendering/(6 文件) |
DTCoreText HTML→NSAttributedString 渲染管线、片段标记注入/提取、CoreText 字符范围分页算法、Location↔PageNumber 双向转换、全文搜索引擎 |
| RDReaderView_功能实现逻辑.md | Sources/RDReaderView/ 根目录(6 文件) |
四种显示模式(pageCurl/horizontalScroll/verticalScroll/horizontalCoverScroll)、DataSource/Delegate 协议、点击三区域翻页、工具栏动画、双页配对与哨兵页、横竖屏适配、RTL 支持 |
| EPUBUI_功能实现逻辑.md | Sources/RDReaderView/EPUBUI/(16 文件) |
RDEPUBReaderController 全生命周期、三条渲染路径分发、配置变更检测与响应、工具栏/目录/高亮/搜索/设置面板交互流、阅读位置持久化、主题管理 |
方案讨论文档
| 文档 | 说明 |
|---|---|
| TopToolView接管导航栏.md | TopToolView 接管系统导航栏 + 工具栏 Auto Layout 布局修复方案 |
| RDEPUBReaderTopToolView返回按钮误隐藏工具栏问题讨论.md | 返回按钮点击被误判为阅读区域点击,导致工具栏隐藏的问题分析与修复建议 |
| 增加批注功能方案讨论.md | 基于现有高亮能力演进出完整批注创建、管理与定位链路的方案讨论 |
| 标注功能两套渲染链路实施方案.md | 拆解 WebView 与 DTCoreText 两条正文链路如何统一实现高亮、划线与批注能力 |
| 文本选中菜单定制方案讨论.md | 基于当前 UITextView 选区实现,定制“拷贝 / 高亮 / 批注”菜单并移除系统无关项的方案讨论 |
| 批注和高亮功能详细需求文档.md | 整合标注链路与文本菜单定制后的完整需求文档,统一定义高亮、划线、批注与菜单行为 |
| 横竖屏切换支持方案讨论.md | 讨论 EPUB 阅读器横竖屏切换后的重分页、阅读位置恢复、双页布局与视口变化统一处理方案 |
| 自动化测试方案讨论.md | 讨论 EPUB 阅读器自动化测试体系的分层建设方式,覆盖测试 target、样书夹具、XCTest 与 XCUITest 的实施边界 |
| 样书基线验证方案讨论.md | 讨论四本固定 EPUB 样书的基线验证机制,包含样书矩阵、验证流程和可复用的基线表模板 |
| 书签能力方案讨论.md | 讨论 EPUB 阅读器轻量书签能力的设计方案,覆盖独立模型、持久化、入口 UI、列表管理与位置恢复策略 |
目录约定
Doc/:项目级文档(架构、规范、维护指南、模块实现逻辑)Doc/FeatureSolution/:方案讨论文档(由discuss-sdk-feature-solutionskill 生成)