#10 巨大なオーガナイズシステム「org-mode」の世界 (Software Design 2015年2月号掲載記事) Emacs org-mode インストール 設定 使い方

　見出しはorg-modeの最も基本になるものです。見出しは行頭で1つ以上のアスタリスクとスペースで始めます。アスタリスクが多ければ多いほど深い階層になっていきます。

==

* H1
** H2-1
*** H3-1
*** H3-2
** H2-2

==

　見出しは手でアスタリスクとスペースを入力しても構いませんが、専用のコマンドが用意されています。現在の見出しと同じ階層の見出しを入力するにはM-RET、あるいはC-RETを使います。これらのコマンドは行頭で実行した場合は直前行に、行頭以外で実行した場合は「後」の行に見出しが挿入されます。

　M-RET とC-RET の違いは子見出しを飛び超えるか否かです。M-RET は飛び超えないで直後の行に、C-RET は飛び超えた先です。上の例でH1の後でM-RETを使うとH1の下、C-RETを使うとH2-2の下になります。

　見出しを入力した後でM-<left>とM-<right>で階層を変更します。子見出しを含めて変更するときはM-S-<left>、M-S-<right>を使います。

　見出し行から見出し行へジャンプするコマンドがいくつか用意されています。

Table1: 見出し間移動コマンド

　ちなみに、それなりの規模のorg文書は<f1> nで見られるEmacs NEWSです。outline-modeになっているのでM-x org-modeで強制的に切り替えればorg-modeのコマンドが使えます。Unix系OSでは読み込み専用になっている場合があるので、C-x C-qで編集可能な状態にします。その状態で見出し操作コマンドを試してみてください。

　リストは箇条書きをするときに使います。見出しでもできますが、リストを使えば目次にはなりません。見出しとリストの違いは、HTMLなどに変換したときの結果が異なることです。HTMLでいえば見出しはH1〜H6、リストはUL・OL＆LI要素に相当します。

　行頭を「-」か「+」で始めると番号なしのリスト、「1.」か「1)」で始めると番号つきリストになります。番号つきリストでC-c C-cを押すと番号を1から順番に割り振り直してくれます。また、C-c -でリストの形式（-, +, 1., 1)）を順番に変更します。

　リストはインデントすることで入れ子にできます。前の行がリストのとき、見出しと同様の方法で入力できます。以下は見出しをリストにしたものです。

==

- H1
  - H2-1
    - H3-1
    - H3-2
  - H2-2

==

　org-modeの重要な機能として見出し以下の折り畳み・展開があります。この機能を使うことで、長い文書の見通しがよくなります。見出しのみを表示することで、自然と目次になります。また、下位の見出しや本文を隠すことで、必要な部分のみを表示することができます。

Fig1: 上:折畳み前 下:折畳み後

　折畳み機能はこのような仕様です。繰り返し実行することで表示方法を切り替えられるのが特徴です。この書き方自体がネストしたリストになっています。

== ここはそのまま掲載してください

C-i (TAB)

現在の見出し以下を折り畳む・表示する

1. 見出し以下を隠す
   
2. 下位見出しを表示する
   
3. 全体を表示する
   
4. 1へ戻る
   

C-u C-i (S-TAB)

文書全体の見出しのみを表示・全部表示

1. 最上位の見出しのみを表示する
   
2. すべての見出しを表示する
   
3. 全体を表示する
   
4. 1へ戻る
   

==

　従来のoutline-modeでは折畳み関連のコマンドが無数に定義されているので、とても覚えきれません。見出し・リストの扱い、折畳み方法を知るだけでもorg-modeを使う意味が出てきます。

　org-modeのハイパーリンク機能はあらゆる情報へのリンクを作成できます。その中でも一番大事なのはファイルへのリンクです。リンクしたい場所を指定するにはM-x org-store-linkを使います。このコマンドは重要なのでキーに割り当てておくべきです。C-c lに割り当てることを推奨しています。

