toc-org 20170518.451(in MELPA)
add table of contents to org-mode files (formerly, org-toc)

概要

<2015-04-22 Wed>
org-toc.el は名前がかぶっているため toc-org.el にリネームされました。
設定変更をお願いします!!!!

toc-org.el は、 orgファイル に自動的に 目次 をつけます。

とくに github用README.org を書く場合に便利です。

html exportするときは勝手に目次がつけられるので、これは不要です。

githubにおいてはexportされずに独自の方法で
HTML化されるのでこのパッケージが役立ちます。

設定を加えた後、目次用の見出しに「TOC」というタグをつけるだけで、
その見出しが目次になります。

タグは見出しでC-c C-c、あるいは任意の場所でC-c C-qでつけられます。

目次はファイルを保存するときに自動更新されます。

TOCタグのデフォルトの設定は

  • github用
  • 見出しレベル2(**)までが目次になる

となっています。

「TOC@3」と指定すれば、レベル3(***)までが目次になります。

exportせずにorgファイル内でリンクをたどれるようにするには
「TOC@2@org」のように目次化したいレベルとorgを指定します。

インストール

パッケージシステムを初めて使う人は
以下の設定を ~/.emacs.d/init.el の
先頭に加えてください。

(package-initialize)
(setq package-archives
      '(("gnu" . "http://elpa.gnu.org/packages/")
        ("melpa" . "http://melpa.org/packages/")
        ("org" . "http://orgmode.org/elpa/")))

初めてtoc-orgを使う方は
以下のコマンドを実行します。

M-x package-install toc-org

アップグレードする方は、
以下のコマンドでアップグレードしてください。
そのためにはpackage-utilsパッケージが必要です。

M-x package-install package-utils (初めてアップグレードする場合のみ)
M-x package-utils-upgrade-by-name toc-org

設定 140921104232.org-toc.1.el(以下のコードと同一)

(when (require 'org-toc nil t)
  (add-hook 'org-mode-hook 'org-toc-enable))

実行方法

$ wget http://rubikitch.com/f/140921104232.org-toc.1.el
$ emacs -Q -f package-initialize -l 140921104232.org-toc.1.el

使用例

github用

* 1
* 目次                                                                  :TOC:
 - [[#1][1]]
 - [[#2][2]]
 - [[#3][3]]
     - [[#3-1][3-1]]
     - [[#3-2][3-2]]
 - [[#4][4]]

* 2
* 3
** 3-1
*** 3-1-1
** 3-2
* 4

org用

* 1
* 目次                                                                  :TOC@2@org:
 - [[1][1]]
 - [[2][2]]
 - [[3][3]]
     - [[3-1][3-1]]
     - [[3-2][3-2]]
 - [[4][4]]

* 2
* 3
** 3-1
*** 3-1-1
** 3-2
* 4

本サイト内の関連パッケージ


本日もお読みいただき、ありがとうございました。参考になれば嬉しいです。