使用 org-roam 构建自己的知识网络

用 org-roam-find-file/org-roam-capture 新建笔记的时候，会要求我们输入笔记标题，假如我们输入的笔记标题是 "org-roam"，那么会在新建这个笔记后发现这个笔记只在第一行把我们输入的标题写上去了，别的什么都没有：

#+title: org-roam

在实际使用中，我们可能会有不同的笔记需求，比如说：当我为一个专业术语记录笔记时，我想写下这个术语所属的领域以及它的含义；当我记录一个观点时，我会想写上这个观点是谁提出来的、论据是什么、我自己是支持还是反对；当我读一篇深度学习的论文时，我要记录这篇论文的相关工作、要解决的问题、使用了什么方法、进行了怎么样的实验……

这些需求用 org-roam 是能够满足的，因为 org-roam 通过 org-roam-capture-templates 这个变量提供了定制笔记模板的能力。

具体来说，默认的笔记模板是这样的

'(("d" "default" plain (function org-roam-capture--get-point)
   "%?"
   :file-name "%<%Y%m%d%H%M%S>-${slug}"
   :head "#+title: ${title}\n"
   :unnarrowed t))

每个模板都由 8 个部分组成，我这里以上面的默认模板来进行说明

下面对这 8 个模板元素分别说明一下

• 用来选择模板的 key：

  对应默认模板里的 "d"，一个字符的情况下用来直接选择模板，两个字符的情况下用第一个字符表示模板分组、第二个字符用来选择这个分组下的实际模板。

  下面的配置设置了四个模板，其中第二个 ("g" "group") 用来指明一个模板分组，后面的 "ga" 和 "gb" 是这个模板下的子模板。

  (setq org-roam-capture-templates
        '(
          ("d" "default" plain (function org-roam-capture--get-point)
           "%?"
           :file-name "%<%Y%m%d%H%M%S>-${slug}"
           :head "#+title: ${title}\n#+roam_alias:\n\n")
          ("g" "group")
          ("ga" "Group A" plain (function org-roam-capture--get-point)
           "%?"
           :file-name "%<%Y%m%d%H%M%S>-${slug}"
           :head "#+title: ${title}\n#+roam_alias:\n\n")
          ("gb" "Group B" plain (function org-roam-capture--get-point)
           "%?"
           :file-name "%<%Y%m%d%H%M%S>-${slug}"
           :head "#+title: ${title}\n#+roam_alias:\n\n")))
  

  上面的模板生效后，首先在执行 org-roam-find-file 新建笔记时，就会看到一个选择界面，如下图所示：

  

  如果输入 d 会直接打开新建笔记的编辑窗口，如果输入 g 会展开分组模板要求我们再输入一次来选择具体的模板，如下图所示：

  

• 用来描述模板的 description：这个元素就是起到单纯的描述作用，没有功能上的意义
• 用来说明新增内容类型的 type：本来有 plain/entry/item/checkitem/table-line 五种取值，但在 org-roam 中作用都是一样的，建议一律使用 plain
• 用来说明新增内容位置的 target：这一项在 org-roam 中不可更改

• 设置新增内容模板的 template：

  这个元素是整个模板中的核心，其中的内容可以分为两类：

  • 普通的文本，将会原样出现在新增内容中
  • 以 % 开头的特殊标记，如默认模板中的 "%?"，将会在最后根据类型自动扩展成不同的内容

  对于第一类内容没啥可说的，唯一值得一提的是，如果需要模板是多行的文本，需要在模板中用 "\n" 来指明要换行，如模板内容 "第一行\n第二行" 最后就会在笔记中显示为：

  第一行
  第二行
  

  这里说一下以 % 开头的特殊标记，由于这块内容很多，这里只列举一些常用的供读者参考：

  标记	描述
  %<…>	自定义格式的时间戳，如: %<%Y-%m-%d>，会得到 <2018-03-04 日>
  %t	当前日期，展开后的格式固定为 <2018-03-04 日> 这样
  %T	当前日期和时间，展开后的格式固定为 <2018-03-04 日 19:26> 这样
  %u	当前日期，展开后的格式固定为 [2018-03-04 日] 这样
  %U	当前日期和时间，展开后的格式固定为 [2018-03-04 日 19:26] 这样
  %prompt	用 prompt 作为提示要求我们输入并填充在这个模板元素所在的位置
  %?	其他所有特殊标记填充完毕后，光标将停留在这个元素的位置等待我们编辑