==
(global-set-key (kbd "C-c l") 'org-store-link)
==

　ファイルに対してC-c lを実行したら、そのファイルの現在位置へのリンクを取得します。orgファイルへのリンクの場合は、現在の見出しへリンクされます。それ以外のファイルでは、現在行の文字列へのリンクになります。

　ファイルは変更され得ることに注意してください。行番号や文字のインデックスでリンクを作成すると、変更されたときにずれてしまいます。そのため、デフォルトでは現在行への文字列にリンクすることで前後の内容の変更に耐えられるようになっています。その代わり、現在行の文字列と同じ行が存在したり、現在行が変更されてしまうと望みの位置にジャンプしてくれなくなります。

　C-c lはファイル以外にもdiredやヘルプバッファなどにも対応しているので、いろんなバッファで試してみてください。リンクできるバッファを増やすための拡張パッケージもたくさんあります。

　ファイルバッファに対してC-u C-c l使うと、位置情報を記憶せず、単にそのファイルへのリンクになります。

　C-c lでリンク情報を取得したら、org-modeにおいてC-c C-lでそのリンクを貼り付けます。すると、リンクとリンクの説明文字列(HTMLでいうA要素の中身)を尋ねてきます。リンクは先程取得したリンクがデフォルトになります。リンクの説明もその行の文字列になるので、大抵の場合そのままRET RETでリンクを作成できます。説明文字列を省略すると、リンクそのものが表示されます

　URLへのリンクを作成するには、C-c C-lの後にURLを入力してください。

　位置情報なしでファイルへのリンクを作成するには、C-u C-c C-lを使います。ファイル名と説明文字列を尋ねてきます。説明文字列は省略できます。

　リンクを貼り付けると、表示内容と実際の内容が異なる状況になります。つまり、リンクとリンクの説明の情報が含まれているのに実際にはリンクの説明と下線が表示されています。emacsにはこのように見た目の内容を変更させる機能があります。リンクをリンクらしく表示してくれるのは、閲覧する上ではとても有り難いことですが、リンクを編集する際には困ったことになります。そこで、m-x visible-modeで実際の内容を表示させればよいです。

　あるいは、リンク上でC-c C-lを実行して編集することもできます。

　説明文字列を省略してローカルの画像ファイルへリンクすると、インライン画像として表示できるようになります。HTMLに変換したときもインライン画像になります。これによりHTML作成が簡単になるだけでなく、grep検索できるハイパーテキストとしても使えます。画像付きのメモも作成できるようになります。

　インライン画像を表示するにはC-c C-x c-vを使います。これはトグルになっているので、再度実行するとインライン画像が非表示になります。インライン画像の再描画はC-c C-x C-M-vです。

　常にインライン画像を表示させるには、次のように設定します。

==
(setq org-startup-with-inline-images t)
==

　ファイルごとに設定することもできます。ファイルのどこかに「#+STARTUP: inlineimages」という行を入れれば表示され、「#+STARTUP: noinlineimages」で非表示になります。

== インライン画像の例

org-modeのロゴ

file:org-mode-unicorn-logo.png

==

Fig3: インライン画像表示！

　org-captureを使うには、最低限の設定をしておく必要があります。

　そして、どのようにメモを書き加えるのかは変数org-capture-templatesで設定するのですが、この変数はとても複雑怪奇な代物です。全貌をわかりやすく説明するのは不可能なので、以下の戦略に基いた設定を示しておくにとどめます。

• メモにはTODO・予定用、任意のメモの2種類を用意する
  
• TODO・予定用には先頭行に「TODO」が付く
  
• 任意のメモには以下の情報を付記する
  
  • 現在時刻(%U)
    
  • regionがある場合はその内容(%i)
    
  • M-x org-capture起動時のファイルへのリンク(%a)
    
• %?はテンプレート挿入後のカーソル位置
  

　予定表(org-agenda)の設定も予めやっておきます。変数org-agenda-custom-commandsも複雑なので深入りしないでおきます。

==

(global-set-key (kbd "C-c c") 'org-capture)
(global-set-key (kbd "C-c a") 'org-agenda)
;; org-captureで2種類のメモを扱うようにする
(setq org-capture-templates
      '(("t" "New TODO" entry
         (file+headline "~/org/todo.org" "予定")
         "* TODO %?\n\n")
        ("m" "Memo" entry
         (file+headline "~/org/memo.org" "メモ")
         "* %U%?\n%i\n%a")))
;; org-agendaでaを押したら予定表とTODOリストを表示
(setq org-agenda-custom-commands
      '(("a" "Agenda and TODO"
         ((agenda "")
          (alltodo "")))))
