Org mode syntax quick reference
+Org mode syntax quick reference card
Table of Contents
- Summary -
- Document header -
- Document settings +
- Reference card +
- Document header +
- Document settings -
- Section titles (headings) +
- Section titles (headings) -
- Paragraphs +
- Paragraphs
- Normal
- Line breaks @@ -85,124 +86,124 @@
- Text width
- - Formatting text +
- Formatting text -
- Lists +
- Lists -
- Tables +
- Tables -
- Links +
- Links -
- Images +
- Images -
- Videos -
- Admonitions +
- Videos +
- Admonitions -
- Centered text -
- Sidebar -
- Example -
- Prose excerpts +
- Centered text +
- Sidebar +
- Example +
- Prose excerpts -
- Comments -
- Substitutions +
- Comments +
- Substitutions -
- Source code +
- Source code -
- Math +
- Math -
- Miscellaneous effects +
- Miscellaneous effects -
- Footnotes -
- Useful extensions +
- Footnotes +
- Useful extensions -
- Graphs with Graphviz +
- Graphs with Graphviz -
- Graphs with R +
- Graphs with R -
- Citations -
- Appendix +
- Citations +
- Appendix
Document header
+Reference card
Table of Contents
+-
+
- Summary +
- Reference card +
- Document header +
- Document settings + + +
- Section titles (headings) + + +
- Paragraphs + + +
- Formatting text + + +
- Lists + + +
- Tables + + +
- Links + + +
- Images + + +
- Videos +
- Admonitions + + +
- Centered text +
- Sidebar +
- Example +
- Prose excerpts + + +
- Comments +
- Substitutions + + +
- Source code + + +
- Math + + +
- Miscellaneous effects + + +
- Footnotes +
- Useful extensions + + +
- Graphs with Graphviz
+
-
+
- Undirected +
- Directed +
+ - Graphs with R
+
-
+
- Example +
+ - Citations +
- Appendix
+
-
+
- Index +
- Bibliography +
- Glossary +
+
Document header
+Title and author line:
@@ -264,21 +422,21 @@ My document provides...
Document settings
- -Document description
-Document settings
+ +Document description
+Section numbering
-Section numbering
+
@@ -289,9 +447,9 @@ My document provides...
Table of contents
-Table of contents
+Set the toc
attribute to activate an auto-generated table of contents (limited to its 2 first levels) at the top of document.
@@ -306,25 +464,25 @@ My document provides...
List of figures
-List of figures
+#+TOC: figures
is not implemented yet in the HMTL backend.
List of tables
-List of tables
+#+TOC: tables
is already implemented in the HTML backend.
List of equations
+List of equations
Section titles (headings)
-Section titles (headings)
+
* Biggest heading (level 1)
@@ -346,27 +504,27 @@ New sub-section.
New sub-sub-section.
Bigger heading (level 2)
-Bigger heading (level 2)
+New section.
Big heading (level 3)
-Big heading (level 3)
+New sub-section.
Heading (level 4)
-Heading (level 4)
+New sub-sub-section.
Numbered headings
-Numbered headings
+You can create numbered headings up to a certain level by setting an option:
@@ -375,9 +533,9 @@ New sub-sub-section.
Paragraphs
- +Paragraphs
+Normal
Formatting text
-Formatting text
+Text effects.
Bold and italic
-Bold and italic
+Emphasize (italics), strongly (bold), and /very strongly/ (bold italics). @@ -466,9 +624,9 @@ Not feas*ible*.Not feas*ible*.
Monospace, superscript and subscript
-Monospace, superscript and subscript
+Other elements to use sparingly are:
@@ -487,21 +645,21 @@ Not feas*ible*.
Smart punctuation
-Smart punctuation
+If the XXX option is specified, Org mode will produce typographically correct output, converting straight quotes to curly quotes, ---
to em-dashes, --
to en-dashes, and ...
to ellipses.
Lists
-Lists
+Org markup allows you to create bulleted or numbered lists. It allows any combination of the two list types.
Unordered lists
-Unordered lists
+Itemized lists are marked with bullets. Create them with a minus or a plus sign.
They are convenient to organize data, and make the document prettier, and easier to read.
Checklists
-Checklists
+
- [X] Checked.
@@ -544,9 +702,9 @@ Not feas*ible*.
Ordered lists
-Ordered lists
+Enumerated lists are marked with numbers or letters:
@@ -584,9 +742,9 @@ Not feas*ible*.
Definition lists
-Definition lists
+Labeled, multi-line lists.
@@ -610,9 +768,9 @@ Not feas*ible*.
Separating lists
-Separating lists
+Adjacent lists sometimes like to fuse. To force the start of a new list, offset the two lists by an empty line comment:
@@ -639,14 +797,14 @@ Not feas*ible*.
Tables
-Tables
+Tables are one of the most refined areas of the Org mode syntax. They are very easy to create and to read.
Simple table
-Simple table
+| Cell in column 1, row 1 | Cell in column 2, row 1 | @@ -670,18 +828,18 @@ Not feas*ible*.Org tables have cells of at most one line long: there is no such thing as a multi-line table cell in Org.
Column formatting
-Column formatting
+Columns are automatically aligned:
- Number-rich columns to the right, and
- String-rich columns to the left.
Table with aligned cells
-Table with aligned cells
+If you want to override the automatic alignment, use <r>
, <c>
or <l>
.
@@ -717,13 +875,13 @@ Not feas*ible*.
Table with column size adjusted
+Table with column size adjusted
Header row
-Header row
+You can create tables with an header row (by using an horizontal line of dashes to separate it from the rest of the table).
@@ -767,9 +925,9 @@ Not feas*ible*.
Table placement
-Table placement
+
@@ -814,12 +972,12 @@ Not feas*ible*.
Align tables on the page
- -Left
-Align tables on the page
+ +Left
+Here is a table on the left side:
@@ -859,9 +1017,9 @@ Not feas*ible*.The
noindent
just gets rid of the indentation of the first line of a paragraph which in this case is the table. Thehfill
adds infinite stretch after the table, so it pushes the table to the left.
Center
-Center
+Here is a centered table:
@@ -897,9 +1055,9 @@ Not feas*ible*.
Right
-Right
+And here's a table on the right side:
@@ -939,9 +1097,9 @@ Not feas*ible*.
Table size
-Table size
+
@@ -965,15 +1123,15 @@ Not feas*ible*.
CSV
-CSV
+You can fill a table from a CSV file using R commands.
Links
+Links
@@ -985,9 +1143,9 @@ Not feas*ible*.This document is available in plain text, HTML and PDF.
The links are delimited by double square brackets.
External links
-External links
+See http://www.pirilampo.org (automatic!) and the @@ -995,9 +1153,9 @@ See http://www.pir
See http://www.pirilampo.org/ (automatic!) and the Org mode Web site.
Relative links
-Relative links
+Home @@ -1005,9 +1163,9 @@ See http://www.pir
Email links
-Email links
+email John Doe @@ -1016,12 +1174,12 @@ See http://www.pir
Internal links
- -Inline anchors
-Internal links
+ +Inline anchors
+Anchors are used to specify hypertext link targets.
@@ -1030,15 +1188,15 @@ See http://www.pir
Internal cross references
-Internal cross references
+Links generally point to an headline.
See chapter Links.
See chapter Links.
+See chapter Links.
To add a link to a figure (e.g., "See Figure 1"), just do:
@@ -1063,18 +1221,18 @@ See:See:
- Location cross reference. -
- Section Internal links +
- Section Internal links
Extensions that define new hyperlinks targets
+Extensions that define new hyperlinks targets
Images
-Images
+You can insert image files of different formats to a document:
Inline picture
-Inline picture
+Org mode logo @@ -1131,27 +1289,27 @@ Click to see the Unicorn picture.
Image alignment (using positioning)
-Image alignment (using positioning)
+Books usually align/float images on the right/left of the contents.
Image is left aligned
+Image is left aligned
Image is right aligned
+Image is right aligned
Image is centered
-Image is centered
+Image attributes and values
-Image attributes and values
+XXX Available HTML image tags include …