Org mode syntax example

New section.

One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin. He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The bedding was hardly able to cover it and seemed ready to slide off any moment. His many legs, pitifully thin compared with the size of the rest of him, waved about helplessly as he looked.

Itemized lists are marked with bullets. They are convenient to:

• organize data, and
• make the document
  • prettier, and
  • easier to read.

Create them with a minus or a plus sign.

Enumerated lists are marked with numbers or letters:

1. First element
   1. First sub-item
   2. Last sub-item
2. Second element

You can have ordered lists with jumping numbers:

1. First
2. Second
5. Jump to 5th

Definition list

List containing definitions.

Term to define

Explication of the term.

• ☐ First item not checked
• ☐ Second item half done
  • ☐ Another first
  • ☐ Another second
• ☑ Third item checked

You can include another Org file and skip its title by using the :lines argument to #+INCLUDE:

#+INCLUDE: chapter1.org :lines "2-"
                

You can include raw HTML in your Org documents and it will get kept as HTML when it's exported. XXX

Text can be preformatted (in a fixed-width font).

It is especially useful for more advanced stuff like images or tables where you need more control of the HTML options than Org mode actually gives you.

Similarly, you can incorporate JS or do anything else you can do in a Web page (such as importing a CSS file).

You can create named classes (to get style control from your CSS) with:

                #+begin_info
                *Info example* \\
                Did you know...
                #+end_info
              

You can also add interactive elements to the HTML such as interactive R plots.

Finally, you can include an HTML file verbatim (during export) with:

#+INCLUDE: file.html html
                

Don't edit the exported HTML file!

You can also use raw LaTeX. XXX

Text can be preformatted (in a fixed-width font).

Both in example and in src snippets, you can add a -n switch to the end of the begin line, to get the lines of the example numbered.

1: (defun org-xor (a b)
                  2:   "Exclusive or."
                

If you use a +n switch, the numbering from the previous numbered snippet will be continued in the current one:

3: (if a (not b) b))
                

In literal examples, Org will interpret strings like (ref:name) as labels, and use them as targets for special hyperlinks like [[(name)]] (i.e., the reference name enclosed in single parenthesis). In HTML, hovering the mouse over such a link will remote-highlight the corresponding code line, which is kind of cool.

You can also add a -r switch which removes the labels from the source code. With the -n switch, links to these references will be labeled by the line numbers from the code listing, otherwise links will use the labels with no parentheses. Here is an example:

1: (save-excursion                  ;
                  2:   (goto-char (point-min)))       ;
                

In line 1, we remember the current position. Line 2 jumps to point-min.

The output from the execution of programs, scripts or commands can be inserted in the document itself, allowing you to work in the reproducible research mindset.

Emphasize (italics), strongly (bold), and very strongly (bold italics).

Markup elements could be nested: this is italic text which contains underlined text within it, whereas this is normal underlined text.

Markup can span across multiple lines, by default no more than 2:

This is not bold

Other elements to use sparingly are:

• monospaced typewriter font for inline code
• monospaced typewriter font for verbatim text
• deleted text (vs. inserted text)
• text with^superscript (for example: m/s^{2} gives m/s²)
• text with_subscript (for example: H_{2}O gives H₂O)

Use the quote block to typeset quoted text.

Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a computer what to do, let us concentrate rather on explaining to human beings what we want a computer to do.

The practitioner of literate programming can be regarded as an essayist, whose main concern is with exposition and excellence of style. Such an author, with thesaurus in hand, chooses the names of variables carefully and explains what each variable means. He or she strives for a program that is comprehensible because its concepts have been introduced in an order that is best for human understanding, using a mixture of formal and informal methods that reinforce each other.

— Donald Knuth

A short one:

Everything should be made as simple as possible, but not any simpler – Albert Einstein

In a verse environment, there is an implicit line break at the end of each line, and indentation and vertical space are preserved:

Everything should be made as simple as possible,
but not any simpler – Albert Einstein

Typically used for quoting passages of an email message:

>> This is an email message with "nested" quoting. Lorem ipsum dolor sit amet,
>> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
>> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
>
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem
> consectetuer libero luctus adipiscing.

Itemized or unordered lists (ul):
- This is the first list item.
- This is the second list item.

Enumerated or ordered Lists (ol):
1. This is the first list item.
2. This is the second list item.

Maybe an equation here?

See http://www.google.com/ for more information…

Using non-breaking spaces.

Insert the Unicode character 00A0 to add a non-breaking space. FIXME Or add/use an Org entity?

À Á

Dash: – —

Marks: ¡ ¿

Quotations: « »

Miscellaneous: ¶ ª

Property marks: © ®

Currency: ¢ € ¥ £

The Greek letters α, β, and γ are used to denote angles.

Science: ± ÷

Arrows: → → ← ↔ ⇒ ⇐ ⇔

Function names: arccos cos

Signs and symbols: • *

Suits: ♣ ♠

Here is a table on the left side:

The noindent just gets rid of the indentation of the first line of a paragraph which in this case is the table. The hfill adds infinite stretch after the table, so it pushes the table to the left.

Here is a centered table:

And here's a table on the right side:

Here the hfill adds infinite stretch before the table, so it pushes the table to the right.

You can insert image files of different formats to a page:

In-line picture:

Direct link to just the Unicorn picture file.

XXX Available HTML image tags include:

• align
• border
• bordercolor
• hspace
• vspace
• width
• height
• title
• alt

Place images side by side: XXX

Videos can't be added directly but you can add an image with a link to the video like this:

http://www.youtube.com/watch?v=YOUTUBE_VIDEOIDHERE

You can have example blocks.

Find entries with an exact phrase – To do this, put the phrase in quotes:

                "hd ready"
              

You can create several other boxes (info, tip, note or warning) which all have a different default image.

An info box is displayed as follows:

A tip box is displayed as follows:

A note box is displayed as follows:

A warning box is displayed as follows:

Links generally point to an headline.

They can also point to a link anchor in the current document or in another document.

This document is available in plain text, HTML and PDF.

The links are delimited by [square brackets].