SuperAPI AI 工具集

scrivener-annotations

写作与研究

查看项目

更新于 10-15 21:12

技能介绍

用途:帮助写作者处理 Scrivener 的两种边注——评论与脚注。二者仅在角色上不同(边注备注 vs 编译时编号注释),且都各有链接式与内联式两种存储形式。

存储模型:链接式(边注)的正文存放在每文档的 content.comments XML 文件中(含作者与颜色),锚点是 content.rtf 内指向 scrivcmt://<UUID> 的 RTF HYPERLINK 字段,正文与锚点分处两个文件、由 UUID 关联。内联式没有旁文件,内联注释与内联脚注直接以标记范围写入 content.rtf,content.comments 中无内容。

当前可用能力:read <id> 会暴露 constructs 对象,当文档含任意评论或脚注时 constructs.comments_or_footnotes 为 true。命令示例:python3 ${CLAUDE_PLUGIN_ROOT}/tools/scrivener/cli.py read "<uuid-or-title>" --project "<path.scriv>" --format json。该标志只表明存在注释,尚不返回正文、作者或颜色等结构化字段。要提取注释正文,应改用 scrivener-extract 读取 content.comments,不要手工解析 RTF。

规划中功能:comment add|edit|delete|list、footnote add|edit|delete|list、annotation add|delete、note convert --to inline|linked。这些写入与转换命令依赖尚在构建中的保留令牌(token-preserving)RTF 写入层,因此暂不可用。被问及时应说明预期命令、指出尚未进入 CLI,并建议最接近的可用步骤(用 read 确认现状、用 extract 取出正文、用 scrivener-edit 编辑正文文本)。

限制与安全:在写入前需先在 Scrivener 中关闭项目并等待云同步完成;写入会自动备份(zip)并自动快照;docs.checksum 不匹配仅为提示,不应视为损坏;标题不唯一,歧义时用 UUID 定位;绝不可从纯文本重新生成富文本文档,含链接锚点、内联注释、样式、链接、表格或图片的文档必须保留令牌编辑,或先快照并显式传入 --allow-destructive。在写入层就绪前,无法安全完成内联脚注转链接等转换操作。