1
0
mirror of https://github.com/fniessen/org-html-themes.git synced 2024-07-07 09:20:53 +02:00
org-html-themes/demo/org-mode-syntax.html

2776 lines
79 KiB
HTML
Raw Normal View History

2015-02-24 12:08:13 +01:00
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
2015-02-26 11:39:35 +01:00
<title>Org mode syntax quick reference</title>
2015-02-24 12:08:13 +01:00
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="generator" content="Org-mode" />
<meta name="author" content="Fabrice Niessen" />
<meta name="description" content="Org mode syntax example"
/>
2015-02-26 11:39:35 +01:00
<meta name="keywords" content="org-mode, syntax, quick reference, cheat sheet, latex, beamer, html" />
2015-02-27 12:09:39 +01:00
<link rel="stylesheet" type="text/css" href="d:/Users/fni/src/org-html-themes/styles/readtheorg/rtd.css"/>
2015-02-26 10:15:13 +01:00
<script type="text/javascript" src="d:/Users/fni/src/org-html-themes/styles/readtheorg/rtd.js"></script>
<script> var HS_STARTUP_FOLDED = true; </script>
2015-02-24 12:08:13 +01:00
<script type="text/javascript" src="http://orgmode.org/mathjax/MathJax.js"></script>
<script type="text/javascript">
<!--/*--><![CDATA[/*><!--*/
MathJax.Hub.Config({
// Only one of the two following lines, depending on user settings
// First allows browser-native MathML display, second forces HTML/CSS
// config: ["MMLorHTML.js"], jax: ["input/TeX"],
jax: ["input/TeX", "output/HTML-CSS"],
extensions: ["tex2jax.js","TeX/AMSmath.js","TeX/AMSsymbols.js",
"TeX/noUndefined.js"],
tex2jax: {
inlineMath: [ ["\\(","\\)"] ],
displayMath: [ ['$$','$$'], ["\\[","\\]"], ["\\begin{displaymath}","\\end{displaymath}"] ],
skipTags: ["script","noscript","style","textarea","pre","code"],
ignoreClass: "tex2jax_ignore",
processEscapes: false,
processEnvironments: true,
preview: "TeX"
},
showProcessingMessages: true,
displayAlign: "center",
displayIndent: "2em",
"HTML-CSS": {
scale: 100,
availableFonts: ["STIX","TeX"],
preferredFont: "TeX",
webFont: "TeX",
imageFont: "TeX",
showMathMenu: true,
},
MMLorHTML: {
prefer: {
MSIE: "MML",
Firefox: "MML",
Opera: "HTML",
other: "HTML"
}
}
});
/*]]>*///-->
</script>
</head>
<body>
2015-02-26 10:15:13 +01:00
<div id="org-div-home-and-up">
<a accesskey="h" href="http://www.bing.com"> UP </a>
|
<a accesskey="H" href="http://www.google.com"> HOME </a>
</div><div id="content">
2015-02-26 11:39:35 +01:00
<h1 class="title">Org mode syntax quick reference</h1>
2015-02-24 12:08:13 +01:00
<div id="table-of-contents">
<h2>Table of Contents</h2>
<div id="text-table-of-contents">
<ul>
2015-02-26 10:15:13 +01:00
<li><a href="#unnumbered-1">Document header</a></li>
<li><a href="#unnumbered-2">Section titles (headings)</a></li>
<li><a href="#unnumbered-3">Biggest heading (level 1)</a>
2015-02-24 12:08:13 +01:00
<ul>
2015-02-26 10:15:13 +01:00
<li><a href="#unnumbered-4">Bigger heading (level 2)</a></li>
<li><a href="#unnumbered-7">Numbered headings</a></li>
2015-02-24 12:08:13 +01:00
</ul>
</li>
2015-02-26 10:15:13 +01:00
<li><a href="#unnumbered-8">Paragraphs</a>
2015-02-24 12:08:13 +01:00
<ul>
2015-02-26 10:15:13 +01:00
<li><a href="#unnumbered-9">Normal</a></li>
<li><a href="#unnumbered-10">Line breaks</a></li>
<li><a href="#unnumbered-11">Horizontal rules</a></li>
<li><a href="#unnumbered-12">Text width</a></li>
2015-02-24 12:08:13 +01:00
</ul>
</li>
2015-02-26 11:39:35 +01:00
<li><a href="#unnumbered-13">Formatting text</a>
2015-02-26 10:15:13 +01:00
<ul>
2015-02-26 11:39:35 +01:00
<li><a href="#unnumbered-14">Bold and italic</a></li>
<li><a href="#unnumbered-15">Monospace, superscript and subscript</a></li>
2015-02-26 10:15:13 +01:00
</ul>
</li>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-16">Lists</a>
2015-02-26 10:15:13 +01:00
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-17">Unordered lists</a></li>
<li><a href="#unnumbered-18">Checklists</a></li>
<li><a href="#unnumbered-19">Ordered lists</a></li>
<li><a href="#unnumbered-20">Definition lists</a></li>
</ul>
</li>
<li><a href="#unnumbered-21">Tables</a>
<ul>
<li><a href="#unnumbered-22">Simple table</a></li>
<li><a href="#unnumbered-23">Column formatting</a></li>
<li><a href="#unnumbered-26">Header row</a></li>
<li><a href="#unnumbered-27">Table placement</a></li>
<li><a href="#unnumbered-28">Align tables on the page</a></li>
<li><a href="#unnumbered-29">Table size</a></li>
2015-02-26 10:15:13 +01:00
</ul>
</li>
2015-02-26 11:39:35 +01:00
<li><a href="#links">Links</a>
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-31">External links</a></li>
<li><a href="#unnumbered-34">Internal links</a></li>
</ul>
</li>
<li><a href="#unnumbered-37">Images</a>
<ul>
<li><a href="#unnumbered-38">Inline picture</a></li>
<li><a href="#unnumbered-39">Using positioning</a></li>
<li><a href="#unnumbered-40">Image attributes and values</a></li>
</ul>
</li>
<li><a href="#unnumbered-41">Videos</a></li>
<li><a href="#unnumbered-42">Admonitions</a>
<ul>
<li><a href="#unnumbered-43">Note</a></li>
<li><a href="#unnumbered-44">Warning</a></li>
<li><a href="#unnumbered-45">Tip</a></li>
<li><a href="#unnumbered-46">Info</a></li>
<li><a href="#unnumbered-47">Danger</a></li>
<li><a href="#unnumbered-48">Neutral</a></li>
</ul>
</li>
<li><a href="#unnumbered-49">Centered text</a></li>
<li><a href="#unnumbered-50">Sidebar</a></li>
<li><a href="#unnumbered-51">Example</a></li>
<li><a href="#unnumbered-52">Prose excerpts</a>
<ul>
<li><a href="#unnumbered-53">Quote</a></li>
<li><a href="#unnumbered-54">Verse</a></li>
<li><a href="#unnumbered-55">Block quote with optional attribution line</a></li>
<li><a href="#unnumbered-56">Block quotes with their own class attribute</a></li>
<li><a href="#unnumbered-57">Spaces</a></li>
2015-02-26 11:39:35 +01:00
</ul>
</li>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-58">Comments</a></li>
<li><a href="#unnumbered-59">Substitutions</a>
2015-02-26 10:15:13 +01:00
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-60">Org macros</a></li>
2015-02-26 10:15:13 +01:00
</ul>
</li>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-61">Source code</a>
2015-02-26 10:15:13 +01:00
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-62">Inline code</a></li>
<li><a href="#unnumbered-63">Code block with syntax highlighting</a></li>
<li><a href="#unnumbered-64">Line numbers</a></li>
<li><a href="#unnumbered-65">Special characters</a></li>
2015-02-26 10:15:13 +01:00
</ul>
</li>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-72">Math</a>
2015-02-26 10:15:13 +01:00
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-73">Inline math expressions</a></li>
<li><a href="#unnumbered-74">Math expressions in display mode</a></li>
<li><a href="#unnumbered-75">Equation numbers</a></li>
2015-02-26 10:15:13 +01:00
</ul>
</li>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-76">Miscellaneous effects</a>
2015-02-26 11:39:35 +01:00
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-77">Include Org files</a></li>
<li><a href="#unnumbered-78">Inline HTML</a></li>
<li><a href="#unnumbered-79">Inline LaTeX</a></li>
2015-02-26 11:39:35 +01:00
</ul>
</li>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-80">Notes at the footer</a></li>
<li><a href="#unnumbered-81">Useful extensions</a>
2015-02-26 10:15:13 +01:00
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-82">Todo extension</a></li>
<li><a href="#unnumbered-90">Bigblow extension</a></li>
2015-02-26 10:15:13 +01:00
</ul>
</li>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-91">Graphs with Graphviz</a>
2015-02-26 10:15:13 +01:00
<ul>
2015-02-27 12:09:39 +01:00
<li><a href="#unnumbered-92">Undirected</a></li>
<li><a href="#unnumbered-93">Directed</a></li>
</ul>
</li>
<li><a href="#unnumbered-94">Graphs with R</a>
<ul>
<li><a href="#unnumbered-95">Text</a></li>
<li><a href="#unnumbered-96">Example</a></li>
<li><a href="#unnumbered-97">Graph</a></li>
<li><a href="#unnumbered-98">R code block</a></li>
2015-02-26 10:15:13 +01:00
</ul>
</li>
2015-02-24 12:08:13 +01:00
</ul>
</div>
</div>
<p>
This is an Org mode document.
</p>
<p>
2015-02-26 11:39:35 +01:00
<b>Org mode</b> is an easy-to-write <i>plain text</i> formatting syntax for authoring notes,
articles, LaTeX documents, books, Web pages, Beamer slide decks and much more!
2015-02-24 12:08:13 +01:00
</p>
<div id="outline-container-unnumbered-1" class="outline-2">
2015-02-26 10:15:13 +01:00
<h2 id="unnumbered-1">Document header</h2>
2015-02-24 12:08:13 +01:00
<div class="outline-text-2" id="text-unnumbered-1">
2015-02-26 10:15:13 +01:00
<p>
Title and author line:
</p>
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-document-info-keyword">#+TITLE:</span> <span class="org-org-document-title">Org mode syntax example</span>
<span class="org-org-document-info-keyword">#+AUTHOR:</span> <span class="org-org-document-info">Fabrice Niessen</span>
My document provides...
</pre>
</div>
<p>
Attributes&#x2026;
</p>
</div>
</div>
<div id="outline-container-unnumbered-2" class="outline-2">
<h2 id="unnumbered-2">Section titles (headings)</h2>
<div class="outline-text-2" id="text-unnumbered-2">
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-level-1">* Biggest heading (level 1)</span>
New chapter.
<span class="org-org-level-2">** Bigger heading (level 2)</span>
New section.
<span class="org-org-level-3">*** Big heading (level 3)</span>
New sub-section.
<span class="org-org-level-4">**** Heading (level 4)</span>
New sub-sub-section.
</pre>
</div>
</div>
</div>
<div id="outline-container-unnumbered-3" class="outline-2">
<h2 id="unnumbered-3">Biggest heading (level 1)</h2>
<div class="outline-text-2" id="text-unnumbered-3">
2015-02-24 12:08:13 +01:00
<p>
New chapter.
</p>
</div>
2015-02-26 10:15:13 +01:00
<div id="outline-container-unnumbered-4" class="outline-3">
<h3 id="unnumbered-4">Bigger heading (level 2)</h3>
<div class="outline-text-3" id="text-unnumbered-4">
2015-02-24 12:08:13 +01:00
<p>
New section.
</p>
</div>
2015-02-26 10:15:13 +01:00
<div id="outline-container-unnumbered-5" class="outline-4">
<h4 id="unnumbered-5">Big heading (level 3)</h4>
<div class="outline-text-4" id="text-unnumbered-5">
2015-02-24 12:08:13 +01:00
<p>
New sub-section.
</p>
</div>
2015-02-26 10:15:13 +01:00
<div id="outline-container-unnumbered-6" class="outline-5">
<h5 id="unnumbered-6">Heading (level 4)</h5>
<div class="outline-text-5" id="text-unnumbered-6">
<p>
New sub-sub-section.
</p>
</div>
</div>
</div>
</div>
<div id="outline-container-unnumbered-7" class="outline-3">
<h3 id="unnumbered-7">Numbered headings</h3>
<div class="outline-text-3" id="text-unnumbered-7">
<p>
You can create numbered headings up to a certain level by setting an option:
</p>
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line">#+OPTIONS: H:4</span>
</pre>
</div>
</div>
</div>
</div>
<div id="outline-container-unnumbered-8" class="outline-2">
<h2 id="unnumbered-8">Paragraphs</h2>
<div class="outline-text-2" id="text-unnumbered-8">
</div><div id="outline-container-unnumbered-9" class="outline-3">
<h3 id="unnumbered-9">Normal</h3>
<div class="outline-text-3" id="text-unnumbered-9">
<div class="org-src-container">
<pre class="src src-org">A single newline has no effect.
This line is part of the same paragraph.
But an empty line
demarcates paragraphs.
</pre>
2015-02-24 12:08:13 +01:00
</div>
<p>
A single newline has no effect.
This line is part of the same paragraph.
</p>
<p>
But an empty line
</p>
<p>
demarcates paragraphs.
</p>
2015-02-26 10:15:13 +01:00
</div>
</div>
<div id="outline-container-unnumbered-10" class="outline-3">
<h3 id="unnumbered-10">Line breaks</h3>
<div class="outline-text-3" id="text-unnumbered-10">
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org">By entering two consecutive backslashes, \\
you can force to break lines
2015-02-26 10:15:13 +01:00
without starting a new paragraph.
</pre>
</div>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
By entering two consecutive backslashes, <br />
you can force to break lines
2015-02-24 12:08:13 +01:00
without starting a new paragraph.
</p>
2015-02-26 10:15:13 +01:00
</div>
</div>
<div id="outline-container-unnumbered-11" class="outline-3">
<h3 id="unnumbered-11">Horizontal rules</h3>
<div class="outline-text-3" id="text-unnumbered-11">
<div class="org-src-container">
<pre class="src src-org">For an horizontal line, insert at least 5 dashes: this is some text above an
horizontal rule
-----
and some text below it.
</pre>
</div>
2015-02-24 12:08:13 +01:00
<p>
For an horizontal line, insert at least 5 dashes: this is some text above an
horizontal rule
</p>
<hr />
<p>
and some text below it.
</p>
</div>
</div>
2015-02-26 10:15:13 +01:00
<div id="outline-container-unnumbered-12" class="outline-3">
<h3 id="unnumbered-12">Text width</h3>
<div class="outline-text-3" id="text-unnumbered-12">
2015-02-24 12:08:13 +01:00
<p>
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.
</p>
</div>
</div>
</div>
2015-02-26 10:15:13 +01:00
<div id="outline-container-unnumbered-13" class="outline-2">
2015-02-26 11:39:35 +01:00
<h2 id="unnumbered-13">Formatting text</h2>
2015-02-26 10:15:13 +01:00
<div class="outline-text-2" id="text-unnumbered-13">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
Text effects.
2015-02-24 12:08:13 +01:00
</p>
</div>
2015-02-26 10:15:13 +01:00
<div id="outline-container-unnumbered-14" class="outline-3">
2015-02-26 11:39:35 +01:00
<h3 id="unnumbered-14">Bold and italic</h3>
2015-02-26 10:15:13 +01:00
<div class="outline-text-3" id="text-unnumbered-14">
2015-02-26 11:39:35 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-italic">Emphasize</span> (italics), <span class="org-bold">strongly</span> (bold), and <span class="org-bold">/very strongly/</span> (bold italics).
</pre>
</div>
<p>
<i>Emphasize</i> (italics), <b>strongly</b> (bold), and <b><i>very strongly</i></b> (bold italics).
</p>
<p>
Markup elements could be nested:
</p>
<div class="org-src-container">
<pre class="src src-org">This is <span class="org-italic">italic text which contains </span><span class="org-underline"><span class="org-italic">underlined text</span></span><span class="org-italic"> within it</span>, whereas <span class="org-underline">this is</span>
<span class="org-underline">normal underlined text</span>.
</pre>
</div>
<p>
This is <i>italic text which contains <span class="underline">underlined text</span> within it</i>, whereas <span class="underline">this is
normal underlined text</span>.
</p>
<p>
Markup can span across multiple lines, by default <b>no more than 2</b>:
</p>
<div class="org-src-container">
<pre class="src src-org">*This
is not
bold*
</pre>
</div>
<p>
*This
is not
bold*
</p>
</div>
</div>
<div id="outline-container-unnumbered-15" class="outline-3">
<h3 id="unnumbered-15">Monospace, superscript and subscript</h3>
<div class="outline-text-3" id="text-unnumbered-15">
<p>
Other elements to use sparingly are:
</p>
<div class="org-src-container">
<pre class="src src-org">- monospaced typewriter font for <span class="org-org-code">inline code</span>
- monospaced typewriter font for <span class="org-org-verbatim">verbatim text</span>
- +deleted+ text (vs. <span class="org-underline">inserted</span> text)
- text with super<span class="org-org-latex-and-related">script</span> (for example: <span class="org-org-code">m/s^{2}</span> gives m/s<span class="org-org-latex-and-related">2</span>)
- text with sub<span class="org-org-latex-and-related">script</span>
</pre>
</div>
<ul class="org-ul">
<li>monospaced typewriter font for <code>inline code</code></li>
<li>monospaced typewriter font for <code>verbatim text</code></li>
<li>+deleted+ text (vs. <span class="underline">inserted</span> text)</li>
<li>text with super<sup>script</sup> (for example: <code>m/s^{2}</code> gives m/s<sup>2</sup>)</li>
<li>text with sub<sub>script</sub></li>
</ul>
</div>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-16" class="outline-2">
<h2 id="unnumbered-16">Lists</h2>
<div class="outline-text-2" id="text-unnumbered-16">
2015-02-26 11:39:35 +01:00
<p>
Org markup allows you to create <b>bulleted</b> or <b>numbered</b> lists. It allows any
combination of the two list types.
</p>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-17" class="outline-3">
<h3 id="unnumbered-17">Unordered lists</h3>
<div class="outline-text-3" id="text-unnumbered-17">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 10:15:13 +01:00
Itemized lists are marked with bullets. Create them with a minus or a plus sign.
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 10:15:13 +01:00
<p>
They are convenient to:
</p>
<div class="org-src-container">
<pre class="src src-org">- Organize data, and
- Make the document
+ Prettier, and
+ Easier to read.
</pre>
</div>
2015-02-24 12:08:13 +01:00
<ul class="org-ul">
2015-02-26 10:15:13 +01:00
<li>Organize data, and</li>
<li>Make the document
2015-02-24 12:08:13 +01:00
<ul class="org-ul">
2015-02-26 10:15:13 +01:00
<li>Prettier, and</li>
<li>Easier to read.</li>
2015-02-24 12:08:13 +01:00
</ul></li>
</ul>
2015-02-26 10:15:13 +01:00
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-18" class="outline-3">
<h3 id="unnumbered-18">Checklists</h3>
<div class="outline-text-3" id="text-unnumbered-18">
2015-02-26 10:15:13 +01:00
<div class="org-src-container">
<pre class="src src-org">- <span class="org-org-checkbox">[X]</span> Checked
- <span class="org-org-checkbox">[-]</span> Half-checked
- <span class="org-org-checkbox">[ ]</span> Not checked
- Normal list item
</pre>
</div>
<ul class="org-ul">
<li class="on">&#x2611; Checked</li>
<li class="trans">&#x2610; Half-checked</li>
<li class="off">&#x2610; Not checked</li>
<li>Normal list item</li>
</ul>
2015-02-24 12:08:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-19" class="outline-3">
<h3 id="unnumbered-19">Ordered lists</h3>
<div class="outline-text-3" id="text-unnumbered-19">
2015-02-24 12:08:13 +01:00
<p>
Enumerated lists are marked with numbers or letters:
</p>
2015-02-26 10:15:13 +01:00
<div class="org-src-container">
<pre class="src src-org">1. First element
1) First sub-item
2) Last sub-item
2. Second element
</pre>
</div>
2015-02-24 12:08:13 +01:00
<ol class="org-ol">
<li>First element
<ol class="org-ol">
<li>First sub-item</li>
<li>Last sub-item</li>
</ol></li>
<li>Second element</li>
</ol>
<p>
You can have ordered lists with jumping numbers:
</p>
2015-02-26 10:15:13 +01:00
<div class="org-src-container">
<pre class="src src-org">1. [@1] First
2. [@2] Second
5. [@5] Jump to 5th
</pre>
</div>
2015-02-24 12:08:13 +01:00
<ol class="org-ol">
<li value="1">First</li>
<li value="2">Second</li>
<li value="5">Jump to 5th</li>
</ol>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-20" class="outline-3">
<h3 id="unnumbered-20">Definition lists</h3>
<div class="outline-text-3" id="text-unnumbered-20">
2015-02-26 10:15:13 +01:00
<p>
Labeled, multi-line lists.
</p>
<div class="org-src-container">
<pre class="src src-org">- <span class="org-org-list-dt">First term to define ::</span>
Definition of the first term.
- <span class="org-org-list-dt">Second term ::</span>
Explication of the second term.
</pre>
</div>
2015-02-24 12:08:13 +01:00
<dl class="org-dl">
2015-02-26 10:15:13 +01:00
<dt>First term to define</dt><dd>Definition of the first term.</dd>
2015-02-24 12:08:13 +01:00
2015-02-26 10:15:13 +01:00
<dt>Second term</dt><dd>Explication of the second term.</dd>
2015-02-24 12:08:13 +01:00
</dl>
</div>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-21" class="outline-2">
<h2 id="unnumbered-21">Tables</h2>
<div class="outline-text-2" id="text-unnumbered-21">
2015-02-26 11:39:35 +01:00
<p>
2015-02-27 12:09:39 +01:00
Tables are one of the most refined areas of the Org mode syntax. They are very easy
to create and to read.
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-22" class="outline-3">
<h3 id="unnumbered-22">Simple table</h3>
<div class="outline-text-3" id="text-unnumbered-22">
2015-02-24 12:08:13 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-table">| Cell in column 1, row 1 | Cell in column 2, row 1 |</span>
<span class="org-org-table">| Cell in column 1, row 2 | Cell in column 2, row 2 |</span>
2015-02-24 12:08:13 +01:00
</pre>
</div>
2015-02-27 12:09:39 +01:00
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<colgroup>
<col class="left" />
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<col class="left" />
</colgroup>
<tbody>
<tr>
<td class="left">Cell in column 1, row 1</td>
<td class="left">Cell in column 2, row 1</td>
</tr>
<tr>
<td class="left">Cell in column 1, row 2</td>
<td class="left">Cell in column 2, row 2</td>
</tr>
</tbody>
</table>
2015-02-26 11:39:35 +01:00
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-23" class="outline-3">
<h3 id="unnumbered-23">Column formatting</h3>
<div class="outline-text-3" id="text-unnumbered-23">
<p>
Columns are automatically aligned:
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<ul class="org-ul">
<li>Number-rich columns to the right, and</li>
<li>String-rich columns to the left.</li>
</ul>
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-24" class="outline-4">
<h4 id="unnumbered-24">Table with aligned cells</h4>
<div class="outline-text-4" id="text-unnumbered-24">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
If you want to override the automatic alignment, use <code>&lt;r&gt;</code>, <code>&lt;c&gt;</code> or <code>&lt;l&gt;</code>.
2015-02-24 12:08:13 +01:00
</p>
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-meta-line">#+CAPTION: Table with aligned columns</span>
<span class="org-org-table">| </span><span class="org-org-formula">&lt;r&gt;</span><span class="org-org-table"> | </span><span class="org-org-formula">&lt;c&gt;</span><span class="org-org-table"> | </span><span class="org-org-formula">&lt;l&gt;</span><span class="org-org-table"> |</span>
<span class="org-org-table">| 1 | 2 | 3 |</span>
<span class="org-org-table">| Right | Center | Left |</span>
<span class="org-org-table">| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |</span>
2015-02-24 12:08:13 +01:00
</pre>
</div>
2015-02-27 12:09:39 +01:00
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<caption class="t-above"><span class="table-number">Table 1:</span> Table with aligned columns</caption>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<colgroup>
<col class="right" />
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<col class="center" />
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<col class="left" />
</colgroup>
<tbody>
<tr>
<td class="right">1</td>
<td class="center">2</td>
<td class="left">3</td>
</tr>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<tr>
<td class="right">Right</td>
<td class="center">Center</td>
<td class="left">Left</td>
</tr>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<tr>
<td class="right">xxxxxxxxxxxx</td>
<td class="center">xxxxxxxxxxxx</td>
<td class="left">xxxxxxxxxxxx</td>
</tr>
</tbody>
</table>
2015-02-26 11:39:35 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-25" class="outline-4">
<h4 id="unnumbered-25">Table with column size adjusted</h4>
2015-02-24 12:08:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-26" class="outline-3">
<h3 id="unnumbered-26">Header row</h3>
<div class="outline-text-3" id="text-unnumbered-26">
2015-02-26 10:15:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
You can create tables with an header row (by using an horizontal line of dashes
to separate it from the rest of the table).
2015-02-26 11:39:35 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line">#+CAPTION: An example of table</span>
<span class="org-org-table">| Name of column 1 | Name of column 2 | Name of column 3 |</span>
<span class="org-org-table">|------------------+------------------+------------------|</span>
<span class="org-org-table">| Top left | Top middle | |</span>
<span class="org-org-table">| | | Right |</span>
<span class="org-org-table">| Bottom left | Bottom middle | |</span>
</pre>
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<caption class="t-above"><span class="table-number">Table 2:</span> An example of table</caption>
2015-02-26 11:39:35 +01:00
<colgroup>
<col class="left" />
<col class="left" />
<col class="left" />
</colgroup>
<thead>
<tr>
2015-02-27 12:09:39 +01:00
<th scope="col" class="left">Name of column 1</th>
<th scope="col" class="left">Name of column 2</th>
<th scope="col" class="left">Name of column 3</th>
2015-02-26 11:39:35 +01:00
</tr>
</thead>
<tbody>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left">Top left</td>
<td class="left">Top middle</td>
2015-02-26 11:39:35 +01:00
<td class="left">&#xa0;</td>
</tr>
<tr>
<td class="left">&#xa0;</td>
<td class="left">&#xa0;</td>
2015-02-27 12:09:39 +01:00
<td class="left">Right</td>
2015-02-26 11:39:35 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left">Bottom left</td>
<td class="left">Bottom middle</td>
2015-02-26 11:39:35 +01:00
<td class="left">&#xa0;</td>
</tr>
</tbody>
</table>
</div>
2015-02-27 12:09:39 +01:00
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-27" class="outline-3">
<h3 id="unnumbered-27">Table placement</h3>
<div class="outline-text-3" id="text-unnumbered-27">
2015-02-26 11:39:35 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-meta-line">#+ATTR_LATEX: :center nil</span>
<span class="org-org-table">| a | b |</span>
<span class="org-org-table">| 1 | 2 |</span>
2015-02-26 11:39:35 +01:00
</pre>
</div>
2015-02-27 12:09:39 +01:00
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<colgroup>
<col class="right" />
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<col class="right" />
</colgroup>
<tbody>
<tr>
<td class="right">a</td>
<td class="right">b</td>
</tr>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<tr>
<td class="right">1</td>
<td class="right">2</td>
</tr>
</tbody>
</table>
<p>
XXX Different from the following:
2015-02-26 10:15:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-table">| a | b |</span>
<span class="org-org-table">| 1 | 2 |</span>
</pre>
</div>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="right" />
<col class="right" />
</colgroup>
<tbody>
<tr>
<td class="right">a</td>
<td class="right">b</td>
</tr>
<tr>
<td class="right">1</td>
<td class="right">2</td>
</tr>
</tbody>
</table>
2015-02-26 10:15:13 +01:00
</div>
2015-02-26 11:39:35 +01:00
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-28" class="outline-3">
<h3 id="unnumbered-28">Align tables on the page</h3>
<div class="outline-text-3" id="text-unnumbered-28">
2015-02-26 10:15:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Here is a table on the left side:
2015-02-26 11:39:35 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line">#+LATEX:</span> <span class="org-org-block">\noindent</span>
<span class="org-org-meta-line">#+ATTR_LATEX: :center nil</span>
<span class="org-org-table">| a | b | c |</span>
<span class="org-org-table">|---+---+---|</span>
<span class="org-org-table">| 1 | 2 | 3 |</span>
<span class="org-org-table">| 4 | 5 | 6 |</span>
<span class="org-org-meta-line">#+LATEX:</span> <span class="org-org-block">\hfill</span>
</pre>
2015-02-26 11:39:35 +01:00
</div>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
2015-02-27 12:09:39 +01:00
<col class="right" />
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<col class="right" />
<col class="right" />
2015-02-26 11:39:35 +01:00
</colgroup>
<thead>
<tr>
2015-02-27 12:09:39 +01:00
<th scope="col" class="right">a</th>
<th scope="col" class="right">b</th>
<th scope="col" class="right">c</th>
2015-02-26 11:39:35 +01:00
</tr>
</thead>
<tbody>
<tr>
2015-02-27 12:09:39 +01:00
<td class="right">1</td>
<td class="right">2</td>
<td class="right">3</td>
2015-02-26 11:39:35 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="right">4</td>
<td class="right">5</td>
<td class="right">6</td>
2015-02-26 11:39:35 +01:00
</tr>
2015-02-27 12:09:39 +01:00
</tbody>
</table>
<p>
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.
</p>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<p>
Here is a centered table:
</p>
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-table">| a | b | c |</span>
<span class="org-org-table">|---+---+---|</span>
<span class="org-org-table">| 1 | 2 | 3 |</span>
<span class="org-org-table">| 4 | 5 | 6 |</span>
</pre>
</div>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<colgroup>
<col class="right" />
<col class="right" />
<col class="right" />
</colgroup>
<thead>
2015-02-26 11:39:35 +01:00
<tr>
2015-02-27 12:09:39 +01:00
<th scope="col" class="right">a</th>
<th scope="col" class="right">b</th>
<th scope="col" class="right">c</th>
2015-02-26 11:39:35 +01:00
</tr>
2015-02-27 12:09:39 +01:00
</thead>
<tbody>
2015-02-26 11:39:35 +01:00
<tr>
2015-02-27 12:09:39 +01:00
<td class="right">1</td>
<td class="right">2</td>
<td class="right">3</td>
2015-02-26 11:39:35 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="right">4</td>
<td class="right">5</td>
<td class="right">6</td>
2015-02-26 11:39:35 +01:00
</tr>
2015-02-27 12:09:39 +01:00
</tbody>
</table>
<p>
And here&rsquo;s a table on the right side:
</p>
<div class="org-src-container">
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-meta-line">#+LATEX:</span> <span class="org-org-block">\hfill</span>
<span class="org-org-meta-line">#+ATTR_LATEX: :center nil</span>
<span class="org-org-table">| a | b | c |</span>
<span class="org-org-table">|---+---+---|</span>
<span class="org-org-table">| 1 | 2 | 3 |</span>
<span class="org-org-table">| 4 | 5 | 6 |</span>
</pre>
</div>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="right" />
<col class="right" />
<col class="right" />
</colgroup>
<thead>
2015-02-26 11:39:35 +01:00
<tr>
2015-02-27 12:09:39 +01:00
<th scope="col" class="right">a</th>
<th scope="col" class="right">b</th>
<th scope="col" class="right">c</th>
2015-02-26 11:39:35 +01:00
</tr>
2015-02-27 12:09:39 +01:00
</thead>
<tbody>
2015-02-26 11:39:35 +01:00
<tr>
2015-02-27 12:09:39 +01:00
<td class="right">1</td>
<td class="right">2</td>
<td class="right">3</td>
2015-02-26 11:39:35 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="right">4</td>
<td class="right">5</td>
<td class="right">6</td>
2015-02-26 11:39:35 +01:00
</tr>
</tbody>
</table>
2015-02-27 12:09:39 +01:00
<p>
Here the hfill adds infinite stretch before the table, so it pushes the table
to the right.
</p>
</div>
</div>
<div id="outline-container-unnumbered-29" class="outline-3">
<h3 id="unnumbered-29">Table size</h3>
<div class="outline-text-3" id="text-unnumbered-29">
2015-02-26 11:39:35 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-meta-line">#+ATTR_HTML: :width 100%</span>
<span class="org-org-table">| Cell in column 1, row 1 | Cell in column 2, row 1 |</span>
<span class="org-org-table">| Cell in column 1, row 2 | Cell in column 2, row 2 |</span>
2015-02-26 11:39:35 +01:00
</pre>
</div>
2015-02-27 12:09:39 +01:00
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides" width="100%">
2015-02-26 11:39:35 +01:00
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<colgroup>
<col class="left" />
<col class="left" />
</colgroup>
<tbody>
<tr>
<td class="left">Cell in column 1, row 1</td>
<td class="left">Cell in column 2, row 1</td>
</tr>
<tr>
<td class="left">Cell in column 1, row 2</td>
<td class="left">Cell in column 2, row 2</td>
</tr>
</tbody>
</table>
2015-02-24 12:08:13 +01:00
</div>
</div>
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-links" class="outline-2">
<h2 id="links"><a id="unnumbered-30"></a>Links</h2>
<div class="outline-text-2" id="text-links">
2015-02-26 11:39:35 +01:00
<p>
2015-02-27 12:09:39 +01:00
This document is available in <a href="org-mode-syntax.html">plain text</a>, <a href="org-mode-syntax.html">HTML</a> and <a href="org-mode-syntax.pdf">PDF</a>.
2015-02-26 11:39:35 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
The links are delimited by <code>[square brackets]</code>.
2015-02-26 11:39:35 +01:00
</p>
2015-02-27 12:09:39 +01:00
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-31" class="outline-3">
<h3 id="unnumbered-31">External links</h3>
<div class="outline-text-3" id="text-unnumbered-31">
2015-02-26 11:39:35 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org">See <span class="org-org-link"><a href="http://www.pirilampo.org">http://www.pirilampo.org</a></span> (automatic!) and the
<span class="org-org-link"><a href="http://orgmode.org/">Org mode Web site</a></span>.
2015-02-26 11:39:35 +01:00
</pre>
2015-02-24 12:08:13 +01:00
</div>
2015-02-27 12:09:39 +01:00
<p>
See <a href="http://www.pirilampo.org/">http://www.pirilampo.org/</a> (automatic!) and the
<a href="http://orgmode.org/">Org mode Web site</a>.
2015-02-26 11:39:35 +01:00
</p>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-32" class="outline-4">
<h4 id="unnumbered-32">Relative links</h4>
<div class="outline-text-4" id="text-unnumbered-32">
2015-02-26 10:15:13 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-link"><a href="../README.html">Home</a></span>
2015-02-26 10:15:13 +01:00
</pre>
</div>
<p>
2015-02-27 12:09:39 +01:00
<a href="../README.html">Home</a>
2015-02-26 10:15:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
</div>
</div>
<div id="outline-container-unnumbered-33" class="outline-4">
<h4 id="unnumbered-33">Email links</h4>
<div class="outline-text-4" id="text-unnumbered-33">
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-link"><a href="mailto:concat.fni.at-sign.pirilampo.org">Mailto link</a></span>
</pre>
</div>
2015-02-26 10:15:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
<a href="mailto:concat.fni.at-sign.pirilampo.org">Mailto link</a>
2015-02-26 10:15:13 +01:00
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-34" class="outline-3">
<h3 id="unnumbered-34"><a id="ID-0d2b0cb2-116c-4a61-a076-4c641faf4346"></a>Internal links</h3>
<div class="outline-text-3" id="text-unnumbered-34">
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-35" class="outline-4">
<h4 id="unnumbered-35">Inline anchors</h4>
<div class="outline-text-4" id="text-unnumbered-35">
2015-02-26 10:15:13 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-target">&lt;&lt;anchor&gt;&gt;</span> Inline anchors make arbitrary content referenceable.
Use a <span class="org-org-link"><a href="anchor">cross reference</a></span> to link to this location.
2015-02-26 10:15:13 +01:00
</pre>
</div>
<p>
2015-02-27 12:09:39 +01:00
<a id="anchor"></a> Inline anchors make arbitrary content referenceable.
2015-02-26 10:15:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
Use a <a href="#anchor">cross reference</a> to link to this location.
2015-02-26 10:15:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
</div>
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-36" class="outline-4">
<h4 id="unnumbered-36">Internal cross references</h4>
<div class="outline-text-4" id="text-unnumbered-36">
2015-02-26 10:15:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Links generally point to an headline.
2015-02-26 10:15:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
They can also point to a link anchor <a id="name-of-anchor-here"></a> in the current
document or in another document.
2015-02-26 10:15:13 +01:00
</p>
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org">See:
- Chapter <span class="org-org-link"><a href="#links">Links</a></span>
- Section <span class="org-org-link"><a href="id:0d2b0cb2-116c-4a61-a076-4c641faf4346">Anchors</a></span>
- <span class="org-org-link"><a href="name-of-anchor-here">Target in the document</a></span>
2015-02-26 10:15:13 +01:00
</pre>
</div>
2015-02-27 12:09:39 +01:00
<p>
See:
</p>
<ul class="org-ul">
<li>Chapter <a href="#links">Links</a></li>
<li>Section <a href="#unnumbered-34">Anchors</a></li>
<li><a href="#name-of-anchor-here">Target in the document</a></li>
</ul>
</div>
</div>
2015-02-26 10:15:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-37" class="outline-2">
<h2 id="unnumbered-37">Images</h2>
<div class="outline-text-2" id="text-unnumbered-37">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
You can insert <b>image</b> files of different <b>formats</b> to a document:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<colgroup>
<col class="left" />
<col class="left" />
<col class="left" />
</colgroup>
<thead>
<tr>
<th scope="col" class="left">&#xa0;</th>
<th scope="col" class="left">HTML</th>
<th scope="col" class="left">PDF</th>
</tr>
</thead>
<tbody>
<tr>
<td class="left">gif</td>
<td class="left">yes</td>
<td class="left">&#xa0;</td>
</tr>
<tr>
<td class="left">jpeg</td>
<td class="left">yes</td>
<td class="left">&#xa0;</td>
</tr>
<tr>
<td class="left">png</td>
<td class="left">yes</td>
<td class="left">&#xa0;</td>
</tr>
<tr>
<td class="left">bmp</td>
<td class="left">(depends on browser support)</td>
<td class="left">&#xa0;</td>
</tr>
</tbody>
</table>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-38" class="outline-3">
<h3 id="unnumbered-38">Inline picture</h3>
<div class="outline-text-3" id="text-unnumbered-38">
2015-02-24 12:08:13 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-meta-line">#+CAPTION: Org mode logo</span>
<span class="org-org-link"><a href="file:org-mode-unicorn.png">file:org-mode-unicorn.png</a></span>
2015-02-24 12:08:13 +01:00
</pre>
</div>
2015-02-27 12:09:39 +01:00
<div class="figure">
<p><img src="org-mode-unicorn.png" alt="org-mode-unicorn.png" />
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<p><span class="figure-number">Figure 1:</span> Org mode logo</p>
</div>
2015-02-24 12:08:13 +01:00
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org">Click to see the <span class="org-org-link"><a href="file:org-mode-unicorn.png">Unicorn picture</a></span>.
2015-02-24 12:08:13 +01:00
</pre>
</div>
<p>
2015-02-27 12:09:39 +01:00
Click to see the <a href="org-mode-unicorn.png">Unicorn picture</a>.
2015-02-24 12:08:13 +01:00
</p>
</div>
</div>
2015-02-26 11:39:35 +01:00
<div id="outline-container-unnumbered-39" class="outline-3">
2015-02-27 12:09:39 +01:00
<h3 id="unnumbered-39">Using positioning</h3>
2015-02-26 11:39:35 +01:00
<div class="outline-text-3" id="text-unnumbered-39">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
XXX Available HTML image tags include &#x2026;
2015-02-24 12:08:13 +01:00
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-40" class="outline-3">
<h3 id="unnumbered-40">Image attributes and values</h3>
<div class="outline-text-3" id="text-unnumbered-40">
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
2015-02-24 12:08:13 +01:00
<colgroup>
2015-02-27 12:09:39 +01:00
<col class="left" />
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<col class="left" />
2015-02-24 12:08:13 +01:00
</colgroup>
<thead>
<tr>
2015-02-27 12:09:39 +01:00
<th scope="col" class="left">Attribute</th>
<th scope="col" class="left">Value(s)</th>
2015-02-24 12:08:13 +01:00
</tr>
</thead>
<tbody>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:alt</code></td>
<td class="left">Alternate text</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:height</code></td>
<td class="left">&#xa0;</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:width</code></td>
<td class="left">User defined size in pixels</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:align</code></td>
<td class="left">&#xa0;</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:border</code></td>
<td class="left">&#xa0;</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:bordercolor</code></td>
<td class="left">&#xa0;</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:hspace</code></td>
<td class="left">&#xa0;</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:vspace</code></td>
<td class="left">&#xa0;</td>
2015-02-24 12:08:13 +01:00
</tr>
<tr>
2015-02-27 12:09:39 +01:00
<td class="left"><code>:title</code></td>
<td class="left">User defined text</td>
2015-02-24 12:08:13 +01:00
</tr>
</tbody>
</table>
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-meta-line">#+ATTR_LaTeX: :width 0.25\linewidth</span>
<span class="org-org-link"><a href="file:org-mode-unicorn.png">file:org-mode-unicorn.png</a></span>
2015-02-24 12:08:13 +01:00
</pre>
</div>
<div class="figure">
2015-02-27 12:09:39 +01:00
<p><img src="org-mode-unicorn.png" alt="org-mode-unicorn.png" />
</p>
</div>
<p>
Place images side by side: XXX
2015-02-24 12:08:13 +01:00
</p>
</div>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-41" class="outline-2">
<h2 id="unnumbered-41">Videos</h2>
<div class="outline-text-2" id="text-unnumbered-41">
<p>
Videos can&rsquo;t be added directly.
</p>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Though you can add an image with a link to the video like this:
2015-02-24 12:08:13 +01:00
</p>
<div class="org-src-container">
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-link"><a href="http://www.youtube.com/watch?v=DnSGSiXYuOk">file:../bigblow.png</a></span>
2015-02-24 12:08:13 +01:00
</pre>
</div>
2015-02-27 12:09:39 +01:00
<div class="figure">
<p><a href="http://www.youtube.com/watch?v=DnSGSiXYuOk"><img src="../bigblow.png" alt="bigblow.png" /></a>
</p>
2015-02-24 12:08:13 +01:00
</div>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-42" class="outline-2">
<h2 id="unnumbered-42">Admonitions</h2>
<div class="outline-text-2" id="text-unnumbered-42">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
You can create several other boxes (<code>info</code>, <code>tip</code>, <code>note</code> or <code>warning</code>) which all have
a different default image.
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
Admonitions: attention, caution, danger, error, hint, important, note, tip,
warning and the generic admonition.
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
(Most themes style only <code>note</code> and <code>warning</code> specially.)
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
Simple box (&ldquo;inline task&rdquo;):
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-hide">*************</span><span class="org-org-inlinetask">** </span><span class="org-org-todo">TODO</span><span class="org-org-inlinetask"> Do this task</span>
Description of inline task.
<span class="org-org-hide">*************</span><span class="org-org-inlinetask">** END</span>
</pre>
</div>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
<b><b><b><b><b><b><b>*</b></b></b></b></b></b></b> TODO Do this task
Description of inline task.
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<table class="inlinetask" width="100%"><tr><td valign="top"><b></b></td><td width="100%"><b>END</b><br /></td></tr></table>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
or:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-hide">*************</span><span class="org-org-inlinetask">** </span><span class="org-leuven-org-waiting-for-kwd">WAIT</span><span class="org-org-inlinetask"> </span><span class="ATTRLIST">[#B]</span><span class="org-org-inlinetask"> Do also this other task </span><span class="org-org-tag"><span class="org-org-inlinetask">:phone:</span></span>
<span class="org-org-hide">*************</span><span class="org-org-inlinetask">** END</span>
</pre>
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<p>
<b><b><b><b><b><b><b>*</b></b></b></b></b></b></b> WAIT [#B] Do also this other task :phone:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<table class="inlinetask" width="100%"><tr><td valign="top"><b></b></td><td width="100%"><b>END</b><br /></td></tr></table>
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-43" class="outline-3">
<h3 id="unnumbered-43">Note</h3>
<div class="outline-text-3" id="text-unnumbered-43">
<p>
A note box is displayed as follows:
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div class="note">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
<b>Note example</b> <br />
This is a useful note.
</p>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div class="seealso">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
<b>See also</b> <br />
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<dl class="org-dl">
<dt><a href="http://en.wikipedia.org/wiki/Apple">Apples</a></dt><dd>A kind of <a href="http://en.wikipedia.org/wiki/Fruit">fruit</a>.</dd>
</dl>
</div>
2015-02-26 11:39:35 +01:00
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
<div id="outline-container-unnumbered-44" class="outline-3">
2015-02-27 12:09:39 +01:00
<h3 id="unnumbered-44">Warning</h3>
2015-02-26 11:39:35 +01:00
<div class="outline-text-3" id="text-unnumbered-44">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
A warning box is displayed as follows:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="warning">
<p>
<b>Warning example</b> <br />
Be careful! Check that you have&#x2026;
</p>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
<div class="caution">
<p>
Caution
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
<div class="attention">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
Attention
</p>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
<div class="admonitiontodo">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
Admonitiontodo
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-45" class="outline-3">
<h3 id="unnumbered-45">Tip</h3>
<div class="outline-text-3" id="text-unnumbered-45">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
A tip box is displayed as follows:
</p>
<div class="tip">
<p>
<b>Tip example</b> <br />
Try doing it this way&#x2026;
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
2015-02-24 12:08:13 +01:00
</div>
2015-02-26 11:39:35 +01:00
<div class="important">
<p>
Important
</p>
2015-02-24 12:08:13 +01:00
</div>
2015-02-26 11:39:35 +01:00
<div class="hint">
<p>
Hint
</p>
2015-02-24 12:08:13 +01:00
</div>
2015-02-26 11:39:35 +01:00
<div class="success">
<p>
Success
</p>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
</div>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-46" class="outline-3">
<h3 id="unnumbered-46">Info</h3>
<div class="outline-text-3" id="text-unnumbered-46">
2015-02-26 11:39:35 +01:00
<p>
An info box is displayed as follows:
</p>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
<div class="info">
<p>
<b>Info example</b> <br />
Did you know&#x2026;
</p>
</div>
2015-02-24 12:08:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-47" class="outline-3">
<h3 id="unnumbered-47">Danger</h3>
<div class="outline-text-3" id="text-unnumbered-47">
2015-02-26 11:39:35 +01:00
<div class="danger">
<p>
Danger
</p>
</div>
<div class="error">
<p>
Error
</p>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-48" class="outline-3">
<h3 id="unnumbered-48">Neutral</h3>
<div class="outline-text-3" id="text-unnumbered-48">
2015-02-26 11:39:35 +01:00
<div class="neutral">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
Neutral
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
</div>
</div>
</div>
</div>
<div id="outline-container-unnumbered-49" class="outline-2">
<h2 id="unnumbered-49">Centered text</h2>
<div class="outline-text-2" id="text-unnumbered-49">
<div class="left">
<p>
This text is <br />
aligned to the left!
</p>
</div>
<div class="center">
<p>
This text is <br />
centered!
</p>
</div>
<div class="right">
<p>
This text is <br />
aligned to the right!
</p>
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-50" class="outline-2">
<h2 id="unnumbered-50">Sidebar</h2>
<div class="outline-text-2" id="text-unnumbered-50">
2015-02-26 11:39:35 +01:00
<p>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</p>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
<div class="sidebar">
<p>
2015-02-27 12:09:39 +01:00
Org mode was first released in 2004 (?) by Carsten Dominik. It was designed from
the start to be a shorthand syntax for producing professional documents like
LaTeX.
2015-02-26 11:39:35 +01:00
</p>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-26 11:39:35 +01:00
<p>
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac
turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor
sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies
mi vitae est. Mauris placerat eleifend leo. Quisque sit amet est et sapien
ullamcorper pharetra. Vestibulum erat wisi&#x2026;
</p>
<p>
Phasellus ut libero. Nulla in libero non enim tristique sollicitudin. Ut
tempor. Phasellus pellentesque augue eget ante. Mauris malesuada. Donec sit
amet diam sit amet dolor placerat blandit. Morbi enim purus, imperdiet in,
molestie sit amet, pellentesque eu, mauris. In vel erat vel ipsum bibendum
commodo. Curabitur accumsan. Nam sed metus. Etiam tristique bibendum justo.
</p>
2015-02-24 12:08:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-51" class="outline-2">
<h2 id="unnumbered-51">Example</h2>
<div class="outline-text-2" id="text-unnumbered-51">
2015-02-26 11:39:35 +01:00
<p>
2015-02-27 12:09:39 +01:00
You can have <code>example</code> blocks.
2015-02-26 11:39:35 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-code">: &gt; Useful for quotes</span>
<span class="org-org-code">: &gt; from email</span>
</pre>
2015-02-24 12:08:13 +01:00
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<pre class="example">
&gt; Useful for quotes
&gt; from email
</pre>
2015-02-26 11:39:35 +01:00
<p>
2015-02-27 12:09:39 +01:00
or
2015-02-26 11:39:35 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-block-begin-line">#+begin_example</span>
<span class="org-org-block">&gt; Useful for quotes</span>
<span class="org-org-block">&gt; from email</span>
<span class="org-org-block-end-line">#+end_example</span>
</pre>
</div>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<pre class="example">
&gt; Useful for quotes
&gt; from email
</pre>
</div>
2015-02-24 12:08:13 +01:00
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-52" class="outline-2">
<h2 id="unnumbered-52">Prose excerpts</h2>
<div class="outline-text-2" id="text-unnumbered-52">
</div><div id="outline-container-unnumbered-53" class="outline-3">
<h3 id="unnumbered-53">Quote</h3>
<div class="outline-text-3" id="text-unnumbered-53">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Use the <code>quote</code> block for content that <b>doesn&rsquo;t require the preservation of line
breaks</b>.
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-block-begin-line">#+begin_quote</span>
<span class="org-org-quote">Let us change our traditional attitude to the construction of programs:</span>
<span class="org-org-quote">Instead of imagining that our main task is to instruct a computer what to do,</span>
<span class="org-org-quote">let us concentrate rather on explaining to human beings what we want a</span>
<span class="org-org-quote">computer to do.</span>
<span class="org-org-quote">The practitioner of literate programming can be regarded as an essayist, whose</span>
<span class="org-org-quote">main concern is with exposition and excellence of style. Such an author, with</span>
<span class="org-org-quote">thesaurus in hand, chooses the names of variables carefully and explains what</span>
<span class="org-org-quote">each variable means. He or she strives for a program that is comprehensible</span>
<span class="org-org-quote">because its concepts have been introduced in an order that is best for human</span>
<span class="org-org-quote">understanding, using a mixture of formal and informal methods that reinforce</span>
<span class="org-org-quote">each other.</span>
<span class="org-org-quote">-- Donald Knuth</span>
<span class="org-org-block-end-line">#+end_quote</span>
</pre>
2015-02-24 12:08:13 +01:00
</div>
2015-02-27 12:09:39 +01:00
<blockquote>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
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.
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<p>
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.
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
&#x2013; Donald Knuth
</p>
</blockquote>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
A short one:
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-block-begin-line">#+begin_quote</span>
<span class="org-org-quote">Everything should be made as simple as possible,</span>
<span class="org-org-quote">but not any simpler. -- Albert Einstein</span>
<span class="org-org-block-end-line">#+end_quote</span>
</pre>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<blockquote>
<p>
Everything should be made as simple as possible,
but not any simpler. &#x2013; Albert Einstein
</p>
</blockquote>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-54" class="outline-3">
<h3 id="unnumbered-54">Verse</h3>
<div class="outline-text-3" id="text-unnumbered-54">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
In a <code>verse</code> environment, there is an <b>implicit line break at the end of each line</b>,
and <b>indentation</b> is preserved:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-block-begin-line">#+begin_verse</span>
<span class="org-org-verse">Everything should be made as simple as possible,</span>
<span class="org-org-verse">but not any simpler. -- Albert Einstein</span>
<span class="org-org-block-end-line">#+end_verse</span>
</pre>
</div>
<p class="verse">
Everything should be made as simple as possible,<br />
but not any simpler. &#x2013; Albert Einstein<br />
</p>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Typically used for quoting passages of an email message:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-block-begin-line">#+begin_verse</span>
<span class="org-org-verse">&gt;&gt; The meeting has been postponed to next Friday.</span>
<span class="org-org-verse">&gt;</span>
<span class="org-org-verse">&gt; Has the deadline for the report been moved too?</span>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<span class="org-org-verse">Yes. See <a href="http://www.doodle.com/">http://www.doodle.com/</a> for setting up a new meeting...</span>
<span class="org-org-block-end-line">#+end_verse</span>
</pre>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<p class="verse">
&gt;&gt; The meeting has been postponed to next Friday.<br />
&gt;<br />
&gt; Has the deadline for the report been moved too?<br />
<br />
Yes. See <a href="http://www.doodle.com/">http://www.doodle.com/</a> for setting up a new meeting&#x2026;<br />
</p>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-55" class="outline-3">
<h3 id="unnumbered-55">Block quote with optional attribution line</h3>
<div class="outline-text-3" id="text-unnumbered-55">
<div class="epigraph">
<p>
epigraph
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
</div>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-56" class="outline-3">
<h3 id="unnumbered-56">Block quotes with their own class attribute</h3>
<div class="outline-text-3" id="text-unnumbered-56">
<div class="highlights">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
highlights
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div class="pull-quote">
<p>
pull-quote
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div class="blockquote">
<p>
Blockquote
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
</div>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-57" class="outline-3">
<h3 id="unnumbered-57">Spaces</h3>
<div class="outline-text-3" id="text-unnumbered-57">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Using non-breaking spaces.
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<p>
Insert the Unicode character <code>00A0</code> to add a non-breaking space. FIXME
Or add/use an Org entity?
</p>
</div>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-58" class="outline-2">
<h2 id="unnumbered-58">Comments</h2>
<div class="outline-text-2" id="text-unnumbered-58">
<div class="org-src-container">
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-org">It's possible to add comments in the document.
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<span class="org-comment"># This Org comment here won't be displayed.</span>
</pre>
2015-02-24 12:08:13 +01:00
</div>
<p>
2015-02-27 12:09:39 +01:00
It&rsquo;s possible to add comments in the document.
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-59" class="outline-2">
<h2 id="unnumbered-59">Substitutions</h2>
<div class="outline-text-2" id="text-unnumbered-59">
<div class="org-src-container">
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-org"><span class="org-org-meta-line">#+MACRO: longtext this very very long text</span>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
Insert <span class="org-org-macro">longtext</span> wherever required.
</pre>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
Insert this very very long text wherever required.
</p>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-60" class="outline-3">
<h3 id="unnumbered-60">Org macros</h3>
<div class="outline-text-3" id="text-unnumbered-60">
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line">#+MACRO: color @@html:&lt;span style="color: $1"&gt;$2&lt;/span&gt;@@</span>
<span class="org-org-macro">color(blue, This text is colored in blue.)</span>
<span class="org-org-macro">color(red, This other text is in red.)</span>
</pre>
</div>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
<span style="color: blue"> This text is colored in blue.</span>
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
<span style="color: red"> This other text is in red.</span>
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<p>
Find more macros on <a href="https://github.com/fniessen/org-macros">GitHub</a>.
</p>
</div>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-61" class="outline-2">
<h2 id="unnumbered-61">Source code</h2>
<div class="outline-text-2" id="text-unnumbered-61">
</div><div id="outline-container-unnumbered-62" class="outline-3">
<h3 id="unnumbered-62">Inline code</h3>
<div class="outline-text-3" id="text-unnumbered-62">
<div class="org-src-container">
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-org">Reference code like <span class="org-org-code">variables</span> or <span class="org-org-code">functions</span> inline.
</pre>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
Reference code like <code>variables</code> or <code>functions</code> inline.
</p>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
You can also evaluate code inline as follows: 1 + 1 is <code class="src src-R"><span class="org-ess-numbers">1</span> <span class="org-constant">+</span> <span class="org-ess-numbers">1</span>
</code> <code>2</code>.
</p>
</div>
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-63" class="outline-3">
<h3 id="unnumbered-63">Code block with syntax highlighting</h3>
<div class="outline-text-3" id="text-unnumbered-63">
<p>
The source code blocks support syntax highlighting:
</p>
<div class="org-src-container">
<pre class="src src-cpp"><span class="org-comment-delimiter">/*</span>
<span class="org-comment"> * Application that displays a "Hello" message to the standard output.</span>
<span class="org-comment"> */</span>
<span class="org-type">int</span> <span class="org-function-name">main</span>(<span class="org-type">int</span> <span class="org-variable-name">arc</span>, <span class="org-type">char</span> **<span class="org-variable-name">argv</span>)
{
printf(<span class="org-string">"Hello, %s!\n"</span>, (argc&gt;1) ? argv[1] : <span class="org-string">"World"</span>);
<span class="org-keyword">return</span> 0;
}
</pre>
</div>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
The following language strings are currently recognized:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<p>
Awk, C, R, Asymptote, Calc, Clojure, CSS, Ditaa, Dot, Emacs Lisp, Forth, Fortran, Gnuplot, Haskell, IO, J, Java, Javascript, LaTeX, Ledger, Lilypond, Lisp, Makefile, Maxima, Matlab, Mscgen, Ocaml, Octave, Org, Perl, Pico Lisp, PlantUML, Python, Ruby, Sass, Scala, Scheme, Screen, Shell Script, Shen, Sql, Sqlite, ebnf2ps.
</p>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
Code block with long lines:
</p>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<pre class="src src-emacs-lisp">testing testing testing testing testing testing testing testing testing testing
0 1 2 3 4 5 6 7 8 9
123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456
</pre>
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
For PDF (LaTeX), one solution is to surround the code block such as:
</p>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-R"><span class="org-ess-function-call">print</span><span class="org-builtin">(</span><span class="org-string">"This block is in scriptsize"</span><span class="org-builtin">)</span>
</pre>
</div>
<pre class="example">
This block is in scriptsize
</pre>
</div>
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-64" class="outline-3">
<h3 id="unnumbered-64">Line numbers</h3>
<div class="outline-text-3" id="text-unnumbered-64">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Both in <code>example</code> and in <code>src</code> snippets, you can add a <code>-n</code> switch to the end of the
<code>begin</code> line, to get the lines of the example numbered.
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span class="linenr">1: </span>(<span class="org-keyword">defun</span> <span class="org-function-name">org-xor</span> (a b)
<span class="linenr">2: </span> <span class="org-doc">"Exclusive or."</span>
</pre>
</div>
<p>
If you use a <code>+n</code> switch, the numbering from the previous numbered snippet will
be continued in the current one:
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span class="linenr">3: </span> (<span class="org-keyword">if</span> a (not b) b))
</pre>
</div>
<p>
In literal examples, Org will interpret strings like <code>(ref:name)</code> as labels, and
use them as targets for special hyperlinks like <code>[[(name)]]</code> (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.
</p>
<p>
You can also add a <code>-r</code> switch which removes the labels from the source code.
With the <code>-n</code> 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:
</p>
<div class="org-src-container">
<pre class="src src-emacs-lisp"><span id="coderef-sc" class="coderef-off"><span class="linenr">1: </span>(<span class="org-keyword">save-excursion</span> <span class="org-comment-delimiter">;</span></span>
<span id="coderef-jump" class="coderef-off"><span class="linenr">2: </span> (goto-char (point-min))) <span class="org-comment-delimiter">;</span></span>
</pre>
</div>
<p>
In line <a href="#coderef-sc"class="coderef" onmouseover="CodeHighlightOn(this, 'coderef-sc');" onmouseout="CodeHighlightOff(this, 'coderef-sc');">1</a>, we remember the current position. <a href="#coderef-jump"class="coderef" onmouseover="CodeHighlightOn(this, 'coderef-jump');" onmouseout="CodeHighlightOff(this, 'coderef-jump');">Line 2</a> jumps to
<code>point-min</code>.
</p>
</div>
</div>
<div id="outline-container-unnumbered-65" class="outline-3">
<h3 id="unnumbered-65">Special characters</h3>
<div class="outline-text-3" id="text-unnumbered-65">
<p>
Some of the widely used special characters (converted from text characters to
their typographically correct entitites):
</p>
</div>
<div id="outline-container-unnumbered-66" class="outline-4">
<h4 id="unnumbered-66">Accents</h4>
<div class="outline-text-4" id="text-unnumbered-66">
<div class="org-src-container">
<pre class="src src-org">- <span class="org-org-latex-and-related">\Agrave \Aacute</span>
</pre>
</div>
<ul class="org-ul">
<li>&Agrave; &Aacute;</li>
</ul>
</div>
</div>
<div id="outline-container-unnumbered-67" class="outline-4">
<h4 id="unnumbered-67">Punctuation</h4>
<div class="outline-text-4" id="text-unnumbered-67">
<div class="org-src-container">
<pre class="src src-org">- Dash: <span class="org-org-latex-and-related">\ndash \mdash</span>
- Marks: <span class="org-org-latex-and-related">\iexcl \iquest</span>
- Quotations: <span class="org-org-latex-and-related">\laquo \raquo</span>
- Miscellaneous: <span class="org-org-latex-and-related">\para \ordf</span>
</pre>
</div>
<ul class="org-ul">
<li>Dash: &ndash; &mdash;</li>
<li>Marks: &iexcl; &iquest;</li>
<li>Quotations: &laquo; &raquo;</li>
<li>Miscellaneous: &para; &ordf;</li>
</ul>
</div>
</div>
<div id="outline-container-unnumbered-68" class="outline-4">
<h4 id="unnumbered-68">Commercial symbols</h4>
<div class="outline-text-4" id="text-unnumbered-68">
<div class="org-src-container">
<pre class="src src-org">- Property marks: <span class="org-org-latex-and-related">\copy \reg</span>
- Currency: <span class="org-org-latex-and-related">\cent \EUR \yen \pound</span>
</pre>
</div>
<ul class="org-ul">
<li>Property marks: &copy; &reg;</li>
<li>Currency: &cent; &euro; &yen; &pound;</li>
</ul>
</div>
</div>
<div id="outline-container-unnumbered-69" class="outline-4">
<h4 id="unnumbered-69">Greek characters</h4>
<div class="outline-text-4" id="text-unnumbered-69">
<div class="org-src-container">
<pre class="src src-org">The Greek letters <span class="org-org-latex-and-related">\alpha,</span> <span class="org-org-latex-and-related">\beta,</span> and <span class="org-org-latex-and-related">\gamma </span>are used to denote angles.
</pre>
</div>
<p>
The Greek letters &alpha;, &beta;, and &gamma; are used to denote angles.
</p>
</div>
</div>
<div id="outline-container-unnumbered-70" class="outline-4">
<h4 id="unnumbered-70">Math characters</h4>
<div class="outline-text-4" id="text-unnumbered-70">
<div class="org-src-container">
<pre class="src src-org">- Science: <span class="org-org-latex-and-related">\pm \div</span>
- Arrows: <span class="org-org-latex-and-related">\to \rarr \larr \harr \rArr \lArr \hArr</span>
- Function names: <span class="org-org-latex-and-related">\arccos \cos</span>
- Signs and symbols: <span class="org-org-latex-and-related">\bull \star</span>
</pre>
</div>
<ul class="org-ul">
<li>Science: &plusmn; &divide;</li>
<li>Arrows: &rarr; &rarr; &larr; &harr; &rArr; &lArr; &hArr;</li>
<li>Function names: arccos cos</li>
<li>Signs and symbols: &bull; *</li>
</ul>
</div>
</div>
<div id="outline-container-unnumbered-71" class="outline-4">
<h4 id="unnumbered-71">Misc</h4>
<div class="outline-text-4" id="text-unnumbered-71">
<div class="org-src-container">
<pre class="src src-org"><span class="org-comment"># Smilies: \smiley \sad</span>
- Suits: <span class="org-org-latex-and-related">\clubs \spades</span>
</pre>
</div>
<ul class="org-ul">
<li>Suits: &clubs; &spades;</li>
</ul>
</div>
</div>
</div>
</div>
<div id="outline-container-unnumbered-72" class="outline-2">
<h2 id="unnumbered-72">Math</h2>
<div class="outline-text-2" id="text-unnumbered-72">
<p>
You can embed LaTeX math formatting in Org mode files.
</p>
</div>
<div id="outline-container-unnumbered-73" class="outline-3">
<h3 id="unnumbered-73">Inline math expressions</h3>
<div class="outline-text-3" id="text-unnumbered-73">
<p>
For <b>inline math</b> expressions, use <code>\(...\)</code>:
</p>
<div class="org-src-container">
<pre class="src src-org">The formula <span class="org-org-latex-and-related">\(a^2 + b^2 = c^2\)</span> has been discovered by Pythagoras.
</pre>
</div>
<p>
The formula \(a^2 + b^2 = c^2\) has been discovered by Pythagoras.
</p>
<div class="warning">
<p>
It&rsquo;s <i>not</i> advised to use the constructs <code>$...$</code> (both for Org and for MathJax).
</p>
</div>
</div>
</div>
<div id="outline-container-unnumbered-74" class="outline-3">
<h3 id="unnumbered-74">Math expressions in display mode</h3>
<div class="outline-text-3" id="text-unnumbered-74">
<p>
For mathematical expressions which you want to make <b>stand out, centered on their
own lines</b>, use <code>\[...\]</code>:
</p>
<div class="org-src-container">
<pre class="src src-org">The <span class="org-italic">Euler theorem</span>:
<span class="org-org-latex-and-related">\[</span>
<span class="org-org-latex-and-related">\int_0^\infty e-x^2 dx = {{\sqrt{\pi}} \over {2}}</span>
<span class="org-org-latex-and-related">\]</span>
LaTeX allows to inline such <span class="org-org-code">\[...\]</span> constructs (<span class="org-italic">quadratic formula</span>):
<span class="org-org-latex-and-related">\[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2a} \]</span>
</pre>
</div>
<p>
The <i>Euler theorem</i>:
</p>
<p>
\[
\int_0^\infty e^{-x^2} dx = {{\sqrt{\pi}} \over {2}}
\]
</p>
<p>
LaTeX allows to inline such <code>\[...\]</code> constructs (<i>quadratic formula</i>):
\[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2a} \]
</p>
<div class="warning">
<p>
<b>Double dollar signs (<code>$$</code>) should not be used</b>.
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
</div>
2015-02-26 10:15:13 +01:00
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-75" class="outline-3">
<h3 id="unnumbered-75">Equation numbers</h3>
<div class="outline-text-3" id="text-unnumbered-75">
<p>
Differently from <code>$...$</code> and <code>\(...\)</code>, an equation environment produces a <b>numbered</b>
equation to which you can add a label and reference the equation by (label) name
in other parts of the text. This is not possibly with unnumbered math
environments (<code>$$</code>, &#x2026;).
</p>
<div class="org-src-container">
<pre class="src src-org">The <span class="org-italic">Pythagoras theorem</span>:
<span class="org-org-meta-line">#+name: pythag</span>
<span class="org-org-latex-and-related">\begin{equation}</span>
<span class="org-org-latex-and-related">a^2 + b^2 = c^2</span>
<span class="org-org-latex-and-related">\end{equation}</span>
See equation <span class="org-org-link"><a href="pythag">pythag</a></span>.
The <span class="org-italic">sinus theorem</span> can then be written as the equation:
<span class="org-org-latex-and-related">\begin{equation}</span>
<span class="org-org-latex-and-related">\label{eqn:sinalpha}</span>
<span class="org-org-latex-and-related">\frac{\sin\alpha}{a}=\frac{\sin\beta}{b}</span>
<span class="org-org-latex-and-related">\end{equation}</span>
</pre>
2015-02-26 10:15:13 +01:00
</div>
2015-02-27 12:09:39 +01:00
<p>
The <i>Pythagoras theorem</i>:
</p>
\begin{equation}
a^2 + b^2 = c^2
\end{equation}
<p>
See equation <a href="#pythag">1</a>.
</p>
<p>
The <i>sinus theorem</i> can then be written as the equation:
</p>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
\begin{equation}
\label{eqn:sinalpha}
\frac{\sin\alpha}{a}=\frac{\sin\beta}{b}
\end{equation}
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<p>
Only captioned equations are numbered.
</p>
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
Other alternative: use \begin{equation*} or \begin{displaymath} (= the verbose
form of the <code>\[...\]</code> construct). M-q does not fill those.
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
</div>
2015-02-26 10:15:13 +01:00
</div>
2015-02-27 12:09:39 +01:00
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-76" class="outline-2">
<h2 id="unnumbered-76">Miscellaneous effects</h2>
<div class="outline-text-2" id="text-unnumbered-76">
</div><div id="outline-container-unnumbered-77" class="outline-3">
<h3 id="unnumbered-77">Include Org files</h3>
<div class="outline-text-3" id="text-unnumbered-77">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
You can include another Org file and skip its title by using the <code>:lines</code> argument
to <code>#+INCLUDE</code>:
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line">#+INCLUDE: chapter1.org :lines "2-"</span>
</pre>
2015-02-26 10:15:13 +01:00
</div>
2015-02-26 11:39:35 +01:00
<div class="note">
2015-02-26 10:15:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
File inclusion, through INCLUDE keywords, is an <b>export-only feature</b>.
2015-02-26 10:15:13 +01:00
</p>
2015-02-24 12:08:13 +01:00
</div>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-78" class="outline-3">
<h3 id="unnumbered-78">Inline HTML</h3>
<div class="outline-text-3" id="text-unnumbered-78">
2015-02-26 10:15:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
You can include raw HTML in your Org documents and it will get kept as HTML
when it&rsquo;s exported. XXX
2015-02-26 10:15:13 +01:00
</p>
<p>
2015-02-26 11:39:35 +01:00
Text can be preformatted (in a fixed-width font).
2015-02-26 10:15:13 +01:00
</p>
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
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.
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-26 11:39:35 +01:00
Similarly, you can incorporate JS or do anything else you can do in a Web page
(such as importing a CSS file).
2015-02-26 10:15:13 +01:00
</p>
<p>
2015-02-26 11:39:35 +01:00
You can create named classes (to get style control from your CSS) with:
2015-02-26 10:15:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
<pre class="example">
#+begin_note
*Note example* \\
Did you know...
#+end_note
</pre>
2015-02-26 10:15:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
You can also add interactive elements to the HTML such as interactive R plots.
2015-02-24 12:08:13 +01:00
</p>
2015-02-26 10:15:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
Finally, you can include an HTML file verbatim (during export) with:
2015-02-26 10:15:13 +01:00
</p>
2015-02-26 11:39:35 +01:00
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line">#+INCLUDE: file.html html</span>
</pre>
2015-02-24 12:08:13 +01:00
</div>
2015-02-26 10:15:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
Don&rsquo;t edit the exported HTML file!
2015-02-26 10:15:13 +01:00
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-79" class="outline-3">
<h3 id="unnumbered-79">Inline LaTeX</h3>
<div class="outline-text-3" id="text-unnumbered-79">
2015-02-24 12:08:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
You can also use raw LaTeX. XXX
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-26 11:39:35 +01:00
Text can be preformatted (in a fixed-width font).
2015-02-24 12:08:13 +01:00
</p>
</div>
2015-02-26 10:15:13 +01:00
</div>
2015-02-24 12:08:13 +01:00
</div>
2015-02-26 10:15:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-80" class="outline-2">
<h2 id="unnumbered-80">Notes at the footer</h2>
<div class="outline-text-2" id="text-unnumbered-80">
2015-02-26 10:15:13 +01:00
<div class="org-src-container">
2015-02-26 11:39:35 +01:00
<pre class="src src-org">It is possible to define named footnotes<span class="org-org-footnote">[fn:myfootnote]</span>, or ones with automatic
anchors<span class="org-org-footnote">[fn:2]</span>.
2015-02-26 10:15:13 +01:00
</pre>
2015-02-24 12:08:13 +01:00
</div>
2015-02-26 10:15:13 +01:00
<p>
2015-02-26 11:39:35 +01:00
It is possible to define named footnotes<sup><a id="fnr.1" class="footref" href="#fn.1">1</a></sup>, or ones with automatic
anchors<sup><a id="fnr.2" class="footref" href="#fn.2">2</a></sup>.
2015-02-26 10:15:13 +01:00
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-81" class="outline-2">
<h2 id="unnumbered-81">Useful extensions</h2>
<div class="outline-text-2" id="text-unnumbered-81">
</div><div id="outline-container-unnumbered-82" class="outline-3">
<h3 id="unnumbered-82">Todo extension</h3>
<div class="outline-text-3" id="text-unnumbered-82">
</div><div id="outline-container-unnumbered-83" class="outline-4">
<h4 id="unnumbered-83">Dates</h4>
<div class="outline-text-4" id="text-unnumbered-83">
2015-02-24 12:08:13 +01:00
<p>
Timestamps: <span class="timestamp-wrapper"><span class="timestamp">[2014-01-16 Thu] </span></span> and <span class="timestamp-wrapper"><span class="timestamp">&lt;2014-01-16 Thu&gt;</span></span>.
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-84" class="outline-4">
<h4 id="unnumbered-84"><span class="todo TODO">TODO</span> We need to achieve&#x2026;</h4>
</div>
<div id="outline-container-unnumbered-85" class="outline-4">
<h4 id="unnumbered-85"><span class="done DONE">DONE</span> <span class="priority">[A]</span> Buy GTD book&#xa0;&#xa0;&#xa0;<span class="tag"><span class="online">online</span></span></h4>
<div class="outline-text-4" id="text-unnumbered-85">
2015-02-24 12:08:13 +01:00
<p>
By default, <code>DONE</code> actions will be collapsed.
</p>
<p>
Note that I should probably implement that default behavior only for <code>ARCHIVE</code>&rsquo;d
items.
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-86" class="outline-4">
<h4 id="unnumbered-86"><span class="todo TODO">TODO</span> <span class="priority">[A]</span> Read GTD book</h4>
<div class="outline-text-4" id="text-unnumbered-86">
2015-02-24 12:08:13 +01:00
<p><span class="timestamp-wrapper"><span class="timestamp-kwd">SCHEDULED:</span> <span class="timestamp"><2014-09-11 Thu></span></span></p>
<p>
By default, <b>all</b> (active) entries will be expanded at page load, so that their
contents is visible.
</p>
<p>
That can be changed by adding such a line (into your Org document):
</p>
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-meta-line">#+HTML_HEAD: &lt;script&gt; var HS_STARTUP_FOLDED = true; &lt;/script&gt;</span>
</pre>
</div>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-87" class="outline-4 hsCollapsed">
<h4 id="unnumbered-87"><span class="todo TODO">TODO</span> <span class="priority">[B]</span> Apply GTD methodoloy</h4>
<div class="outline-text-4" id="text-unnumbered-87">
2015-02-24 12:08:13 +01:00
<p><span class="timestamp-wrapper"><span class="timestamp-kwd">DEADLINE:</span> <span class="timestamp"><2014-12-01 Mon></span></span></p>
<p>
This section will be collapsed when loading the page because the entry has the
value <code>hsCollapsed</code> for the property <code>:HTML_CONTAINER_CLASS:</code>.
</p>
<p>
Powerful, no?
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-88" class="outline-4">
<h4 id="unnumbered-88">Some note&#xa0;&#xa0;&#xa0;<span class="tag"><span class="computer">computer</span>&#xa0;<span class="write">write</span></span></h4>
<div class="outline-text-4" id="text-unnumbered-88">
2015-02-24 12:08:13 +01:00
<p>
You can add tags to any entry, and hightlight all entries having some specific
tag by clicking on the buttons made accessible to you in the &ldquo;Dashboard&rdquo;.
</p>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-89" class="outline-4">
<h4 id="unnumbered-89">Weekly review&#xa0;&#xa0;&#xa0;<span class="tag"><span class="computer">computer</span></span></h4>
<div class="outline-text-4" id="text-unnumbered-89">
2015-02-24 12:08:13 +01:00
<p>
Now, you can even make your weekly review in the HTML export&#x2026; Press the <code>r</code> key
to start entering the &ldquo;review mode&rdquo; where all but one active entry are
collapsed, so that you can really focus on one item at a time!
</p>
</div>
</div>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-90" class="outline-3">
<h3 id="unnumbered-90">Bigblow extension</h3>
<div class="outline-text-3" id="text-unnumbered-90">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
The string <code>fixme</code> (in <b>upper case</b>) gets replaced by a &ldquo;Fix Me!&rdquo; image:
</p>
<div class="org-src-container">
<pre class="src src-org"><span class="org-leuven-highlight">FIXME</span> Delete this...
</pre>
</div>
<p>
FIXME Delete this&#x2026;
</p>
</div>
</div>
</div>
<div id="outline-container-unnumbered-91" class="outline-2">
<h2 id="unnumbered-91">Graphs with Graphviz</h2>
<div class="outline-text-2" id="text-unnumbered-91">
<p>
To enable the Graphviz extension, we have to add it to the extensions list in
conf.py:
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
extensions = [&lsquo;sphinx.est.graphviz&rsquo;]
2015-02-24 12:08:13 +01:00
</p>
<p>
2015-02-27 12:09:39 +01:00
It uses directly the dot command to process DOT language.
2015-02-24 12:08:13 +01:00
</p>
</div>
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-92" class="outline-3">
<h3 id="unnumbered-92">Undirected</h3>
<div class="outline-text-3" id="text-unnumbered-92">
<div class="org-src-container">
<pre class="src src-org"><span class="org-org-block-begin-line">#+begin_src dot :file graph.png :cmdline -Tpng</span>
graph <span class="org-function-name">foo</span> {
<span class="org-string">"bar"</span> -- <span class="org-string">"baz"</span>;
}
<span class="org-org-block-end-line">#+end_src</span>
</pre>
</div>
<div class="org-src-container">
<pre class="src src-dot">graph <span class="org-function-name">foo</span> {
<span class="org-string">"bar"</span> -- <span class="org-string">"baz"</span>;
}
</pre>
2015-02-24 12:08:13 +01:00
</div>
2015-02-27 12:09:39 +01:00
<div class="figure">
<p><img src="graph.png" alt="graph.png" />
</p>
</div>
</div>
</div>
<div id="outline-container-unnumbered-93" class="outline-3">
<h3 id="unnumbered-93">Directed</h3>
<div class="outline-text-3" id="text-unnumbered-93">
<div class="org-src-container">
<pre class="src src-dot">digraph <span class="org-function-name">foo</span> {
<span class="org-string">"bar"</span> -&gt; <span class="org-string">"baz"</span>;
}
</pre>
</div>
<div class="figure">
<p><img src="digraph.png" alt="digraph.png" />
</p>
</div>
</div>
</div>
</div>
<div id="outline-container-unnumbered-94" class="outline-2">
<h2 id="unnumbered-94">Graphs with R</h2>
<div class="outline-text-2" id="text-unnumbered-94">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
The output from the <b>execution</b> of programs, scripts or commands can be inserted
in the document itself, allowing you to work in the <i>reproducible research</i>
mindset.
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
</div>
2015-02-24 12:08:13 +01:00
2015-02-27 12:09:39 +01:00
<div id="outline-container-unnumbered-95" class="outline-3">
<h3 id="unnumbered-95">Text</h3>
<div class="outline-text-3" id="text-unnumbered-95">
2015-02-24 12:08:13 +01:00
<p>
2015-02-27 12:09:39 +01:00
A one-liner result:
</p>
<div class="org-src-container">
<pre class="src src-shell">date +<span class="org-string">"%Y-%m-%d"</span>
</pre>
</div>
<pre class="example">
2015-02-27
</pre>
</div>
</div>
<div id="outline-container-unnumbered-96" class="outline-3">
<h3 id="unnumbered-96">Example</h3>
<div class="outline-text-3" id="text-unnumbered-96">
<p>
Data to be charted:
</p>
<table id="data" border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<colgroup>
<col class="right" />
<col class="right" />
</colgroup>
<thead>
<tr>
<th scope="col" class="right">Month</th>
<th scope="col" class="right">Degrees</th>
</tr>
</thead>
<tbody>
<tr>
<td class="right">1</td>
<td class="right">3.8</td>
</tr>
<tr>
<td class="right">2</td>
<td class="right">4.1</td>
</tr>
<tr>
<td class="right">3</td>
<td class="right">6.3</td>
</tr>
<tr>
<td class="right">4</td>
<td class="right">9.0</td>
</tr>
<tr>
<td class="right">5</td>
<td class="right">11.9</td>
</tr>
<tr>
<td class="right">6</td>
<td class="right">15.1</td>
</tr>
<tr>
<td class="right">7</td>
<td class="right">17.1</td>
</tr>
<tr>
<td class="right">8</td>
<td class="right">17.4</td>
</tr>
<tr>
<td class="right">9</td>
<td class="right">15.7</td>
</tr>
<tr>
<td class="right">10</td>
<td class="right">11.8</td>
</tr>
<tr>
<td class="right">11</td>
<td class="right">7.7</td>
</tr>
<tr>
<td class="right">12</td>
<td class="right">4.8</td>
</tr>
</tbody>
</table>
<p>
Code:
</p>
<div class="org-src-container">
<pre class="src src-R" id="R-plot"><span class="org-ess-function-call">plot</span><span class="org-builtin">(</span>data, type<span class="org-constant">=</span><span class="org-string">"b"</span>, bty<span class="org-constant">=</span><span class="org-string">"l"</span>, col<span class="org-constant">=</span><span class="org-ess-function-call">c</span><span class="org-builtin">(</span><span class="org-string">"#ABD249"</span><span class="org-builtin">)</span>, las<span class="org-constant">=</span><span class="org-ess-numbers">1</span>, lwd<span class="org-constant">=</span><span class="org-ess-numbers">4</span><span class="org-builtin">)</span>
<span class="org-ess-function-call">grid</span><span class="org-builtin">(</span>nx<span class="org-constant">=</span><span class="org-type">NULL</span>, ny<span class="org-constant">=</span><span class="org-type">NULL</span>, col<span class="org-constant">=</span><span class="org-ess-function-call">c</span><span class="org-builtin">(</span><span class="org-string">"#E8E8E8"</span><span class="org-builtin">)</span>, lwd<span class="org-constant">=</span><span class="org-ess-numbers">1</span><span class="org-builtin">)</span>
<span class="org-ess-function-call">legend</span><span class="org-builtin">(</span><span class="org-string">"bottom"</span>, legend<span class="org-constant">=</span><span class="org-ess-function-call">c</span><span class="org-builtin">(</span><span class="org-string">"Degrees"</span><span class="org-builtin">)</span>, col<span class="org-constant">=</span><span class="org-ess-function-call">c</span><span class="org-builtin">(</span><span class="org-string">"#ABD249"</span><span class="org-builtin">)</span>, pch<span class="org-constant">=</span><span class="org-ess-function-call">c</span><span class="org-builtin">(</span><span class="org-ess-numbers">19</span><span class="org-builtin">))</span>
</pre>
</div>
</div>
</div>
<div id="outline-container-unnumbered-97" class="outline-3">
<h3 id="unnumbered-97">Graph</h3>
<div class="outline-text-3" id="text-unnumbered-97">
<p>
The resulting chart:
</p>
<div class="figure">
<p><img src="Rplot.png" alt="Rplot.png" />
</p>
</div>
</div>
</div>
<div id="outline-container-unnumbered-98" class="outline-3">
<h3 id="unnumbered-98">R code block</h3>
<div class="outline-text-3" id="text-unnumbered-98">
<div class="org-src-container">
<pre class="src src-R"><span class="org-constant">library</span><span class="org-builtin">(</span>ggplot2<span class="org-builtin">)</span>
<span class="org-ess-function-call">summary</span><span class="org-builtin">(</span>cars<span class="org-builtin">)</span>
</pre>
</div>
<p>
Plot:
2015-02-24 12:08:13 +01:00
</p>
2015-02-27 12:09:39 +01:00
<div class="org-src-container">
<pre class="src src-R"><span class="org-constant">library</span><span class="org-builtin">(</span>ggplot2<span class="org-builtin">)</span>
<span class="org-ess-function-call">qplot</span><span class="org-builtin">(</span>speed, dist, data <span class="org-constant">=</span> cars<span class="org-builtin">)</span> <span class="org-constant">+</span> <span class="org-ess-function-call">geom_smooth</span><span class="org-builtin">()</span>
</pre>
</div>
</div>
2015-02-24 12:08:13 +01:00
</div>
</div>
<div id="footnotes">
<h2 class="footnotes">Footnotes: </h2>
<div id="text-footnotes">
<div class="footdef"><sup><a id="fn.1" class="footnum" href="#fnr.1">1</a></sup> <p class="footpara">
Extensively used in large documents.
</p></div>
<div class="footdef"><sup><a id="fn.2" class="footnum" href="#fnr.2">2</a></sup> <p class="footpara">
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit
esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</p></div>
</div>
</div></div>
2015-02-26 11:39:35 +01:00
<div id="postamble" class="status">
<div id="footer"><div id="copyright">
Copyright &copy; Fabrice Niessen
</div></div>
</div>
2015-02-24 12:08:13 +01:00
</body>
</html>