ReadViewSDK/Doc/index.md

2.5 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/30 文件) EPUB 解析全流程ZIP→container.xml→OPF→spine/TOC、阅读会话状态机、离屏分页测量、ss-reader:// 资源协议、JS 桥接6 种消息、WebView 渲染管线、缓存策略
EPUBTextRendering_功能实现逻辑.md Sources/RDReaderView/EPUBTextRendering/9 文件) 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 全生命周期、三条渲染路径分发、配置变更检测与响应、工具栏/目录/高亮/搜索/设置面板交互流、阅读位置持久化、主题管理

方案讨论文档

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

目录约定

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