RhubarbSin/org-syntax-cheatsheet.org

## org-syntax-cheatsheet.org

      
    Raw
  

              org-syntax-cheatsheet.org
            
          
    Markup Cheat sheet for Org-mode

Heading 1

Heading 2: Set a deadline and a schedule

[66%] Heading 3: a list with checkboxes


  [X] task 1
  [X] task 2
  [ ] task 3 (C-c C-c to toggle status of checkbox)

[1/3] Track completion of tasks

Finished task


  State “DONE”       from “TODO”       [2012-03-07 Wed 07:56]

STARTED Started task

Unstarted task


  State “TODO”       from “DONE”       [2012-03-07 Wed 08:02]

Plain Lists (C-c C-q to add tags to headline)

Not part of the list.

  First ordered list item
    
      One type of unordered list item
    
  
  Second ordered list item (C-c C-c to renumber the list)
    
      Another type of unordered list item
    
  
Unordered description list:

  Term
Description

Fancy typesetting features


  bold ital underline code verbatim strike through


  : literal example
  —–  horizontal line (5 dashes)

Hyperlinks

hyperlink text
  
  External Links
  targetted link
  shell commands
Source Code

plot(1:10)
return x + 1
Tables and Spreadsheets

Basic Table (C-c C-c within table to re-align)


  Col1 Col 2
  KW Sep
  TW Aug

Spreadsheet


  x y
  1 1
  2 1.4142136
  3 1.7320508
  4 2

Mathematical Equations

\begin{equation}
  ∫^x_0 x^2 dx = \frac{x^3}{3}
  \end{equation}
Keywords


  TITLE
the title to be shown (default is the buffer name)
  AUTHOR
the author (default taken from user-full-name)
  DATE
a date, an Org timestamp, or a format string for format-time-string
  EMAIL
his/her email address (default from user-mail-address)
  DESCRIPTION
the page description, e.g. for the XHTML meta tag
  KEYWORDS
the page keywords, e.g. for the XHTML meta tag
  LANGUAGE
language for HTML, e.g. “en” (org-export-default-language)
  TEXT
Some descriptive text to be inserted at the beginning.
  TEXT
Several lines may be given.
  OPTIONS
H:2 num:t toc:t \n:nil @:t ::t |:t ^:t f:t TeX:t …
    
      H
set the number of headline levels for export
      num
turn on/off section-numbers
      toc
turn on/off table of contents or set level limit (integer)
      \n
turn on/off line-break-preservation (DOES NOT WORK)
      @
turn on/off quoted HTML tags
      ::
turn on/off fixed-width sections
      |
turn on/off tables
      ^
turn on/off TeX-like syntax for sub- and superscripts. If you write
        “^:{}”, a_b will be interpreted, but the simple a_b will be left as is.
      -
turn on/off conversion of special strings.
      f
turn on/off footnotes like this[1]
      todo
turn on/off inclusion of TODO keywords into exported text
      tasks
turn on/off inclusion of tasks (TODO items); can be nil to remove
        all tasks, todo to remove DONE tasks, or list of keywords to keep
      pri
turn on/off priority cookies
      tags
turn on/off inclusion of tags; may also be not-in-toc
      <
turn on/off inclusion of any time/date stamps like DEADLINES
      *
turn on/off emphasized text (bold, italic, underlined)
      TeX
turn on/off simple TeX macros in plain text
      LaTeX
configure export of LaTeX fragments (default auto)
      skip
turn on/off skipping the text before the first heading
      author
turn on/off inclusion of author name/email into exported file
      email
turn on/off inclusion of author email into exported file
      creator
turn on/off inclusion of creator info into exported file
      timestamp
turn on/off inclusion creation time into exported file
      d
turn on/off inclusion of drawers, or list drawers to include
    
  
You need to confirm using these, or configure org-export-allow-BIND:

  BIND
lisp-var lisp-val, e.g. org-export-latex-low-levels itemize
  LINK_UP
the “up” link of an exported page
  LINK_HOME
the “home” link of an exported page
  LaTeX_HEADER
extra line(s) for the LaTeX header, like \usepackage{xyz}
  EXPORT_SELECT_TAGS
tags that select a tree for export
  EXPORT_EXCLUDE_TAGS
tags that exclude a tree from export
  XSLT
the XSLT stylesheet used by DocBook exporter to generate FO file