• 指定新增笔记文件名的 file-name：

  org-roam 中新建笔记一般都是以一个新文件的形式来创建的，支持用 file-name 来设置这个新文件的文件名，默认模板中的这块设置为 "%<%Y%m%d%H%M%S>-${slug}"，分为两部分

  • %<%Y%m%d%H%M%S> ：参考上一节 template 部分的特殊标记
  • ${slug} ：将笔记标题文字做处理后得到的文本，这些处理包括大写字母转小写、去除一些特殊字符等

  这块建议使用默认模板就好。

• 设置新增笔记初始内容的 head：

  这个设置用来在新建笔记文件时设置初始内容，只会执行一次，也就是说之后如果使用 org-roam-capture 新增内容到已有笔记中时，这个设置的内容是不会再写入到文件中的。

  默认模板这块的内容是 "#+title: ${title}\n"，只设置了笔记文件的标题，建议改为如下内容：

  :head "#+title: ${title}\n#+roam_alias: \n#+roam_tags: \n"
  

  这样设置后新建笔记文件的初始内容将会是：

  #+title: 示例标题
  #+roam_alias:
  #+roam_tags:
  

  "#+roam_alias" 可以给这条笔记设置别名，这样在其他笔记中引用的时候会更方便；"#+roam_tags" 可以用来为这条笔记添加标签，使得在用 org-roam-find-file 查找已有笔记时能根据 tag 来进行过滤。

• 设置新增内容其他属性的 properties：

  这些属性用于对新建笔记内容的行为做一些额外的控制，列举几个常用的：

  • :unnarrowed t: org-roam 推荐的设置，表示现实整个笔记文件，如果不加这个设置，用 org-roam-capture 增加内容到已有笔记文件中时，仅会显示当前我们输入的内容，而不会显示这个笔记文件中已有的内容
  • :empty-lines 1: 在新增的笔记内容前后加一个空行，使用 org-roam-capture 增加内容到已有笔记文件中时比较有用

org-roam 的笔记模板是利用 org-capture 实现的，上述模板元素中 file-name 和 head 是 org-roam 在 org-capture 模板的基础上增加的新元素；其他六个部分，target 在 org-roam 中不可更改，key、description、type 和 template 的更详细说明可以参考我之前写的一篇介绍 org-capture 文章中的相关内容，capture 模板的五个部分。

为了能更直观地理解模板的工作机制，这里给几个模板的示例：

• 用于记录专业术语的模板

  (add-to-list 'org-roam-capture-templates
               '("t" "Term" plain (function org-roam-capture--get-point)
                 "- 领域: %^{术语所属领域}\n- 释义:"
                 :file-name "%<%Y%m%d%H%M%S>-${slug}"
                 :head "#+title: ${title}\n#+roam_alias:\n#+roam_tags: \n\n"
                 :unnarrowed t
                 ))
  

  将上面的配置拷贝到你的 Emacs 配置中，并置于所有 org-roam 相关配置的后面，就可以在你的 org-roam 中使用这个模板，后面的示例模板也是一样，但要注意不同模板的 key 不要有冲突。

  

• 用于记录论文笔记的模板

  (add-to-list 'org-roam-capture-templates
               '("p" "Paper Note" plain (function org-roam-capture--get-point)
                 "* 相关工作\n\n%?\n* 观点\n\n* 模型和方法\n\n* 实验\n\n* 结论\n"
                 :file-name "%<%Y%m%d%H%M%S>-${slug}"
                 :head "#+title: ${title}\n#+roam_alias:\n#+roam_tags: \n\n"
                 :unnarrowed t
                 ))
  

  

另外，org-roam-insert-immediate 不使用 org-roam-capture-templates，而是使用一个专门的 org-roam-capture-immediate-template 来设置新建内容的模板，且只能有一个模板，所以设置这个模板的配置是这样的（以默认配置为例）

