[!example] 插件名片
- 插件名称:Note Definitions
- 插件作者:Dominic Let
- 插件版本:0.28.3
- 插件概述:
Note Definitions
插件通过创建专门的定义文件夹(definitions folder)
并在其中创建使用特殊语法写成的定义笔记
(definition files),在无需反复使用[[]]
双链语法,不污染文本的情况下,自动监测整个OB库中包含的定义笔记
中所定义的术语
并为其添加下划虚线以突出显示,鼠标点击或停留在术语
上方便可显示悬浮窗口以便参看定义,类似思源笔记
的虚拟引用效果,非常适合用来制作文献笔记的术语表、文学作品的人物表或个人词典的略语表(e.g.,v.
名
etc.),并且在一定程度上为用户提供了发现潜在链接的机会。- 插件项目地址:点我跳转
- 国内下载地址:下载安装
基本用法
flowchart LR
A --> B
B --> C
C --> D
A["在OB库中新建文件夹(实测不必置于根目录),在其右键菜单中执行“Set definitions folder”命令<br>将该文件夹设定为定义文件夹,也可在插件设置界面指定路径"]
B["在定义文件夹中新建的笔记文件将被视作定义笔记,可自定义命名"]
C["可以在命令面板中执行“Add definition”命令并在图形化界面中进行编辑<br>也可以根据语法直接在编辑器中写定义(具体语法见下文)"]
D["一旦成功为术语添加定义,同库中的对应术语将会显示为下划虚线的结构<br>将鼠标移至术语上方,则可在悬浮窗口中查看其定义(可在选项中设置鼠标是在停留还是单击时显示悬浮窗口)<br>也可在命令面板中执行“Preview definition”命令来显示悬浮窗"]
目前定义笔记
分consolidated
和atomic
两种类型,需要在文档属性中赋值加以指定,如未赋值则默认为consolidated
类型,但由于未来的更新可能会改变这一规则,故建议为每一个定义笔记
指定类型,既可通过命令面板中的Register consolidated definition type
或Register atomic definition type
来快捷赋值,也可直接在文档属性中赋值:
---
def-type: consolidated 或 atomic(属性名称默认为def-type,可自定义)
---
consolidated类型定义笔记的语法规则
consolidated
类型的定义笔记
可以容纳复数项定义,适合作为文献笔记的术语表、文学作品的人物表或个人词典的略语表这样单个术语
的定义
较短且相互间有较为紧密关系的情况
定义块(definition block)
是其基本组成部分,由术语
、别名
(可选)、定义
和分隔符
构成,必须按照如前顺序排列,彼此之间需要空一行。
术语
是被定义的对象,格式为# 术语
,即Markdown的标题语法,术语
可以是多个单词组成的句子。术语
下另起一行可以添加别名
,格式为*别名*
,即Markdown的斜体语法,别名
并不是必须的,一个术语
可以有多个别名
,别名
和别名
之间用英文逗号隔开术语
和别名
下方直到下一个术语
的语句被视为定义
,支持Markdown语法,可以跨越多行,由分隔符---
或___
来标记其结束的位置- 示例:
# 诸葛亮
*孔明*,*丞相*,*卧龙*
三国时期 政治家、军事家
---
atomic类型定义笔记的语法规则
atomic
类型的定义笔记
仅可包含单个术语
,适合定义
内容较多较长的术语
,或可配合个人的维基知识库使用
- 笔记名即是被定义的
术语
别名
在文档属性中用aliases
指f赋值:
---
aliases:
- 别名1
- 别名2
---
- 笔记正文即是
术语
的定义
,与其他OB笔记的写法无异,自由发挥即可
指定特定定义笔记
一篇笔记可以指定一篇或多篇特定的定义笔记
,该篇笔记将只匹配对应定义笔记
中的术语,以免受到其他定义笔记
中同字不同意的术语
的干扰,用户既可以在命令面板中执行Add definition context
命令并选择所需的定义笔记
,也可以直接在笔记的文档属性中赋值来实现这一效果:
---
def-context:
- definitions/定义笔记1.md
- definitions/定义笔记2.md
---
设置说明
Enable in reading view
:如启用,则在阅读模式
中也会对术语
进行渲染Enable spell check for defined words
:如启用,则拼写检查同样会对术语
生效Definitions folder
:在空白栏中填入特定路径,将其指定为定义文件夹
Definition file format setting
:在弹窗中选择分隔符样式,可以是---
或___
、Default definition file type
:可设置默认的定义笔记
类型Automatically detect plurals--English only
:如启用,则会自动监测英语术语
的复数形式并渲染它们,举例来说,如将os
指定为后缀,则ios
和ioses
将被视为同一术语的略语
Definition popover settings
Definition popover display event
:在下拉栏中选择是由鼠标Hover(悬浮)
或Click(点击)
来触发悬浮窗口Definition popover dismiss event
:在下拉栏中选择是由鼠标Mouse exit(移开)
或Click(点击)
来关闭悬浮窗口Display aliases
:如启用,则如启用,则术语
的别名
会显示在悬浮窗口中Display defintion source file
:如启用,则定义笔记
的笔记名会显示在悬浮窗口右下角Custom popover size
:如启用,则可Popover width (px)
:自定义悬浮窗口的宽度(单位:px)Popover height (px)
:自定义悬浮窗口的高度(单位:px)
Enable definition links
:如启用,则可点击悬浮窗口中的定义
跳转到定义笔记
Background colour
:自定义悬浮窗口的背景颜色