;; org-agendaで扱うファイルは複数可だが、
;; TODO・予定用のファイルのみ指定
(setq org-agenda-files '("~/org/todo.org"))
;; TODOリストに日付つきTODOを表示しない
(setq org-agenda-todo-ignore-with-date t)
;; 今日から予定を表示させる
(setq org-agenda-start-on-weekday nil)

==

　メモはC-c cを押して、どのメモにするかを選択します。「t」でTODO・予定、「m」で通常のメモです。メモの種類を選択したら、org-capture-templatesで設定されたテンプレートが展開され、メモ入力しやすい状態になります。

　メモ入力が完了したらC-c C-cで終了します。他の作業中でも滞ることなくメモが取れるように、メモ入力が完了したら元のウィンドウ構成に戻る親切設計です。C-c C-kでそのメモを破棄します。

　TODO・予定用のメモにはアスタリスクの後にTODOと書かれていますが、それには意味があります。それはTODOキーワードといって、後で紹介するorg-agendaによって、「やることリスト」として表示できるのです。TODOキーワードはデフォルトではTODOとDONEの2種類です。

　TODOリストでそのタスク(TODOキーワード付きのメモ)が完了したらC-c C-tでTODOからDONEに変更します。繰り返し実行すると、TODO→DONE→キーワードなしの順で切り替わります。これはorg-agendaでも使えます。

　org-modeでは、メモに日時を書き込めます。それによってorg-agendaで予定表としてまとめて表示できます。日時にはいくつかの種類があります。inactive日時以外はorg-agendaで表示されます。

Table2: 日時の種類

　日時の入力方法はフリーフォーマットで賢く判断してくれます。整数のみ入力した場合は今月または来月の日付になり、時刻のみ入力した場合は今日の時刻になります。Shift＋矢印キーでカレンダーで日付を選択できます。

　C-c C-sで日時を入力するとSCHEDULEDと出ますが、これはそのタスクのために実際に自分が行動する日時を指定します。例えば10:00から始まる会議に行く時間が9:30だとしたら、C-c C-sで行動予定日時9:30を入力します。

　このようにいろいろな種類のTODOを入力してみました。

==

* [2016-09-23 金 14:37]a
  SCHEDULED: <2016-09-23 金>
* TODO [2016-09-23 金 14:37]a
* TODO [2016-09-23 金 09:11]
* <2016-10-01 土>a
* <2016-09-23 金 09:10>
* TODO [2016-09-23 金 09:10]
* TODO a
* <2016-10-10 月>hoge
* <2016-09-23 金 09:06>a
* TODO [2016-09-23 金 09:06]
todo

==

　TODOや予定をorgファイルに書き加えるだけでは一覧性がなく、見逃してしまいます。そこで、M-x org-agenda (C-c a推奨)を使うと「TODOリスト」や「予定表」という形にしてくれます。しかも複数のファイルに分散して書かれていても、ひとまとめにしてくれるという優れ物です。筆者は出先で多くのタスクをこなす必要があるときにはM-x lpr-bufferで印刷した紙を持ち歩いています。

　起動すると、メニューが現れてくるので、いろいろなことができることがわかります。ここでは週間予定表とTODOリストを表示させるのでaを押します。すると、*Org Agenda*には次のように表示されます。org-agenda上でもorg-modeでの多くのコマンドが使えます。

　org-agendaはとても深く、カスタマイズ項目もとても多いので紙面で紹介しきれないのが残念です。筆者も現役の設定になるまでには長年の試行錯誤がありました。

Fig4: C-c a aでagendaを起動！