org mode 简略指南（个人翻译版）

当你初次使用一个emacs,且你并没有什么配置的时候,如何从零开始配置org呢?首先,尝试将以下代码复制到init.el文件里,当然,也可以是合理的其他位置.这样做的目的是为了激活快捷键.

(global-set-key (kbd "C-c l") 'org-store-link)
(global-set-key (kbd "C-c a") 'org-agenda)
(global-set-key (kbd "C-c c") 'org-capture)

就是一级标题,二级标题等等.一般可以通过以下方式进行表达:

此外,可以通过"M-<ENTER>"键一键形成一个同等的一级标题.可以使用TAB将这个一级标题转换为一个二级标题. 一般,当打开一个org文档时,这个org文档仅仅会展露出一个骨架.此时可以通过TAB将这个骨架进行展开.

也就是在可见度之间的一种循环.前面有所介绍.

1. 最常用的方法是使用TAB.如:

,-> folded FOLDED -> children CHILDREN -> subtree SUBTREE --.
'-----------------------------------------------------------'

1. 使用S-TAB在以下场景下实现循环.

,-> OVERVIEW -> CONTENTS -> SHOW ALL --.
'--------------------------------------'

1. 使用C-u C-u C-u TAB ,实现show all 的功能.
2. 自定义一个org文档起始时刻应该具有的结构.

一般而言,可以在org文档的开头这么写:

STARTUP:content

还可以设置变量比如:overview,content,showall等.

有的时候,是想直接在headline之间进行跳动的.这些过程通常可以经由以下快捷键进行展示. 值得注意的是,这些快捷键显然是C-c加上了一些独特的后缀.

1. C-c C-n Next heading.从当前文本跳跃到上一个headline处,或从当前的headline跳跃到上一个headline处,而不论上一个headline是否与此处的headline同级别.你可以通过这个按钮跳跃到与光标相比最近的上一个headline处.
2. C-c C-p Previous heading.类上
3. C-c C-f Next heading same level 只会在同一level的headline之间跳转,并且归于他们的上级那里,出不去.
4. C-c C-b provious heading same level类上
5. C-c C-u backward to higher level headings.?

结构编辑主要存在以下快捷键.

1. M-RET 添加一个同级别的headline
2. M-S-RET 添加一个同级别的todo headline
3. M-LEFT M-RIGHT 将当前headline升级或者降级
4. M-UP M-DOWN 将当前headline同其包括的所有内容上移或者下移
5. C-c C-W 将本healine的所有内容归属到另一个一级标题之下
6. C-x n s C-x n w 在buffer层面进行移动

sparse tree 是一种有侧重地进行"目标选择"的工具.(不太确定,我目前这样理解这一功能) 针对这种工具,基本的使用方法有:

1. C-c / 这可以打开一个sparse tree 按钮
2. C-c / r 关键字搜素.比如,在本文中,搜素和展示有关headline的内容.

简单的列表可以通过以下标记符号进行快速地创建. 使用"-" "+" "*" 进行无序号列表的创建,使用"1." "1 "进行有序号列表的创建.使用"::"进行解释. 下面是一个例子.值得注意的是,这里"::"充当的作用,与latex中\label极为相似.二者都是在给出一个方便于引用的对象.关于如何应用之,可以看5.2.

◉ Lord of the Rings
  My favorite scenes are (in this order)
  1. The attack of the Rohirrim
  2. Eowyn's fight with the witch king
     ◦ this was already my favorite scene in the book
     ◦ I really like Miranda Otto.
  Important actors in this film are:
  – Elijah Wood :: He plays Frodo
  – Sean Astin :: He plays Sam, Frodo's friend.

如题所述,虽然不怎么常用.

• C-c C-c 在不移动点的前提下重新对齐表格
• TAB 横向,移动到下一个
• S-TAB 横向,前一个
• RET 下一行
• S-方向键 让当前的cell和周围的某个cell进行交换

行与列的变换都是基于"M"进行的.

1. M-LEFT M-RIGHT 将当前的列左移或者右移
2. M-UP M-DOWN 将当前行上移或者下移
3. M-S-LEFT 删除当前列
4. M-S-RIGHT 插入新列
5. M-S-UP 删除当前行
6. M-S-DOWN 插入新行
7. C-c -, C-c RET 分别表示插入一条horizontal line,在下面,或者上面
8. C-c ^ 列排序

内部链接这里作者并没有给出详细的阐述.笔者尝试了以下,对于特殊的一些格式似乎都是可以识别的.

首先,罗列一些典型的外部链接:

http://www.astro.uva.nl/=dominik        on the web
file:/home/dominik/images/jupiter.jpg   file, absolute path
/home/dominik/images/jupiter.jpg        same as above
file:papers/last.pdf    file, relative path
./papers/last.pdf’      same as above
file:projects.org       another Org file
docview:papers/last.pdf::NNN    open in DocView mode at page NNN
id:B7423F4D-2E8A-471B-8810-C40F074717E9 link to heading by ID
news:comp.emacs Usenet link
mailto:adent@galaxy.net mail link
mhe:folder#id   MH-E message link
rmail:folder#id Rmail message link
gnus:group#id   Gnus article link
bbdb:R.*Stallman        BBDB link (with regexp)
irc:/irc.com/#emacs/bob IRC link
info:org#Hyperlinks     Info node link

除此之外,还有一些特殊情况,这些特殊情况包括:
file:~/code/main.c::255 Find line 255
file:~/xx.org::MyTarget Find ‘ ↪ My Target ’
file:~/xx.org::#my-custom-id    Find entry with a custom ID

1. C-c C-l 插入一个链接.当该处存在链接时,其意义是修改一个链接.
2. C-c C-o 打开一个链接.

当一个items的前面包含todo的时候,它就变成了一个todo 的item. 一般而言,todo的基本命令如下:

1. C-c C-t 打开todo选项.
2. S-左右 cycling todo的状态吧.
3. C-c / t 在sparse tree里看todo.有关于sparse tree的信息参见sparse tree.
4. M-x org-agenda t 展现出全局的todo
5. S-M-RET 输入一个新的todo.

muti-state指的就是"并非所有的待办都是todo->done"循环的产物.比如debug的过程,可能是下面的形式.

(setq org-todo-keywords
      '((sequence "TODO(t)" "|" "DONE(d)")
        (sequence "REPORT(r)" "BUG(b)" "KNOWNCAUSE(k)" "|" "FIXED(f)")))

这时,简简单单使用todo这一套就不太管用了.我觉得这里的东西没什么太多的实际用途.

进展记录,最简单的使用方法是通过引入一个前缀"C-u",来加入一个时间戳.也就是通过"C-u C-c C-t"来改变todo项目的状态. emacs里面有专门的时间记录,详细可参阅此处.

就是对todo设置优先级的问题.一般优先级会用ABC进行表达.

1. "C-c ,",设置优先级,可以输入ABC.通过空格键进行移除.
2. S-上下 改变优先级.

在父标题下使用[/]或者[%],之后,在子标题里设置todo的状态,就可以了.

在使用plain list的时候,可能会用到这个功能来进行进度管理. 比如下面的例子:

◉  TODO  Organize party  ◑ 1/2 
  – □ call people  ○ 0/2 
    – □ Peter
    – □ Sarah
  – ☑ order food
使用C-c C-c来进行checkboxes状态的切换.

以上面的例子为示,标签的层级具有一定的关联性.比如最后的headline,它包含着所有的标签,也就是,他继承了他的父标题以及祖父标题的标签.

当然,也可以在文章中定义标签,这种定义方法为:

FILETAGS: : Peter : Boss : Secret :

1. M-TAB 无法使用,与系统的页面转换重合
2. C-c C-q 为当前的headline插入一个tag
3. C-c C-c 当光标在headline时,同2

除了前面那种一个个插入标签的方法之外,org支持插入一个标签列表,其基本语法为:

TAGS: @work @home @tennisclub
TAGS: laptop car pc sailboat

除此之外,emacs支持快速标签选择,也就是一个按键输入一个标签,这需要在配置文件中写入:

(setq org-tag-alist '(("@work" . ?w)
                      ("@home" . ?h)
                      ("@laptop" . ?l)))

标签组是很多个标签组成的集合.他的用途是:当进行标签的搜索时,如果输入了标签组的名字,那么就可以返回匹配标签组内所有标签headlines 标签组的定义方法如下.

TAGS: [GTD : Control Persp]
TAGS: {Context : @home @work}

1. C-c / m or C-c \ 生成一个sparse tree,
2. M-x org-agenda m 通过agenda file 生成一个全局的标签匹配列表
3. M-x org-agenda M 在2的基础上,仅仅显示带有TODO标签的那些.

值得注意的是,这些标签均支持布尔运算.比如使用"a+b-c"代表包含a标签并包含b标签且不包含c标签的所有匹配项.使用"x|y"代表包含x标签或包含y标签的匹配项.

此处存在各种各样格式的时间戳，然而，对我而言，这并非需要关心或者讨论的重点，因而对其仅进行简要介绍.

如题所示,这一章来看一看如何记录消耗在特定项目上的时间.

1. C-c C-x C-i 打开一个clock（clock in）
2. C-c C-x C-o 关闭一个clock（clock out）
3. C-c C-x C-e 升级当前时钟的估计工作量
4. C-c C-x C-q 退出当前时钟，如果不小心打开了一个时钟，可以用这个选项
5. C-c C-x C-j jump，跳转到任务中当前计时的标题

capture（名词，捕捉）: capture是指在知识系统中快速捕捉新的主意与任务（task）的一种方式。并且，这种捕捉还可以关联与其相关的一些材料。这一整套的流程被称作capture。

本节的意思,似乎就是简化剪切,切换,粘贴这一整套的文本条目重新归档的过程.

1. C-c C-w

C-c C-w 就是说,要把这一小节(光标所在的小节)的内容归档至其他的某个小节.

1. C-u C-c C-w

使用refile界面跳转到标题.

1. C-u C-u C-c C-w

1. C-c M-w

1. C-c [ 将当前文件加入到agenda file列表中
2. C-c ] 将当前文件从agenda file列表中移除
3. C-'
4. C-, cycle through agenda file list， one after another

使用M-x org-agenda进行激活,或者使用快捷键C-c a. 分配器提供了以下一些默认的指令:

• a 创建一个日历形式的日程
• t T 创建一个包含所有tudo项的列表
• m M 创建一个匹配了表达式的所有headline的列表
• s Create a list of entries selected by a boolean expression of keywords and/or regular expressions that must or must not occur in the entry. 不是特别理解这句话什么意思.

就像是传统的纸上的日程表一样,weekly-daily agenda给出每天或每周所需要干的事. 比如,在使用M-x org-agenda a命令时,其基本的思路是从org文件列表中提取条目信息编译形成当前周的日历.

全局todo列表将所有的未完成的todo项目进行了一个统一的收集,可以用t关键字进行查询.

• M-x org-agenda t 展示全局todo列表
• M-x org-agenda T 和一条相似,不过可以允许搜索特定的todo关键词

同makrdown一样,paragraph也是通过一个空的行进行段与段之间的分割.除此之外,也可以使用latex中常见的"\\". 但是,这样的一个问题是,对于一些特殊的格式,比如诗歌中的空格,要怎么进行表现呢? 一般会通过如下方式:

VERSE
 Great clouds overhead
 Tiny black birds rise and fall
 Snow covers Emacs

    ---AlexSchroeder
VERSE

初次之外,就是对"语录"的格式要求.markdown里使用">"进行,而在org里,其基本文法是:

QUOTE
Everything should be made as simple as possible,
but not any simpler ---Albert Einstein
QUOTE

关于居中,常见的使用方法是:

CENTER
Everything should be made as simple as possible, \\
but not any simpler
CENTER

综上,仅仅需要记住verse,quote,center三种形式,就可以解决问题.

You can make words ‘*bold*’, ‘/italic/’, ‘_underlined_’, ‘=verbatim=’ and ‘~code~’, and, if you must, ‘+strike-through+’. Text in the code and verbatim string is not processed for Org specific syntax; it is exported verbatim.

You can make words ‘*bold*’, ‘/italic/’, ‘_underlined_’, ‘=verbatim=’ and ‘~code~’, and, if you must, ‘+strike-through+’. Text in the code and verbatim string is not processed for Org specific syntax; it is exported verbatim. 

org对latex的嵌入十分灵活,除了下文中给出的世界嵌入latex风格的任何语言之外,此处还有最基本的对latex风格公式的支持. 比如下面这段话,完全可以在org中直接使用:

The radius of the sun is R_sun = 6.96 x 10^8 m.  On the other hand,
the radius of Alpha Centauri is R_{Alpha Centauri} = 1.28 x R_{sun}.

\begin{equation}                        % arbitrary environments,
x=\sqrt{b}                              % even tables, figures
\end{equation}                          % etc

If $a^2=b$ and \( b=2 \), then the solution must be
either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \].

