Obsidian 插件：Annotator

概述

Obsidian 中阅读和注释 PDF 和 EPUB 的插件。

Readme(翻译）

下面是 obsidian-annotator 插件的自述翻译

Obsidian 注释工具

这是 Obsidian（https://obsidian.md）的一个插件。它允许您打开和注释 PDF 和 EPUB 文件。

该插件基于https://web.hypothes.is/，但修改为将注释存储在本地的 markdown 文件中，而不是在互联网上。

演示

警告！ 在上面的 gif 中，我使用了Dataview语法来指定注释目标。

如果您没有安装 dataview 插件，您必须在frontmatter中编写注释目标，如下所示：

---
annotation-target: https://arxiv.org/pdf/2104.13478.pdf
---

已知问题

1. 插件在 iOS 16.3 或更高版本上无法工作。请关注 #289 问题的最新状态。
2. 阅读器无法显示在不同平台上更改的批注。

入门指南

在 Obsidian 笔记的 frontmatter 中添加属性 annotation-target，其值对应 EPUB/PDF 文件的位置。

位置可以是 vault 中的文件（例如 Pdfs/mypdf.pdf），也可以是在线文件（例如 https://arxiv.org/pdf/2104.13478.pdf）。

然后，在打开的笔记窗格中，选择“更多选项”（右上角的三个点），应该会出现一个新选项“annotate”。

插件会自动尝试根据文件路径确定文件是 epub 还是 pdf，但如果这种方法不起作用，

您还可以添加属性 annotation-target-type 并手动指定是 epub 还是 pdf。

如果您已经安装了 dataview，那么您还可以使用 dataview 属性指定注释目标。在这种情况下，可以使用 Obsidian 样式链接而不是纯文本路径。

注释

注释是自解释的。选择文本以开始注释。

将来，添加彩色高亮和图像/区域高亮将是很好的功能。然而，这些功能首先必须添加到 hypothes.is 中。

请参阅以下相关问题：https://github.com/hypothesis/product-backlog/issues/198，https://github.com/hypothesis/product-backlog/issues/669

Markdown 中的注释

要返回到常规的 Obsidian Markdown 编辑模式，可以选择 更多选项→以MD格式打开。

每个注释都有一个关联的引用块和一个块引用。在修改这些块时要小心。

对 PREFIX、HIGHLIGHT 和 POSTFIX 进行小的编辑通常是可以的。但如果编辑过于重大，假设可能无法再识别相应的文本。

COMMENT 区域可以自由编辑。（但要确保它仍然是引用块的一部分。）

TAGS 区域应该由逗号分隔的 Obsidian 标签列表组成。（例如 #tag1, #tag2, #tag3）

暗黑模式

该插件内置了暗黑模式支持。在进行注释时，可以选择 更多选项 → 切换暗黑模式 来切换暗黑模式。

您还可以在插件的设置选项卡中调整暗黑模式的行为。

链接到注释

点击一个对注释块引用的黑曜石链接时，将会打开相应的文件并滚动到相关的高亮部分。

如果文件已经在一个窗格中打开，则链接将导致现有窗格滚动。

贡献

访问 CONTRIBUTING.md 获取有关从源代码构建或贡献改进的信息。要报告错误、提问或建议改进此插件，您可以创建一个 问题。

更新日志

0.2.10 (2023-01-09)

• 修复了 iOS 上插件无法启动的错误 #284

0.2.9 (2023-01-05)

• 点击 Markdown 中的注释链接会立即跳转到 PDF 中的注释（感谢@HardwayLinka）
• 修复因换行导致的拖放链接到高亮的错误（参见问题＃267，感谢@HardwayLinka）

0.2.8 (2022-11-27)

• 修复了“注释”按钮不显示的问题（请参见问题＃253）
• 修复了点击注释链接后滚动条卡住的问题（请参见 PR＃259，感谢@HardwayLinka 的贡献）
• 部分修复了注释链接不起作用的问题（请参见 PR＃231，感谢@XSAM 的贡献）

0.2.7（2022 年 10 月 31 日）

• 修复了注释中 LaTeX 公式无法渲染的问题（请参见问题＃228）
• 删除了“登录/注册”按钮（请参见问题＃241）
• 现在可以使用 CSS 代码片段来样式化 hypothesis 侧边栏

0.2.6 (2022-08-19)

• 修复了 0.2.5 版本引入的错误#208，由于插件的原因，无法打开内部链接
• 内部更改
  • 使用 dataview 包与 dataview 插件进行通信

0.2.5（2022-08-14）

• 将“注释”、“切换暗模式”、“以 Markdown 格式打开”按钮移到选项菜单顶部
• 视频注释
  • 修复 视频未找到错误
  • 暂时禁用移动设备上的视频注释
• 内部更改
  • CodeMirror 更新至 v6
  • obsidian-api 更新至 0.15.9
  • 使用严格类型设置安装了 betterer，以使插件在未来更稳定可靠

0.2.4（2022 年 7 月 23 日）

• 修复 插件在iPad上无法启动的问题

0.2.2（2022-05-14）小改进

• hypothes.is 更新至 v1.1055.0

0.2.1 (2022-03-06) BRAT 发布 基本的网络和视频注释

• annotation-target-type 现在可以取值 web 和 video。
  • 使用 web，注释目标理论上可以是任何网站。有些网站效果更好。链接导航不起作用。
  • 使用 video，仅支持 YouTube 链接。为了使用此功能，必须在插件设置中提供指向 annotator.tv 资源的 zip 文件链接。它不能与插件捆绑在一起，因为那很可能会侵犯版权。
    • 您可以向某人索取链接，或者通过在 annotate.tv 上创建帐户，登录，转到https://annotate.tv/videos/620d5a42b9ab630009bf3e31#，并使用 Save All Resources Chrome 扩展程序下载网站，将其上传到 Google Drive，并 生成直接链接。
  • 其他改进：
    • 进行了一些幕后更改，以便将来更容易升级 hypothes.is 版本。

0.2.0 (2022-01-26) BRAT 发布 改进的 Markdown 渲染，epub 阅读器

• 现在，假设边栏中的 Markdown 应该完全支持常规的 Obsidian 语法（包括链接、嵌入、自定义代码块等）。
• 几个 Epub 改进，感谢@aladmit！
  • 添加了字体大小缩放的新选项（请参见 PR＃127）
  • 添加了新的“epub 阅读器模式”设置。现在支持无限滚动！（请参见 PR＃114）
  • 减少页面填充，以便使用最大可用空间。（请参见 PR＃126）

0.1.9（2022 年 1 月 17 日）小修复

• 再次删除 Sentry 日志记录（请参见问题＃97）

0.1.8 (2022-01-16) 小修复，添加了默认注释模式设置

• 修复了启动时窗格加载的问题
• 修复了一些 EPUB 高亮显示的问题
• 添加了选择默认注释模式的设置，感谢 @aladmit 提供的 PR！（请参见 PR #113）

0.1.7 (2022-01-14) BRAT 发布 支持中文文件名

• 修复了中文文件名的问题，详见问题＃53

0.1.6 (2022-01-12) BRAT 发布 修复实时预览拖放问题 + 支持中文字符

• 现在实时预览中的拖放应该可以正常工作（参见问题＃103）
• 升级 pdf.js 到较新版本。
  • 改进字符支持（现在应该支持日文和中文字符）（参见问题＃53）
• 删除了 Sentry 日志记录（参见问题＃97）

0.1.5（2021 年 12 月 19 日）快速修复

• 显然，之前的更新破坏了一些人的旧注释（参见问题＃95）。这个版本希望修复这个问题。

0.1.4（2021 年 12 月 18 日）修复 iPad 与 Windows/Android 兼容性问题。

• 参见问题＃70，感谢@jonasmerlin 的修复！

0.1.3 (2021-09-12) 桌面版基本 CORS 支持

• 添加了一个基本的 CORS 问题解决方法。这应该使更多的链接可以查看。（参见问题＃15）
  • 请注意，这个解决方法只适用于 Obsidian 的桌面版。

0.1.2 (2021-09-11) 快速修复

• 修复了一个严重的错误，导致无法保存任何注释。（参见问题＃61）

0.1.1 (2021-09-10) 拖放修复，在新窗格中打开链接，多行注释修复

• 改进了拖放功能。现在在插件卸载时会卸载拖放处理程序。希望解决了与其他拖放功能干扰的问题。（参见问题＃50）
• 现在使用数组格式的注释目标应该可以正常工作。这提高了与 MetaEdit 的兼容性。（参见问题＃51）
• 按住ctrl并点击链接（或使用鼠标滚轮点击）现在会在新窗格中打开注释。（参见问题＃54）
• 解决了多行注释的问题。（参见问题＃47）
• 添加了一个新命令（切换注释/Markdown模式）。可以在 Obsidian 中将其绑定到热键上，以便更高效地在两种模式之间切换。（参见问题＃39）
• 其他事项
  • 还添加了一个基本的注释加载单元测试。随着问题的出现，将添加更多的测试。这将确保插件随着时间的推移变得越来越稳定。

0.1.0 (2021-09-03) 添加了注释高亮拖放功能

• 现在，通过按住shift键，您可以将 epub/pdf 中的高亮拖放到单独的 Obsidian 笔记中，并插入一个指向该高亮的链接。

  

0.0.9（2021-09-03）修复注释 ID 错误的问题

• 请参见＃37

0.0.8 (2021-09-03) 添加了前缀/后缀设置开关，修复了滚动问题，进一步减小了插件的大小。

• 现在插件可以在社区插件列表中找到！
• 现在可以在设置中禁用注释标记的前缀和后缀部分。（参见＃30）
• 单击 PDF 注释链接现在会立即跳转到注释位置，不再出现滚动问题。（参见＃21）
• 添加了可能修复＃28 中提到的内存泄漏问题的解决方案。
• 添加了 core-js。希望这意味着插件可以在较旧版本的 node 上运行（参见＃34）
• 禁用了全局 WebSocket 覆盖。应该解决 Obsidian Sync 的问题（参见＃36）
• 进一步减小了插件的大小
  • React 现在以“生产”模式构建。
  • 所有嵌入资源现在使用最高的 zip 压缩比率。

0.0.7 (2021-09-01) 添加了自定义默认路径设置，修复了页面注释问题，稍微减小了 JSON 的大小等等。

• 添加了一个名为 Custom Default Path 的新设置。详见 此处的评论 获取更多信息。
• 如果注释 JSON 中的顶级值是“不足为奇”的，将会省略它们。详见#24。
• 修复了页面注释导致注释加载失败的问题。
• 为了减少隐私混淆，将“Post to…”按钮始终显示为“Post to Only Me”。
• 进一步减小了插件的大小
  • 从 base64 编码切换到完整的 Unicode 编码
  • 在生成 zip 文件之前进行资源的最小化
  • 在最终的 Rollup 输出中进行最小化
• 小的修复
  • 移除了有关 WebSocket 用户 ID 不匹配的警告
  • 添加了对#13 的可能修复。

0.0.6 (2021-08-30) 支持 file: 协议，修复了各种 URL 问题，提升了隐私保护，进行了一些小修复

• 修复了不再向 hypothes.is 服务器发送初始 http 请求的问题。
• 移除了 Hypothes.is 性能跟踪器。
• 不再从 websocket api 收到错误消息。
• 存储的注释不再引用示例 pdf 的 URL，因为这会让一些用户感到困惑。（参见问题#7）
• 添加了对 file: 协议链接的初始支持。（尚未经过大量测试。）
• 移除了占位符状态栏文本（参见问题#17）

0.0.5 (2021-08-26) 修复了 EPUB 的错误，进行了轻微的文件重组

• 为 EPUB 阅读器所需的文件被 .gitignore 忽略了，在之前的版本中无法正常工作。（参见问题#6）
• 代码文件已移动到 src 目录中，使仓库看起来不那么凌乱。

0.0.4 (2021-08-26) 支持中文文件名

• 增加对中文文件名的支持。（参见问题＃4）

0.0.3 (2021-08-26) 插件大小减小

• 删除了一些不必要的文件以减小插件大小。

0.0.2 (2021-08-26) 小修复

• 移除了日志记录，
• 简化了链接处理
• 查看器高度现在为 100% 而不是固定为 1000px。

0.0.1 (2021-08-25) 首次发布

• 实现了插件的基本功能

许可证

Obsidian Annotator 使用 GNU AGPLv3 许可证。更多信息请参阅 LICENSE。

支持

如果您想支持我和我的工作，您可以在 Github上赞助我（首选方法），或者在 Paypal 上捐赠一些金额。