• 如果您觉得本站非常有看点,那么赶紧使用Ctrl+D 收藏吧

一箭双雕——org-mode中的ID和CUSTOM_ID字段

互联网 diligentman 6天前 5次浏览

org-mode中,一个条目(entry)可以设置多个属性(Properties)。有的属性是org-mode内置的,有它们的特殊用途。有的属性是自定义的,用在一些插件或仅仅用于记录信息。CUSTOM_ID属于前者,而ID属性后者。

CUSTOM_ID

CUSTOM_ID用于跳转。org-mode支持丰富的外部链接格式,其中之一便是链接到指定.org文件的指定CUSTOM_ID的条目。

比如在一个.org文件中有file:/Users/liutos/Dropbox/gtd/roles/writer.org::#d1bdc978-a8ce-4266-9ffa-b6041f818431这么一段文本,那么当光标置于这个文本中时,按下快捷键C-c C-o,Emacs便会打开文件/Users/liutos/Dropbox/gtd/roles/writer.org,并将光标对应的条目上。

ID

ID用于联系两个条目。一个名叫org-edna的第三方插件能够实现两个条目间的依赖,其中一个要素便是条目的ID属性。

比如我有一个讲解Ada语言的任务(以一个条目的形式存在),同时也有一个学习Ada语言的任务(另一个条目)。显然,必须先学习一番才能讲给他人听,所以第一个条目依赖于第二个条目,于是我先给学习Ada语言的条目设置一个ID属性,值为905fc2f4-4e28-4966-84fa-84c9e6bae96c,然后再为讲解Ada语言的条目中设置一个BLOCKER属性,值为ids(905fc2f4-4e28-4966-84fa-84c9e6bae96c)。如此一来,当讲解Ada语言的条目出现在*Org Agenda*中时,Emacs会将其置灰显示,代表它处于阻塞的状态,必须先处理它的依赖才行。

自动填充CUSTOM_ID和ID

建立依赖和跳转都是很常用的功能,因此我会给每一个条目都设置CUSTOM_IDID属性。为了免除每次都手动设置的麻烦,我用org-modecapture-template特性来实现自动填充。

capture-template是org-mode的又一项利器,用于生成条目间共性的内容,比如行首的星号、关键字,以及写入到哪一个文件的哪一个层级中。org-mode的官网便有一个例子

(setq org-capture-templates
      '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
         "* TODO %?n  %in  %a")
        ("j" "Journal" entry (file+datetree "~/org/journal.org")
         "* %?nEntered on %Un  %in  %a")))

capture-template中除了可以用预置的占位符(比如上文的%U%i,以及%a),还可以调用任意的Elisp函数——这正适合填充IDCUSTOM_ID这类不重复,并且有一定的格式要求的属性。ID属性的值可以用来自于第三方插件uuidgenuuidgen-4函数来生成

(setq org-capture-templates
      '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
         "* TODO %?  :PROPERTIES:n  :CUSTOM_ID: %(uuidgen-4)n  :ID: %(uuidgen-4)n  :END:")))

美中不足的是,CUSTOM_IDID的值是不同的,因为uuidgen-4每次都会返回不同的字符串。有没有什么办法能够让它们一样的呢?答案是肯定的。

一式两份

既然两次调用uuidgen-4的结果不同,那么就将第一次调用后的结果保存起来,然后重复使用即可。思路很简单,实现代码也很直白

(let (lt-org-capture--uuid)
  (defun lt-org-capture-uuidgen ()
    "生成一个UUID并填充到词法作用域的变量中。"
    (setf lt-org-capture--uuid (uuidgen-4))
    lt-org-capture--uuid)
  (defun lt-org-capture-uuidclr ()
    "返回生成好的UUID并清空它。"
    lt-org-capture--uuid))

capture-template也是水到渠成的

(setq org-capture-templates
      '(("t" "Todo" entry (file+headline "~/org/gtd.org" "Tasks")
         "* TODO %?  :PROPERTIES:n  :CUSTOM_ID: %(lt-org-capture-uuidgen)n  :ID: %(lt-org-capture-uuidclr)n  :END:")))

后记

在上面的函数定义中,我试图利用词法作用域特性,使得lt-org-capture--uuid只能被lt-org-capture-uuidgenlt-org-capture-uuidclr读写。遗憾的是,Elisp并不支持词法作用域,lt-org-capture--uuid实际上是一个全局变量——完全可以用C-h v来审视它。

全文完。

阅读原文


喜欢 (0)