其效果为: The radius of the sun is R_sun = 6.96 x 10^8 m. On the other hand, the radius of Alpha Centauri is R_{Alpha Centauri} = 1.28 x R_{sun}.

\begin{equation} % arbitrary environments, x=\sqrt{b} % even tables, figures \end{equation} % etc

If \(a^2=b\) and \( b=2 \), then the solution must be either \[ a=+\sqrt{2} \] or \[ a=-\sqrt{2} \].

这里主要想介绍一些文学编程中如何进行举例的问题. 一般来说,定义一个例子的方法是:

EXAMPLE
  Some example from a text file.
EXAMPLE

当然,这种方法也可以被简化为空格+冒号.也就是

Here is an example
   : Some example from a text file.

其效果是: Here is an example

Some example from a text file.

除此之外, 还有关于插入代码块的内容,这个在之后将会进行详细介绍.

一张图片本质上是一个链接,所以图片均可以通过超链接的方式[[][]]进行表达,特殊地,如果想像latex那样给出描述和引用标签的话,图的定义就需要添加以下附属信息:

CAPTION: This is the caption for the next figure link (or table)
NAME:   fig:SED-HR4049
./img/a.jpg

下面插入一张图片作为示例

插入脚注的方法很简单¹去使用,下面是一个示例:

The Org homepage[1] now looks a lot better than it used to.
...
[1] The link is: https://orgmode.org

关于脚注的东西,org内置了以下快捷键:

1. C-c C-x f 插入一条新的脚注,如果存在,那么就进行跳转(从正文跳转到参考处,或者从参考处跳转到正文的脚注位置)
2. C-c C-c 从脚注的定义处与参考处之间进行跳转

比如,可以在文档的所有位置(但是建议于开头处)插入此类:

TITLE: org基本笔记

一般可供此类插入的信息主要包括:

• TITLE. 文章的名字
• AUTHOR. 作者
• DATE. 一个日期,或者org的时间戳(timestamp)
• EMAIL. email
• LANGUAGE. language code,如"en".

在org中,导出会默认在第一个headline前面插入目录.可以通过下面的一些特殊的命令对目录进行自定义.

OPTIONS: toc:2          (only include two levels in TOC)
OPTIONS: toc:nil        (no default TOC at all)

可以在org文件里插入其他文件,比如,插入一段emacs的配置文件信息,将之作为src并以elisp的语法进行展示.

INCLUDE: "~/.emacs" src emacs-lisp

一般,插入的文件的类型包括example, export, src这三种.

注释符号为＃号.