插件系统
ReadAware 插件整合了桌面宿主所暴露的能力。它们可以处理书籍、阅读状态、注记、对话与记忆;新增动作与提供者;并使用受限的宿主服务。
本参考文件依循开发源码。在建立或发布前,请比对能力需求与您安装的应用版本。
选择能力家族
| 家族 | 用途 | 示例 |
|---|---|---|
| 领域(Domains) | ReadAware 所拥有的数据与行为 | 书库、阅读、注记、对话、设置、记忆 |
| 贡献(Contributions) | 新的动作、选项或提供者实作 | 指令、情境动作、语音、内容来源、助理工具、主题 |
| 服务(Services) | 宿主作业与插件专属设施 | 资源、网络、推论、存储、调度、工作、事务 |
| 结构描述(Schemas) | 宿主呈现或解读的数据 | 视图、设置表单、主题 |
使用能力探索器搜索实际方法、了解边界,并建立清单。API 参考文件说明家族如何组合。
从用户的任务出发
- 寻找与导航: 使用书库来源搜索与范围读取,再搭配目前工作阶段保护机制进行阅读导航。
- 收集与查看注记: 查询或观察注记;条件式变更可保留较新的编辑。
- 处理阅读记忆: 使用记忆查询与授权指令处理记忆、分类、设置档、实体、图谱与情境包。
- 辅助对话: 读取授权的对话纪录与摘要,提出回合内容供宿主核准,或注册助理工具。
- 自动化工作流程: 结合调度、限定范围的变更游标、支持的持久化工作与本机事务。
- 引入外部内容: 使用以来源为范围的网络访问、内容提供者与密封资源,而非文件系统或浏览器的逃逸管道。
权限、版本与对象授权
以下是分开的检查:
requires声明兼容的能力版本。permissions、settingsAccess与networkAccess声明授权范围。- 用户的书籍授权将执行者限制为全部书籍、目前书籍或指定书籍。
- 生命周期与目前执行环境条件决定特定操作目前是否可用。
无权限的服务仍可能因特定方法而需要另一个领域授权。成功的可用性查询仅是提示,并非绕过执行检查的许可。
宿主呈现的界面
插件返回结构化视图与回调。ReadAware 负责呈现、焦点、导航、加载与错误状态、主题与清理。视图可包含清单、表单、详细版面与受限区块,并透过公开的视图接口约定提供即时更新。
插件不得挂载 React、任意 HTML、CSS、iframe 或 DOM。如需新的 UI 行为,请使用受支持的贡献点。
隔离与生命周期
每个插件在模块 Worker 中执行。它不会直接取得 Tauri、SQLite、文件系统、程序或 DOM 的访问权。网络与存储使用由宿主中介的环境。
启动阶段会注册项目并允许受支持的读取;商业写入与外部副作用从启用的处理器开始。私有数据迁移仅以存储权限执行。候选版本取代目前执行环境之前,失败的启动或迁移会先复原。
当新版本所请求的权限不超过用户已批准的范围——包括权限、设置访问和网络来源——插件市场的插件会自动更新;超出部分则需征得同意。从文件夹或 zip 安装的插件绝不会被插件市场的条目替换。
安装仍是软体信任的决策。请审查包源码、请求的授权范围、网络目的地与数据处理方式。
从第一方插件学习
源码树包含可运作的示例,例如 Jumper、Dictionary 与 Sentence Reader,以及随附的插件。源码示例不保证每个包都会随每个版本发布。