(setq org-roam-capture-immediate-template
      '("d" "default" plain (function org-roam-capture--get-point)
        "%?"
        :file-name "%<%Y%m%d%H%M%S>-${slug}"
        :head "#+title: ${title}\n"
        :unnarrowed t))

这部分内容需要 org-protocol，后续内容是在 org-protocol 已经设置好的基础上展开的，如果 org-protocol 设置存在问题，请查阅文档，或这评论区留言来讨论。

利用 org-protocol 这样的外部程序和 Emacs 进行通信的机制，我们可以使用 javascript 来抓取网页上的信息发送到 Emacs 中，而 org-roam 也支持了这种机制。在 org-roam 中可以通过 org-roam-capture-ref-templates 来设置网页捕获相关的模板，默认的设置是这样的：

(setq org-roam-capture-ref-templates
      '(("r" "ref" plain (function org-roam-capture--get-point)
         ""
         :file-name "${slug}"
         :head "#+title: ${title}\n#+roam_key: ${ref}\n"
         :unnarrowed t)))

可以看到，模板本身和前面的笔记模板是一样的，没有什么特别。但我们可以创建一个小书签，来利用这个模板，抓取网页标题和链接然后新建一个笔记到 org-roam 中，如下图所示：

上图中小书签的内容来自 org-roam 的文档，具体内容为：

javascript:location.href = 'org-protocol://roam-ref?template=r&ref=' + encodeURIComponent(location.href) + '&title=' + encodeURIComponent(document.title)

添加的方法是在浏览器中新增一个书签，书签的名字随意（上图中我设置为了“网页抓取”），书签的 URL 填上上面的 javascript 代码。下图是 Firefox 中创建这样的小书签的示意图：

这个小书签的内容分成几部分：

• 第一部分说明小书签要访问的地址，这个就是 org-roam-protocol 的通信地址

  javascript:location.href='org-protocol://roam-ref'
  

• 第二部分指定要使用的笔记模板，从 org-roam-capture-ref-templates 中匹配

  '?template=r'
  

• 第三部分获取一些网页的信息，并设置到变量中，供模板填充使用

  '&ref=' + encodeURIComponent(location.href) + '&title=' + encodeURIComponent(document.title)
  

  前面的默认模板中，head 部分内容为

  :head "#+title: ${title}\n#+roam_key: ${ref}\n"
  

  需要填充 "title" 和 "ref" 两个变量，小书签中第三部分内容就是获取了当前网页的链接赋值给 "ref" 变量，并获取网页标题文本赋值给 "title" 变量了，这样这个模板就能自动填充好了。

不过这个模板和小书签过于简单，只能记录网页链接，我设计了一个模板和对应的小书签，可以做到进行网页标注、摘录，效果见下图：

要达到上图的效果，首先，在 org-roam-capture-ref-templates 中新增一个模板

(add-to-list 'org-roam-capture-ref-templates
             '("a" "Annotation" plain (function org-roam-capture--get-point)
               "%U ${body}\n"
               :file-name "${slug}"
               :head "#+title: ${title}\n#+roam_key: ${ref}\n#+roam_alias:\n"
               :immediate-finish t
               :unnarrowed t))

然后新建一个小书签，内容为

javascript:location.href = 'org-protocol://roam-ref?template=a&ref=' + encodeURIComponent(location.href) + '&title='+encodeURIComponent(document.title) + '&body='+encodeURIComponent(function(){var html = "";var sel = window.getSelection();if (sel.rangeCount) {var container = document.createElement("div");for (var i = 0, len = sel.rangeCount; i < len; ++i) {container.appendChild(sel.getRangeAt(i).cloneContents());}html = container.innerHTML;}var dataDom = document.createElement('div');dataDom.innerHTML = html;['p', 'h1', 'h2', 'h3', 'h4'].forEach(function(tag, idx){dataDom.querySelectorAll(tag).forEach(function(item, index) {var content = item.innerHTML.trim();if (content.length > 0) {item.innerHTML = content + '&#13;&#10;';}});});return dataDom.innerText.trim();}())