Author

Alejandro Alcalde

Data Scientist and Computer Scientist. Creator of this blog.

Alejandro Alcalde's posts | Porfolio

Quick reference guide for emacs Org-mode key binds

This is a quick reference to org mode, it is mostly a copy and paste from its manual, but I needed an easy way of checking the most useful org-mode commands in a single view, because I found myself checking again and again its manual.

<figure> <a href="/img/orgmodequickreference.jpg"> <img on="tap:lightbox1" role="button" tabindex="0" layout="responsive" src="/img/orgmodequickreference.jpg" alt="Org mode quick reference" title="Org mode quick reference" sizes="(min-width: 640px) 640px, 100vw" width="640" height="480"> </img> </a> <figcaption>Org mode quick reference</figcaption> </figure>

First, you can cycle through your sections with <TAB>, which expands/contract sections in your document.

Sections

* Top level headline
** Second level
*** 3rd level
    some text
*** 3rd level
    more text

* Another top level headline

Cycling

You can cycle through sections with:

Move through headlines

<!–ad–>

Insert/modify sections

Sparse Trees

Useful to hide documents parts where you are not currently working.

Plain lists

Footnotes

Here is an example footnote 1. The code to generate it is:

Here is an example footnote [fn:1].

[fn:1] Click return to return to reference

Hyperlinks

Syntax: [[link][description]] or only [[link]], once a link is created, you can edit it with C-c C-l

In case the link is not a URL, it is considered to be internal in the current file:

[[#custom-id]]
[[My Target][Find my target]]

The last one will search for a target in the current file with syntax <<My Target>>

TODO items

Any headline starting with TODO becomes a TODO item.

You can have a composed list of TODO items, and can toggle it with C-c C-c, and create a new one with M-S-<RET>.

* TODO Organize party [0/3]
  - [ ] call people [0/2]
    - [ ] Peter
    - [ ] Sarah
  - [ ] order food

<figure> <a href="/img/org-mode-todo-checkboxs.gif"> <img on="tap:lightbox1" role="button" tabindex="0" layout="responsive" src="/img/org-mode-todo-checkboxs.gif" alt="TODO Items checkboxes" title="TODO items checkboxes" sizes="(min-width: 244px) 244px, 100vw" width="244" height="100"> </img> </a> <figcaption>TODO Items checkboxes</figcaption> </figure>

Markup

Images & Tables

Tables have this syntax:

| HEADER1  | header2  |
|----------+----------|
| content1 | contend2 |

<figure> <a href="/img/org-mode-table.gif"> <img on="tap:lightbox1" role="button" tabindex="0" layout="responsive" src="/img/org-mode-table.gif" alt="Creating tables in org-mode" title="Creating tables in org-mode" sizes="(min-width: 304px) 304px, 100vw" width="304" height="214"> </img> </a> <figcaption>Creating tables in org-mode</figcaption> </figure>

Images are like links: [[./img/a-image.jpg]]

Source code

To include source code:

 #+BEGIN_SRC emacs-lisp
     (defun org-xor (a b)
        "Exclusive or."
        (if a (not b) b))

#+END_SRC

will render to

(defun org-xor (a b)
  "Exclusive or."
  (if a (not b) b))

You can edit the code example in a buffer supporting that language with C-c '

Source


1

Click to return to reference

Spot a typo?: Help me fix it by contacting me or commenting below!

Maybe this posts are also worth reading