Obsidian 插件:Abbreviations and Acronyms 单篇笔记的术语助手

[!example] 插件名片

  • 插件作者:dragonish
  • 插件版本:1.7.0
  • 插件概述:Abbreviations and Acronyms插件会根据文档属性(Properties)中特定属性名称属性值中的定义,或正文中用Markdown扩展语法写成的定义,自动监测当前笔记中的缩略语并为其渲染下划虚线,鼠标悬停在上方时还会显示其定义,有助于在无需借助md语法的情况下突出显示笔记内的术语,避免文本连贯性遭到标记符号的污染,并辅助记忆术语所指。
  • 从个人经验出发,本插件适合用在术语不具有笔记库全局性的某篇文献的阅读笔记中。举例来说,我本人并非医学生,只是出于个人保健需要阅读中国高血脂防治指南,那么就可以用这个插件来进行读书笔记的术语工作,而不像note definitions插件那样需要单独增加一个笔记文件,在用OB进行简单的翻译工作时也可用此插件来进行术语一致性工作。
  • 插件项目地址:点我跳转
  • 国内下载地址:下载安装

术语解说

  • Abbreviation(缩写)本身指的是在使用拼音文字的语言中,对于常用词组(多为专有名词)及少数常用词所采用的简便写法,如以 cm 指代 centimeter,No. 指代 numerō 或 UN 指代 the United Nations等情况,缩写后所得到的词称为缩略语[1]类似于汉语中的简称,如“四化”指代“四个现代化”。
  • Acronym(首字母缩略词)常见于英语和法语,它指的是那些以词的形式发音,而非逐字母拼读的缩略语,如以 NATO 指代 North Atlantic Treaty Organization(北约),或是法语中以 UNESCO 指代 Organisation des Nations unies pour l’éducation, la science et la culture(联合国教科文组织)。
  • 此外还存在所谓的Initialism,即逐字母拼读的缩略语,如以BBC指代British Broadcasting Corporation(英国广播公司)或以NBA指代National Basketball Association(美国职业篮球联赛)。事实上,不同词典对InitialismAcronym的区分并不统一,有的词典会将二者归为一类,在本插件中就没分得那么细。
  • 在了解了基本概念之后,需要明确的是,本插件只是借用了词汇学中的术语,实际上,这里的“Acronym”完全可以不是缩略语,而是一个完整的词语(但中间不能有空格)。定义的后半部分也完全可以不是单个术语而是长句解释。下文用缩略语指代定义中的前半部分仅仅是出于简洁需要。

基本用法

在设置中指定某个属性名称为存放定义的位置,然后为其赋值,Abbreviations and Acronyms插件就会自动监测笔记中的缩略语,并为它们添加下划虚线。以下语法仅作举例,在实际操作中都可以通过命令面板执行相关命令进行快速填写

你既可以用字符串写定义,在这种情况下,如果OB系统设置→编辑器→文档属性选择显示源码,可以在阅读模式的正文中直接编辑或删除定义

---
abbr:
  - "HTML: HyperText Markup Language"
  - "CSS: Cascading Style Sheets"
---

也可以用键值对写:

---
abbr:
  - HTML: HyperText Markup Language
  - CSS: Cascading Style Sheets
---

在插件设置中启用Enable Markdown Extra syntax support选项后,你可以在笔记正文中使用Markdown扩展语法在任意位置添加定义,或是执行命令面板中的Abbreviations and Acronyms:Insert extra definition命令将选中的文本转化为缩略语,建议在定义的前后各空一行,一旦添加成功,则直到下一处定义为止,该缩略语都将指向这里所赋予的定义[2]: ^81a69e

*[W3C]: World Wide Web Consortium

如果你想将下文中的缩略语转为普通文本,使其不再指向特定术语,只需在冒号后留空,什么也不填:

*[W3C]: 

如此一来,即便在同一篇笔记存在使用相同缩略语文本的不同术语,也可根据需要随时调整缩略语所指代的术语,例:

---
abbr:
  - RAM: Random Access Memory
---

RAM.

*[RAM]: Reliability, Availability, Maintainability

RAM.

*[RAM]: Remote Access Management

RAM.

*[RAM]: 

RAM.

在以上例子中,当鼠标悬浮在正文中的前三个“RAM.”上时,将依次显示“Random Access Memory”、“Reliability, Availability, Maintainability”、“Remote Access Management”字样,而第四个“RAM.”将什么也不显示。
如果你想在编辑模式中为额外语法写成的定义添加一个装饰器, [[#^4c1e29|可在选项中进行设置]]。在插件目录的styles.css文件的--abbreviations-definition-decorator-margin变量中可自行调节装饰器与定义之间的空格距离。

如果你想将文章转移到其他不支持简单语法的Markdown编辑器中,可以执行命令面板Abbreviations and Acronyms:Copy and format content命令一键复制文章内容并将其中的特殊语法转化为通用的语法。

设置说明

  • 元数据关键词:在空白栏处填入的单词将被视为用来存放缩略语属性名称
  • 在源码模式中标记缩略语:如启用,在源码模式缩略语也会被添加下划线
  • 启用非空格分隔语言的缩略语检测:如启用,插件将侦测以中日韩等不以空格分隔词语的语言写成的缩略语,例:
---
abbr:
  - "北大: 北京大学"
---

我是一名北大学子。
  • Markdown extra 语法
    • 启用 Markdown Extra syntax 支持:如启用,则可使用Markdown扩展语法,[[#^81a69e|详见上文]]
    • 启用 Extra 定义装饰器:如启用,在用Markdown扩展语法写成的定义后将会显示一个装饰器 ^4c1e29
    • Extra 定义装饰器不透明度:在本选项中,用户可以调整装饰器文本的透明度
    • Extra 定义装饰器内容:在本选项中,用户可在方框中填入${abbr}${tooltip}两个变量,填入前一个装饰器将显示缩略语,填入后一个将显示缩略语的定义
  • 全局
    • 全局缩略语:点击本选项后的管理缩略语,在弹出的界面中添加缩略语及其定义,可在整个笔记库范围内添加全局缩略语与定义的配对,但它的优先级要低于文档属性中存放的定义。如果你不想在某篇特定笔记中采用这一全局缩略语,则可以在文档属性中以空字符串或键值对声明:
---
abbr:
  - "HTML: " # 字符串
  - CSS: ""  # 键值对
---
  • 全局文件:在下拉栏中选取特定笔记文件,它将被视为存放全局缩略语的笔记文件
  • 后缀
    • 启用后缀检测:启用本选项后,则插件会自动侦测文中带有指定后缀的缩略语,并为它们也添加下划线,举例来说,如将os指定为后缀,则iosioses将被视为同一术语的缩略语
    • 后缀列表:在空白栏处填入的单词将被视为后缀,不同后缀之间以英文输入法逗号隔开

  1. 缩写 - 维基百科,自由的百科全书 ↩︎

  2. PHP Markdown Extra ↩︎