search

snosov1 / toc-org

toc-org is an Emacs utility to have an up-to-date table of contents in the org files without exporting (useful primarily for readme files on GitHub)
GNU General Public License v3.0
293 stars 30 forks source link
emacs emacs-lisp github org org-mode readme toc

readme

[[https://travis-ci.org/snosov1/toc-org][file:https://api.travis-ci.org/snosov1/toc-org.svg?branch=master]]

=toc-org= helps you to have an up-to-date table of contents in org files without exporting (useful primarily for readme files on GitHub).

It is similar to the [[https://github.com/ardumont/markdown-toc][markdown-toc]] package, but works for org files. Since recently, =toc-org=, actually, works in [[#markdown-support][markdown]], too!

NOTE: Previous name of the package is =org-toc=. It was changed because of a name conflict with one of the org contrib modules.

[[https://elpa.nongnu.org/nongnu/toc-org.html][https://elpa.nongnu.org/nongnu/toc-org.svg]] [[http://melpa.org/#/toc-org][file:http://melpa.org/packages/toc-org-badge.svg]]

This is the simplest method if you have the package.el module (built-in since Emacs 24.1) you can simply use =M-x package-install= after setting up the [[http://melpa.org/#/getting-started][MELPA]] repository and then put the following snippet in your ~/.emacs file

+BEGIN_SRC elisp

(if (require 'toc-org nil t) (progn (add-hook 'org-mode-hook 'toc-org-mode)

    ;; enable in markdown, too
    (add-hook 'markdown-mode-hook 'toc-org-mode)
    (define-key markdown-mode-map (kbd "\C-c\C-o") 'toc-org-markdown-follow-thing-at-point))
(warn "toc-org not found"))

+END_SRC

** Manual

After the installation, every time you'll be saving an org file, the first headline with a =:TOC:= tag will be updated with the current table of contents.

To add a TOC tag, you can use the command =org-set-tags-command= (=C-c C-q=).

In addition to the simple :TOC: tag, you can also use the following tag formats:

You can also use =@= as separator, instead of =_=.

It's possible to set the default values of max depth and hrefify function with =toc-org-max-depth= and =toc-org-hrefify-default= variables. But, note, that if you do this outside of the org file itself, then you can face conflicts if you work on the same file collaboratively with someone else, as your default configs can vary.

** Follow links

If you call =M-x org-open-at-point= (=C-c C-o=) when you're at a TOC entry, the point will jump to the corresponding heading.

Notice, that this functionality exploits the =org-link-translation-function= variable. So, it won't work if you use this variable for other purposes (i.e. it is not nil).

You can manually disable this functionality by setting =toc-org-enable-links-opening= to nil.

** Exclude headings

Headings tagged with =:noexport:= will be excluded from the TOC. If you want to preserve the heading, but strip its children (for changelog entries, for example), you can tag it =:noexport_1:= (by analogy, you can use =:noexport_2:=, =:noexport_3:=, etc. for children of deeper levels). Note, though, =:noexport:= has a similar meaning in =org-mode=, which I hope is a Good Thing (tm). However, =:noexport_1:= and friends won't be recognized by =org-mode= as anything special. Look at =org-export-exclude-tags= variable for more details.

** Quote table of contents

For presentation purposes, you might want to put the table of contents in a quote block (i.e. =#+BEGIN_QUOTE= / =#+END_QUOTE=). In that case, GitHub, for example, will add a vertical line to the left of the TOC that makes it distinct from the main text. To do this, just add a =:QUOTE:= tag to the TOC heading.

** Shortcut for TOC tag

In your emacs' setup, you can bind a tag =:TOC:= to a binding =T=:

+BEGIN_SRC emacs-lisp

(add-to-list 'org-tag-alist '("TOC" . ?T))

+END_SRC

Now =C-c C-q T RET= and you are done putting the =:TOC:= entry.

You can also enable the mode in Markdown files and get pretty much the same functionality. The package will

  1. Look for '#'s instead of '*'s as heading markers.
  2. Expect the =:TOC:= tag to appear as comment, like, ==
  3. Format the links and the quote block according to Markdown syntax

Example:

+BEGIN_SRC markdown

About

Table of Contents

Currently, only 2 href styles are supported: =gh= and =org=. You can easily define your own styles. If you use the tag =:TOC_2_STYLE:= (=STYLE= being a style name), then the package will look for a function named =toc-org-hrefify-STYLE=.

It should accept a heading string and a hash table of previously generated hrefs. The table can be used to maintain href uniqueness (see =toc-org-hrefify-gh=, for example). Return value should be a href corresponding to that heading.

E.g. for =org= style it makes links to be the same as their visible text:

+BEGIN_SRC emacs-lisp

(defun toc-org-hrefify-org (str &optional hash) "Given a heading, transform it into a href using the org-mode rules." (toc-org-format-visible-link str))

+END_SRC