Obsidian Annotator 插件使用备忘录
Obsidian Annotator
黑曜石注释器
这是 Obsidian (https://obsidian.md) 的插件。它允许您打开和注释 PDF 和 EPUB 文件。
该插件基于 https://web.hypothes.is/,但经过修改后将注释存储在本地 markdown 文件中,而不是存储在 Internet 上。
Demonstration
示范
警告! 在上面的 gif 中,我使用 Dataview 语法来指定 annotation-target。如果你没有安装 dataview 插件,则必须在 frontmatter 中编写 annotation-target,如下所示:
1 | --- |
Getting Started
开始
将属性 annotation-target
添加到黑曜石便笺的 frontmatter
中,其值对应于 EPUB/PDF 文件的位置。该位置可以是 Vault 中的文件(如
Pdf/mypdf.pdf
),也可以是联机文件(如
https://arxiv.org/pdf/2104.13478.pdf
)
然后,您可以在打开的注释窗格中,选择 “more options”(右上角的三个点),并且应该有一个新选项 “annotate” 可用。
该插件会自动尝试根据文件路径确定文件是 epub
还是
pdf
,但如果这不起作用,您还可以添加属性
annotation-target-type
并手动指定它是 epub
还是 pdf
。
如果您安装了 dataview,则还可以使用 dataview 属性指定注释目标。在这种情况下,可以使用 obsidian 样式的链接来代替纯文本路径。
WARNING! Don't rename an original pdf or epub file! The plugin is going to lose the connection between annotations and file in that case.
警告!不要重命名原始 PDF 或 epub 文件!在这种情况下,插件将失去 annotation 和 file 之间的连接。
Annotating
注释 Annotation is self-explanatory. Select text with your mouse to
get started.
注释是不言自明的。用鼠标选择文本以开始使用。
In the future, it would be nice to add colored highlights and
image/region highlights. These features will have to be added to
hypothes.is first, however. See these relevant issues: hypothesis/product-backlog#198,
hypothesis/product-backlog#669
将来,添加彩色高光和图像/区域高光会很好。但是,必须先将这些功能添加到
hypothes.is 中。请参阅以下相关问题: hypothesis/product-backlog#198
, hypothesis/product-backlog#669
The annotations in markdown
markdown 中的注解
To return to the regular obsidian markdown editing mode, you can
select more options
→ Open as MD
. Each
annotation has an associated quote block with a block reference. Be
careful with modifying these blocks. Minor edits to PREFIX, HIGHLIGHT,
and POSTFIX are typically ok. But if the edits are too major, hypothesis
may no longer be able to identify the corresponding text.
要返回常规的 obsidian markdown 编辑模式,你可以选择
Open as MD
→ 更多选项
。每个注释都有一个带有块引用的关联 quote 块。修改这些块时要小心。对
PREFIX、HIGHLIGHT 和 POSTFIX
进行次要编辑通常是可以的。但是,如果编辑过于严重,假设可能无法再识别相应的文本。
The COMMENT region can be freely edited. (but ensure that it is still
part of the quote block.)
COMMENT 区域可以自由编辑。(但请确保它仍然是 quote 块的一部分。
The TAGS region should consist of a comma-separated list of obsidian
tags. (like #tag1, #tag2, #tag3
)
TAGS 区域应由以逗号分隔的黑曜石标签列表组成。(如
#tag1、#tag2 #tag3
)
Dark Mode
深色模式
The plugin has built-in dark mode support. To toggle dark mode,
select more options
→ Toggle Dark Mode
while
annotating. You can also tweak the dark mode behavior in the settings
tab for the plugin.
该插件具有内置的暗模式支持。要切换深色模式,请在注释时选择更多选项
→ Toggle Dark Mode(切换深色模式
)。您还可以在插件的
settings (设置) 选项卡中调整暗模式行为。
Linking to annotations
链接到注释
An obsidian link to an annotation block-reference will, when clicked,
open the corresponding file and scroll to the associated highlight. If
the file is already open in a pane, then the link will cause the
existing pane to scroll instead.
单击指向注释块引用的黑曜石链接将打开相应的文件并滚动到关联的高亮显示。如果文件已在窗格中打开,则该链接将导致现有窗格滚动。
Contributing
贡献
Visit CONTRIBUTING.md
for information on building from source or contribution improvements. To
report a bug, ask a question or suggest an improvement for this plugin,
you can create an issue.
请访问 CONTRIBUTING.md
以获取有关从源构建或贡献改进的信息。要报告错误、提出问题或建议此插件的改进,您可以创建一个问题
。