Initial commit
This commit is contained in:
Fabrice Niessen
parent
621243531e
commit
816399241a
890
README.html
890
README.html
|
|
@ -1,530 +1,444 @@
|
|||
<!-- <xml version="1.0" encoding="utf-8"> -->
|
||||
|
||||
<?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>
|
||||
<meta name="generator" content=
|
||||
"HTML Tidy for Cygwin (vers 1st September 2004), see www.w3.org" />
|
||||
|
||||
<title></title>
|
||||
<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-HTML export made simple." />
|
||||
<meta name="keywords" content=
|
||||
"org-mode, export, html, theme, style, css, js, bigblow" />
|
||||
<link rel="stylesheet" type="text/css" href=
|
||||
"styles/bigblow/css/htmlize.css" />
|
||||
<link rel="stylesheet" type="text/css" href=
|
||||
"styles/bigblow/css/bigblow.css" />
|
||||
<link rel="stylesheet" type="text/css" href=
|
||||
"styles/bigblow/css/hideshow.css" />
|
||||
<script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js">
|
||||
</script>
|
||||
<script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js">
|
||||
</script>
|
||||
<script type="text/javascript" src=
|
||||
"styles/bigblow/js/jquery.localscroll-min.js">
|
||||
</script>
|
||||
<script type="text/javascript" src=
|
||||
"styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">
|
||||
</script>
|
||||
<script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js">
|
||||
</script>
|
||||
<script type="text/javascript" src="styles/bigblow/js/bigblow.js">
|
||||
</script>
|
||||
<script type="text/javascript" src="styles/bigblow/js/hideshow.js">
|
||||
</script>
|
||||
<title></title>
|
||||
<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-HTML export made simple."
|
||||
/>
|
||||
<meta name="keywords" content="org-mode, export, html, theme, style, css, js, bigblow" />
|
||||
<link rel="stylesheet" type="text/css" href="styles/rtd.css"/>
|
||||
<script type="text/javascript" src="styles/rtd.js"></script>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div id="content">
|
||||
<h1 class="title"></h1>
|
||||
|
||||
<div id="table-of-contents">
|
||||
<h2>Table of Contents</h2>
|
||||
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="#sec-1">1. Awesome HTML themes for files exported from Org
|
||||
mode</a>
|
||||
|
||||
<ul>
|
||||
<li>
|
||||
<a href="#sec-1-1">1.1. Overview</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="#unnumbered-1">Description</a></li>
|
||||
|
||||
<li><a href="#unnumbered-2">Objective</a></li>
|
||||
|
||||
<li><a href="#unnumbered-3">Requirements</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="#sec-1-2">1.2. Quotations</a></li>
|
||||
|
||||
<li>
|
||||
<a href="#sec-1-3">1.3. Gallery</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="#unnumbered-4">Bigblow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="#sec-1-4">1.4. Installing a theme</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="#unnumbered-5">Bigblow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li>
|
||||
<a href="#sec-1-5">1.5. Contributing</a>
|
||||
|
||||
<ul>
|
||||
<li><a href="#unnumbered-6">Issues</a></li>
|
||||
|
||||
<li><a href="#unnumbered-7">Patches</a></li>
|
||||
|
||||
<li><a href="#unnumbered-8">Donations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li><a href="#sec-1-6">1.6. License</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1" class="outline-2">
|
||||
<h2 id="sec-1"><span class="section-number-2">1</span> Awesome HTML
|
||||
themes for files exported from Org mode <a href=
|
||||
"http://opensource.org/licenses/GPL-3.0"><object type="image/svg+xml"
|
||||
data="http://img.shields.io/:license-gpl-blue.svg">
|
||||
Sorry, your browser does not support SVG.
|
||||
</object></a> <a href=
|
||||
"https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org-html-themes&currency_code=EUR&bn=PP-DonationsBF:btn_donate_LG.gif:NonHosted">
|
||||
<img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif"
|
||||
alt="btn_donate_LG.gif" /></a></h2>
|
||||
|
||||
<div class="outline-text-2" id="text-1"></div>
|
||||
|
||||
<div id="outline-container-sec-1-1" class="outline-3">
|
||||
<h3 id="sec-1-1"><span class="section-number-3">1.1</span>
|
||||
Overview</h3>
|
||||
|
||||
<div class="outline-text-3" id="text-1-1"></div>
|
||||
|
||||
<div id="outline-container-unnumbered-1" class="outline-4">
|
||||
<h4 id="unnumbered-1">Description</h4>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-1">
|
||||
<p>Org mode provides basic HTML support. Though, we can easily
|
||||
override CSS stylesheets and add our own HTML
|
||||
themes.</p><script src="http://platform.twitter.com/widgets.js"
|
||||
type="text/javascript">
|
||||
</script> <a href="https://twitter.com/share" class="twitter-share-button"
|
||||
data-via="f_niessen">Tweet</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-2" class="outline-4">
|
||||
<h4 id="unnumbered-2">Objective</h4>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-2">
|
||||
<p>The goal of the <b>Org-HMTL themes</b> is to provide you with a
|
||||
list of very nice (cross-browser) themes.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-3" class="outline-4">
|
||||
<h4 id="unnumbered-3">Requirements</h4>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-3">
|
||||
<p>Org mode version 8 (or later) is required.</p>
|
||||
|
||||
<p>If such a version is not bundled with your Emacs, install one
|
||||
from ELPA.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-2" class="outline-3">
|
||||
<h3 id="sec-1-2"><span class="section-number-3">1.2</span>
|
||||
Quotations</h3>
|
||||
|
||||
<div class="outline-text-3" id="text-1-2">
|
||||
<p>“Very very nice, I enjoy it a lot.”<br />
|
||||
– <i>Ista Zahn</i></p>
|
||||
|
||||
<p>“This is awesome. I love it!”<br />
|
||||
– <i>Rainer M Krug</i></p>
|
||||
|
||||
<p>“This is awesome!!”<br />
|
||||
– <i>Mehul Sanghvi</i></p>
|
||||
|
||||
<p>“This very nice html theme. […] I cannot use another emacs-theme
|
||||
than your <a href=
|
||||
"https://github.com/fniessen/emacs-leuven-theme">emacs-leuven-theme</a>,
|
||||
and it is going to be probably the same with your html theme!”<br />
|
||||
– <i>Joseph Vidal-Rosset</i></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-3" class="outline-3">
|
||||
<h3 id="sec-1-3"><a id="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4" name=
|
||||
"ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4"></a><span class=
|
||||
"section-number-3">1.3</span> Gallery</h3>
|
||||
|
||||
<div class="outline-text-3" id="text-1-3">
|
||||
<p>This is a list of available <b>HTML themes for Org mode</b>, which
|
||||
you can use right now! Well, I hope to have more than one in a couple
|
||||
of weeks…</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-4" class="outline-4">
|
||||
<h4 id="unnumbered-4">Bigblow</h4>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-4">
|
||||
<p>Bigblow is perfect for your work: it is a clean design aimed at
|
||||
optimal <b>Org mode experience in your browser</b>. It looks just
|
||||
awesome!</p>
|
||||
|
||||
<div class="figure">
|
||||
<p><a href="https://www.youtube.com/watch?v=DnSGSiXYuOk" width=
|
||||
"640"><img src="bigblow.png" alt="bigblow.png" width=
|
||||
"640" /></a></p>
|
||||
</div>
|
||||
|
||||
<p>Click on the image for a quick demo of Bigblow (2:49 min, no
|
||||
audio).</p>
|
||||
|
||||
<p>Keyboard shortcuts to save time and boost your productivity:</p>
|
||||
|
||||
<table border="2" cellspacing="0" cellpadding="6" rules="groups"
|
||||
frame="hsides">
|
||||
<colgroup>
|
||||
<col class="left" />
|
||||
<col class="left" />
|
||||
</colgroup>
|
||||
|
||||
<thead>
|
||||
<tr>
|
||||
<th scope="col" class="left">Shortcut</th>
|
||||
|
||||
<th scope="col" class="left">What it does</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="left"><code>?</code> or <code>h</code></td>
|
||||
|
||||
<td class="left">Access the <b>dashboard</b></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>n</code></td>
|
||||
|
||||
<td class="left">Move to the <b>next</b> main heading</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>p</code></td>
|
||||
|
||||
<td class="left">Move to the <b>previous</b> main
|
||||
heading</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>b</code></td>
|
||||
|
||||
<td class="left">Scroll up</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code><</code></td>
|
||||
|
||||
<td class="left">Scroll to top</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>></code></td>
|
||||
|
||||
<td class="left">Scroll to bottom</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>-</code></td>
|
||||
|
||||
<td class="left">Collapse all</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>+</code></td>
|
||||
|
||||
<td class="left">Expand all</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>r</code></td>
|
||||
|
||||
<td class="left">Go to next task in list</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>R</code></td>
|
||||
|
||||
<td class="left">Go to previous task in list</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>q</code></td>
|
||||
|
||||
<td class="left">Stop reviewing the list of tasks</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>g</code></td>
|
||||
|
||||
<td class="left">Reload the page</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-4" class="outline-3">
|
||||
<h3 id="sec-1-4"><span class="section-number-3">1.4</span> Installing a
|
||||
theme</h3>
|
||||
|
||||
<div class="outline-text-3" id="text-1-4">
|
||||
<p>Using a theme from the <a href="#sec-1-3">theme gallery</a> for
|
||||
your own Org documents is very easy: you just need to clone the
|
||||
Org-HTML themes project and add a <code>#+SETUPFILE:</code> directive
|
||||
in the preamble to include the CSS and JavaScript files.</p>
|
||||
|
||||
<p>You can either:</p>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>
|
||||
<p>copy the “setup file” of the chosen theme to the directory of
|
||||
your Org files,</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-org-meta-line">#+SETUPFILE: THEME-NAME.setup</span>
|
||||
<div id="content">
|
||||
<h1 class="title"></h1>
|
||||
<div id="table-of-contents">
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#sec-1">1. Awesome HTML themes for files exported from Org mode </a>
|
||||
<ul>
|
||||
<li><a href="#sec-1-1">1.1. Overview</a>
|
||||
<ul>
|
||||
<li><a href="#unnumbered-1">Description</a></li>
|
||||
<li><a href="#unnumbered-2">Objective</a></li>
|
||||
<li><a href="#unnumbered-3">Requirements</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#sec-1-2">1.2. Quotations</a></li>
|
||||
<li><a href="#sec-1-3">1.3. Gallery</a>
|
||||
<ul>
|
||||
<li><a href="#unnumbered-4">Bigblow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#sec-1-4">1.4. Installing a theme</a>
|
||||
<ul>
|
||||
<li><a href="#unnumbered-5">Bigblow</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#sec-1-5">1.5. Contributing</a>
|
||||
<ul>
|
||||
<li><a href="#unnumbered-6">Issues</a></li>
|
||||
<li><a href="#unnumbered-7">Patches</a></li>
|
||||
<li><a href="#unnumbered-8">Donations</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a href="#sec-1-6">1.6. License</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1" class="outline-2">
|
||||
<h2 id="sec-1"><span class="section-number-2">1</span> Awesome HTML themes for files exported from Org mode <a href="http://opensource.org/licenses/GPL-3.0"><object type="image/svg+xml" data="http://img.shields.io/:license-gpl-blue.svg" >
|
||||
Sorry, your browser does not support SVG.</object></a> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org-html-themes&currency_code=EUR&bn=PP-DonationsBF:btn_donate_LG.gif:NonHosted"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif" alt="btn_donate_LG.gif" /></a></h2>
|
||||
<div class="outline-text-2" id="text-1">
|
||||
</div><div id="outline-container-sec-1-1" class="outline-3">
|
||||
<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Overview</h3>
|
||||
<div class="outline-text-3" id="text-1-1">
|
||||
</div><div id="outline-container-unnumbered-1" class="outline-4">
|
||||
<h4 id="unnumbered-1">Description</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-1">
|
||||
<p>
|
||||
Org mode provides basic HTML support. Though, we can easily override CSS
|
||||
stylesheets and add our own HTML themes.
|
||||
</p>
|
||||
|
||||
<script src="http://platform.twitter.com/widgets.js"></script>
|
||||
<a href="https://twitter.com/share" class="twitter-share-button" data-via="f_niessen">Tweet</a>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-2" class="outline-4">
|
||||
<h4 id="unnumbered-2">Objective</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-2">
|
||||
<p>
|
||||
The goal of the <b>Org-HMTL themes</b> is to provide you with a list of very nice
|
||||
(cross-browser) themes.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-3" class="outline-4">
|
||||
<h4 id="unnumbered-3">Requirements</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-3">
|
||||
<p>
|
||||
Org mode version 8 (or later) is required.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
If such a version is not bundled with your Emacs, install one from ELPA.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-2" class="outline-3">
|
||||
<h3 id="sec-1-2"><span class="section-number-3">1.2</span> Quotations</h3>
|
||||
<div class="outline-text-3" id="text-1-2">
|
||||
<p>
|
||||
“Very very nice, I enjoy it a lot.” <br />
|
||||
– <i>Ista Zahn</i>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
“This is awesome. I love it!” <br />
|
||||
– <i>Rainer M Krug</i>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
“This is awesome!!” <br />
|
||||
– <i>Mehul Sanghvi</i>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
“This very nice html theme. […] I cannot use another emacs-theme than your
|
||||
<a href="https://github.com/fniessen/emacs-leuven-theme">emacs-leuven-theme</a>, and it is going to be probably the same with your html
|
||||
theme!” <br />
|
||||
– <i>Joseph Vidal-Rosset</i>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-3" class="outline-3">
|
||||
<h3 id="sec-1-3"><a id="ID-79e0ed21-c3b0-4f00-bdab-29fbff9dcad4"></a><span class="section-number-3">1.3</span> Gallery</h3>
|
||||
<div class="outline-text-3" id="text-1-3">
|
||||
<p>
|
||||
This is a list of available <b>HTML themes for Org mode</b>, which you can use right
|
||||
now! Well, I hope to have more than one in a couple of weeks…
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-4" class="outline-4">
|
||||
<h4 id="unnumbered-4">Bigblow</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-4">
|
||||
<p>
|
||||
Bigblow is perfect for your work: it is a clean design aimed at optimal <b>Org
|
||||
mode experience in your browser</b>. It looks just awesome!
|
||||
</p>
|
||||
|
||||
|
||||
<div class="figure">
|
||||
<p><a href="https://www.youtube.com/watch?v=DnSGSiXYuOk" width="640"><img src="bigblow.png" alt="bigblow.png" width="640" /></a>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Click on the image for a quick demo of Bigblow (2:49 min, no audio).
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Keyboard shortcuts to save time and boost your productivity:
|
||||
</p>
|
||||
|
||||
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
|
||||
|
||||
<colgroup>
|
||||
<col class="left" />
|
||||
|
||||
<col class="left" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr>
|
||||
<th scope="col" class="left">Shortcut</th>
|
||||
<th scope="col" class="left">What it does</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="left"><code>?</code> or <code>h</code></td>
|
||||
<td class="left">Access the <b>dashboard</b></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>n</code></td>
|
||||
<td class="left">Move to the <b>next</b> main heading</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>p</code></td>
|
||||
<td class="left">Move to the <b>previous</b> main heading</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>b</code></td>
|
||||
<td class="left">Scroll up</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code><</code></td>
|
||||
<td class="left">Scroll to top</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>></code></td>
|
||||
<td class="left">Scroll to bottom</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>-</code></td>
|
||||
<td class="left">Collapse all</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>+</code></td>
|
||||
<td class="left">Expand all</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>r</code></td>
|
||||
<td class="left">Go to next task in list</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>R</code></td>
|
||||
<td class="left">Go to previous task in list</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>q</code></td>
|
||||
<td class="left">Stop reviewing the list of tasks</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td class="left"><code>g</code></td>
|
||||
<td class="left">Reload the page</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-4" class="outline-3">
|
||||
<h3 id="sec-1-4"><span class="section-number-3">1.4</span> Installing a theme</h3>
|
||||
<div class="outline-text-3" id="text-1-4">
|
||||
<p>
|
||||
Using a theme from the <a href="#sec-1-3">theme gallery</a> for your own Org documents is very easy:
|
||||
you just need to clone the Org-HTML themes project and add a <code>#+SETUPFILE:</code>
|
||||
directive in the preamble to include the CSS and JavaScript files.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
You can either:
|
||||
</p>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li><p>
|
||||
copy the “setup file” of the chosen theme to the directory of your Org files,
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
|
||||
<pre class="src src-org"><span class="org-org-meta-line">#+SETUPFILE: THEME-NAME.setup</span>
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>or</p>
|
||||
</li>
|
||||
<p>
|
||||
or
|
||||
</p></li>
|
||||
|
||||
<li>
|
||||
<p>use the (relative or absolute) path to the “setup file” (in
|
||||
your Git local repository)</p>
|
||||
<li><p>
|
||||
use the (relative or absolute) path to the “setup file” (in your Git local
|
||||
repository)
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class=
|
||||
"org-org-meta-line">#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup</span>
|
||||
<div class="org-src-container">
|
||||
|
||||
<pre class="src src-org"><span class="org-org-meta-line">#+SETUPFILE: path/to/Git/repo/setup/THEME-NAME.setup</span>
|
||||
</pre>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-5" class="outline-4">
|
||||
<h4 id="unnumbered-5">Bigblow</h4>
|
||||
<div id="outline-container-unnumbered-5" class="outline-4">
|
||||
<h4 id="unnumbered-5">Bigblow</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-5">
|
||||
<p>
|
||||
In order to use this style, just copy the <a href="setup/bigblow-pirilampo.setup">bigblow-pirilampo.setup</a> file to your
|
||||
project and link to it this way:
|
||||
</p>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-5">
|
||||
<p>In order to use this style, just copy the <a href=
|
||||
"setup/bigblow-pirilampo.setup">bigblow-pirilampo.setup</a> file to
|
||||
your project and link to it this way:</p>
|
||||
<div class="org-src-container">
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-org-meta-line">#+SETUPFILE: bigblow-pirilampo.setup</span>
|
||||
<pre class="src src-org"><span class="org-org-meta-line">#+SETUPFILE: bigblow-pirilampo.setup</span>
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>If you prefer, you can add the content of the setup file at the
|
||||
beginning of your Org file instead:</p>
|
||||
<p>
|
||||
If you prefer, you can add the content of the setup file at the beginning of
|
||||
your Org file instead:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-comment"># -*- mode: org; -*-</span>
|
||||
<div class="org-src-container">
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/htmlize.css"/">http://www.pirilampo.org/styles/bigblow/css/htmlize.css"/</a>></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/bigblow.css"/">http://www.pirilampo.org/styles/bigblow/css/bigblow.css"/</a>></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/hideshow.css"/">http://www.pirilampo.org/styles/bigblow/css/hideshow.css"/</a>></span>
|
||||
<pre class="src src-org"><span class="org-comment"># -*- mode: org; -*-</span>
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery-1.11.0.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery-1.11.0.min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery-ui-1.10.2.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery-ui-1.10.2.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/htmlize.css"/">http://www.pirilampo.org/styles/bigblow/css/htmlize.css"/</a>></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/bigblow.css"/">http://www.pirilampo.org/styles/bigblow/css/bigblow.css"/</a>></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="http://www.pirilampo.org/styles/bigblow/css/hideshow.css"/">http://www.pirilampo.org/styles/bigblow/css/hideshow.css"/</a>></span>
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.localscroll-min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.localscroll-min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.zclip.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.zclip.min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/bigblow.js">http://www.pirilampo.org/styles/bigblow/js/bigblow.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/hideshow.js">http://www.pirilampo.org/styles/bigblow/js/hideshow.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery-1.11.0.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery-1.11.0.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery-ui-1.10.2.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery-ui-1.10.2.min.js</a>"></script></span>
|
||||
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.localscroll-min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.localscroll-min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/jquery.zclip.min.js">http://www.pirilampo.org/styles/bigblow/js/jquery.zclip.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/bigblow.js">http://www.pirilampo.org/styles/bigblow/js/bigblow.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="http://www.pirilampo.org/styles/bigblow/js/hideshow.js">http://www.pirilampo.org/styles/bigblow/js/hideshow.js</a>"></script></span>
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>Here a local version (using relative paths):</p>
|
||||
<p>
|
||||
Here a local version (using relative paths):
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-comment"># -*- mode: org; -*-</span>
|
||||
<div class="org-src-container">
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/></span>
|
||||
<pre class="src src-org"><span class="org-comment"># -*- mode: org; -*-</span>
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/htmlize.css"/></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/bigblow.css"/></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/bigblow/css/hideshow.css"/></span>
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/bigblow.js"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/hideshow.js"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-1.11.0.min.js"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery-ui-1.10.2.min.js"></script></span>
|
||||
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.localscroll-min.js"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/jquery.zclip.min.js"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/bigblow.js"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="styles/bigblow/js/hideshow.js"></script></span>
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>Here is a remote version (with CSS/JS files served from GitHub
|
||||
webservers) to share <b>temporary</b> examples or demos with small
|
||||
numbers of people:</p>
|
||||
<p>
|
||||
Here is a remote version (with CSS/JS files served from GitHub webservers) to
|
||||
share <b>temporary</b> examples or demos with small numbers of people:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org">
|
||||
<span class="org-comment"># -*- mode: org; -*-</span>
|
||||
<div class="org-src-container">
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/</a>></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/</a>></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/</a>></span>
|
||||
<pre class="src src-org"><span class="org-comment"># -*- mode: org; -*-</span>
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/htmlize.css"/</a>></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/bigblow.css"/</a>></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/css/hideshow.css"/</a>></span>
|
||||
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js</a>"></script></span>
|
||||
<span class=
|
||||
"org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-1.11.0.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery-ui-1.10.2.min.js</a>"></script></span>
|
||||
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.localscroll-min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.scrollTo-1.4.3.1-min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/jquery.zclip.min.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/bigblow.js</a>"></script></span>
|
||||
<span class="org-org-meta-line">#+HTML_HEAD: <script type="text/javascript" src="<a href="https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js">https://rawgit.com/fniessen/org-html-themes/master/styles/bigblow/js/hideshow.js</a>"></script></span>
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-5" class="outline-3">
|
||||
<h3 id="sec-1-5"><span class="section-number-3">1.5</span>
|
||||
Contributing</h3>
|
||||
<div id="outline-container-sec-1-5" class="outline-3">
|
||||
<h3 id="sec-1-5"><span class="section-number-3">1.5</span> Contributing</h3>
|
||||
<div class="outline-text-3" id="text-1-5">
|
||||
</div><div id="outline-container-unnumbered-6" class="outline-4">
|
||||
<h4 id="unnumbered-6">Issues</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-6">
|
||||
<p>
|
||||
Report issues and suggest features and improvements on the <a href="https://github.com/fniessen/org-html-themes/issues/new">GitHub issue tracker</a>.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="outline-text-3" id="text-1-5"></div>
|
||||
<div id="outline-container-unnumbered-7" class="outline-4">
|
||||
<h4 id="unnumbered-7">Patches</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-7">
|
||||
<p>
|
||||
I love contributions! Patches under any form are always welcome!
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-6" class="outline-4">
|
||||
<h4 id="unnumbered-6">Issues</h4>
|
||||
<div id="outline-container-unnumbered-8" class="outline-4">
|
||||
<h4 id="unnumbered-8">Donations</h4>
|
||||
<div class="outline-text-4" id="text-unnumbered-8">
|
||||
<p>
|
||||
If you like the org-html-themes project, you can show your appreciation and
|
||||
support future development by making a <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org-html-themes&currency_code=EUR&bn=PP-DonationsBF:btn_donate_LG.gif:NonHosted">donation</a> through PayPal.
|
||||
</p>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-6">
|
||||
<p>Report issues and suggest features and improvements on the
|
||||
<a href=
|
||||
"https://github.com/fniessen/org-html-themes/issues/new">GitHub
|
||||
issue tracker</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<p>
|
||||
Regardless of the donations, org-html-themes will always be free both as in
|
||||
beer and as in speech.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-unnumbered-7" class="outline-4">
|
||||
<h4 id="unnumbered-7">Patches</h4>
|
||||
<div id="outline-container-sec-1-6" class="outline-3">
|
||||
<h3 id="sec-1-6"><span class="section-number-3">1.6</span> License</h3>
|
||||
<div class="outline-text-3" id="text-1-6">
|
||||
<p>
|
||||
Copyright (C) 2011-2014 Fabrice Niessen.
|
||||
</p>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-7">
|
||||
<p>I love contributions! Patches under any form are always
|
||||
welcome!</p>
|
||||
</div>
|
||||
</div>
|
||||
<p>
|
||||
Author: Fabrice Niessen <br />
|
||||
Keywords: org-mode html themes
|
||||
</p>
|
||||
|
||||
<div id="outline-container-unnumbered-8" class="outline-4">
|
||||
<h4 id="unnumbered-8">Donations</h4>
|
||||
<p>
|
||||
This program is free software; you can redistribute it and/or modify it under
|
||||
the terms of the GNU General Public License as published by the Free Software
|
||||
Foundation, either version 3 of the License, or (at your option) any later
|
||||
version.
|
||||
</p>
|
||||
|
||||
<div class="outline-text-4" id="text-unnumbered-8">
|
||||
<p>If you like the org-html-themes project, you can show your
|
||||
appreciation and support future development by making a <a href=
|
||||
"https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org-html-themes&currency_code=EUR&bn=PP-DonationsBF:btn_donate_LG.gif:NonHosted">
|
||||
donation</a> through PayPal.</p>
|
||||
<p>
|
||||
This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
||||
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
||||
A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
</p>
|
||||
|
||||
<p>Regardless of the donations, org-html-themes will always be free
|
||||
both as in beer and as in speech.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-sec-1-6" class="outline-3">
|
||||
<h3 id="sec-1-6"><span class="section-number-3">1.6</span> License</h3>
|
||||
|
||||
<div class="outline-text-3" id="text-1-6">
|
||||
<p>Copyright (C) 2011-2014 Fabrice Niessen.</p>
|
||||
|
||||
<p>Author: Fabrice Niessen<br />
|
||||
Keywords: org-mode html themes</p>
|
||||
|
||||
<p>This program is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public License as
|
||||
published by the Free Software Foundation, either version 3 of the
|
||||
License, or (at your option) any later version.</p>
|
||||
|
||||
<p>This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.</p>
|
||||
|
||||
<p>You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <a href=
|
||||
"http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="postamble" class="status">
|
||||
<div id="footer">
|
||||
<div id="copyright">
|
||||
Copyright © Fabrice Niessen
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<p>
|
||||
You should have received a copy of the GNU General Public License along with
|
||||
this program. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<div id="footer"><div id="copyright">
|
||||
Copyright © Fabrice Niessen
|
||||
</div></div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
|||
10
README.org
10
README.org
|
|
@ -6,7 +6,9 @@
|
|||
#+OPTIONS: H:4 toc:t num:2
|
||||
|
||||
#+PROPERTY: padline no
|
||||
#+SETUPFILE: setup/bigblow-local.setup
|
||||
# #+SETUPFILE: setup/bigblow-local.setup
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/rtd.css"/>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="styles/rtd.js"></script>
|
||||
|
||||
* Awesome HTML themes for files exported from Org mode [[http://opensource.org/licenses/GPL-3.0][http://img.shields.io/:license-gpl-blue.svg]] [[https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=VCVAS6KPDQ4JC&lc=BE&item_number=org%2dhtml%2dthemes¤cy_code=EUR&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted][https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif]]
|
||||
|
||||
|
|
@ -49,6 +51,12 @@ If such a version is not bundled with your Emacs, install one from ELPA.
|
|||
theme!" \\
|
||||
-- /Joseph Vidal-Rosset/
|
||||
|
||||
"Thanks a lot for sharing [...] the wonderful Bigblow theme. I create lot of
|
||||
specification for other team members to use. It has always been a trouble to
|
||||
share and maintain such spec. Now, I can create a much neater spec which is
|
||||
available for the team's reference as a webpage." \\
|
||||
-- /Shankar R./
|
||||
|
||||
** Gallery
|
||||
:PROPERTIES:
|
||||
:ID: 79e0ed21-c3b0-4f00-bdab-29fbff9dcad4
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,846 @@
|
|||
#+TITLE: Org mode syntax example
|
||||
#+AUTHOR: Fabrice Niessen
|
||||
#+EMAIL: fniessen@pirilampo.org
|
||||
#+DESCRIPTION: Org mode syntax example
|
||||
#+KEYWORDS: syntax, org, document
|
||||
#+LANGUAGE: en
|
||||
#+OPTIONS: H:5 num:nil toc:2 p:t
|
||||
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="styles/rtd.css"/>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="styles/rtd.js"></script>
|
||||
|
||||
#+PROPERTY: eval never-export
|
||||
|
||||
This is an Org mode document.
|
||||
|
||||
*Org mode* is a easy-to-write /plain text/ formatting syntax for authoring LaTeX
|
||||
documents, creating Web pages and much more!
|
||||
|
||||
* Basics
|
||||
|
||||
** Biggest heading
|
||||
|
||||
New chapter.
|
||||
|
||||
*** Bigger heading
|
||||
|
||||
New section.
|
||||
|
||||
**** Big heading
|
||||
|
||||
New sub-section.
|
||||
|
||||
**** Text breaks
|
||||
|
||||
A single newline has no effect.
|
||||
This line is part of the same paragraph.
|
||||
|
||||
But an empty line
|
||||
|
||||
demarcates paragraphs.
|
||||
|
||||
By entering two consecutive backslashes,
|
||||
you can force to break lines \\
|
||||
without starting a new paragraph.
|
||||
|
||||
For an horizontal line, insert at least 5 dashes: this is some text above an
|
||||
horizontal rule
|
||||
-----
|
||||
and some text below it.
|
||||
|
||||
**** Numbered headings
|
||||
|
||||
You can create numbered headings up to a certain level by setting an option:
|
||||
|
||||
#+begin_src org
|
||||
,#+OPTIONS: H:4
|
||||
#+end_src
|
||||
|
||||
*** Text width
|
||||
|
||||
# Premiere Elements, page 111
|
||||
#
|
||||
# Vous pouvez créer ces objets en cliquant sur le bouton Nouvel| élément de le
|
||||
# fenêtre Média. (Le Chapitre 14 explique comment créer| des titres ; le
|
||||
# Chapitre 15 montre l'utilisation des barres et ton, de la| vidéo noir et de
|
||||
# l'amorce SMPTE.)
|
||||
#
|
||||
# The principles of beautiful Web design, page 6
|
||||
#
|
||||
# In a figurative sense, the concept of visual balance is similar to that of
|
||||
# physical balance| illustrated by a seesaw. Just as physical objects have
|
||||
# weight, so do the elements of a layout.| If the elements on either side of a
|
||||
# layout are of equal weight, they balance one another.| There are two main forms
|
||||
# of visual balance: symmetrical and asymmetrical.
|
||||
|
||||
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.
|
||||
|
||||
** Lists
|
||||
|
||||
Org markup allows you to create bulleted or numbered lists. It allows any
|
||||
combination of the two list types.
|
||||
|
||||
*** Unordered lists
|
||||
|
||||
Itemized lists are marked with bullets. They are convenient to:
|
||||
|
||||
- organize data, and
|
||||
- make the document
|
||||
+ prettier, and
|
||||
+ easier to read.
|
||||
|
||||
Create them with a minus or a plus sign.
|
||||
|
||||
*** Ordered lists
|
||||
|
||||
Enumerated lists are marked with numbers or letters:
|
||||
|
||||
1. First element
|
||||
1) First sub-item
|
||||
2) Last sub-item
|
||||
2. Second element
|
||||
|
||||
You can have ordered lists with jumping numbers:
|
||||
|
||||
1. [@1] First
|
||||
2. [@2] Second
|
||||
5. [@5] Jump to 5th
|
||||
|
||||
*** Definition lists
|
||||
|
||||
- Definition list ::
|
||||
List containing definitions.
|
||||
|
||||
- Term to define ::
|
||||
Explication of the term.
|
||||
|
||||
** Miscellaneous effects
|
||||
|
||||
*** Include Org files
|
||||
|
||||
You can include another Org file and skip its title by using the ~:lines~ argument
|
||||
to ~#+INCLUDE~:
|
||||
|
||||
#+begin_src org
|
||||
,#+INCLUDE: chapter1.org :lines "2-"
|
||||
#+end_src
|
||||
|
||||
#+begin_note
|
||||
File inclusion, through INCLUDE keywords, is an *export-only feature*.
|
||||
#+end_note
|
||||
|
||||
*** Inline HTML
|
||||
|
||||
You can include raw HTML in your Org documents and it will get kept as HTML
|
||||
when it's exported. XXX
|
||||
|
||||
#+HTML_BEGIN: <pre style="color:red">
|
||||
Text can be preformatted (in a fixed-width font).
|
||||
#+HTML_END: </pre>
|
||||
|
||||
It is especially useful for more advanced stuff like images or tables where you
|
||||
need more control of the HTML options than Org mode actually gives you.
|
||||
|
||||
Similarly, you can incorporate JS or do anything else you can do in a Web page
|
||||
(such as importing a CSS file).
|
||||
|
||||
You can create named classes (to get style control from your CSS) with:
|
||||
|
||||
#+begin_example
|
||||
,#+begin_info
|
||||
,*Info example* \\
|
||||
Did you know...
|
||||
,#+end_info
|
||||
#+end_example
|
||||
|
||||
You can also add interactive elements to the HTML such as interactive R plots.
|
||||
|
||||
Finally, you can include an HTML file verbatim (during export) with:
|
||||
|
||||
#+begin_src org
|
||||
,#+INCLUDE: file.html html
|
||||
#+end_src
|
||||
|
||||
Don't edit the exported HTML file!
|
||||
|
||||
*** Inline LaTeX
|
||||
|
||||
You can also use raw LaTeX. XXX
|
||||
|
||||
#+LaTeX_BEGIN: \begin{verbatim}
|
||||
Text can be preformatted (in a fixed-width font).
|
||||
#+LaTeX_END: \end{verbatim}
|
||||
|
||||
*** Centered text
|
||||
|
||||
#+begin_center
|
||||
This text is centered!
|
||||
#+end_center
|
||||
|
||||
** Code blocks
|
||||
|
||||
*** COMMENT Syntax highlighting
|
||||
|
||||
The source code blocks support syntax highlighting:
|
||||
|
||||
#+begin_src cpp :eval no
|
||||
/*
|
||||
* Application that displays a "Hello" message to the standard output.
|
||||
*/
|
||||
int main(int arc, char **argv)
|
||||
{
|
||||
printf("Hello, %s!\n", (argc>1) ? argv[1] : "World");
|
||||
return 0;
|
||||
}
|
||||
#+end_src
|
||||
|
||||
The following language strings are currently recognized:
|
||||
|
||||
#+begin_src emacs-lisp :results drawer :exports results
|
||||
(concat (mapconcat (lambda (widget)
|
||||
(widget-get widget :tag))
|
||||
(cl-remove-if-not (lambda (it)
|
||||
(and (consp it)
|
||||
(eq (car it) 'const)))
|
||||
(cdr
|
||||
(widget-get
|
||||
(get
|
||||
'org-babel-load-languages 'custom-type)
|
||||
:key-type)))
|
||||
", ")
|
||||
".")
|
||||
#+end_src
|
||||
|
||||
#+results:
|
||||
:RESULTS:
|
||||
Awk, C, R, Asymptote, Calc, Clojure, CSS, Ditaa, Dot, Emacs Lisp, 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.
|
||||
:END:
|
||||
|
||||
Code block with long lines:
|
||||
|
||||
#+begin_src emacs-lisp :eval no
|
||||
testing testing testing testing testing testing testing testing testing testing
|
||||
0 1 2 3 4 5 6 7 8 9
|
||||
123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456
|
||||
#+end_src
|
||||
|
||||
For PDF (LaTeX), one solution is to surround the code block such as:
|
||||
|
||||
#+latex: \scriptsize
|
||||
#+begin_src R
|
||||
print("This block is in scriptsize")
|
||||
#+end_src
|
||||
#+latex: \normalize
|
||||
|
||||
*** Line numbers
|
||||
|
||||
Both in ~example~ and in ~src~ snippets, you can add a ~-n~ switch to the end of the
|
||||
~begin~ line, to get the lines of the example numbered.
|
||||
|
||||
#+header: :eval no
|
||||
#+begin_src emacs-lisp -n
|
||||
(defun org-xor (a b)
|
||||
"Exclusive or."
|
||||
#+end_src
|
||||
|
||||
If you use a ~+n~ switch, the numbering from the previous numbered snippet will
|
||||
be continued in the current one:
|
||||
|
||||
#+header: :eval no
|
||||
#+begin_src emacs-lisp +n
|
||||
(if a (not b) b))
|
||||
#+end_src
|
||||
|
||||
In literal examples, Org will interpret strings like ~(ref:name)~ as labels, and
|
||||
use them as targets for special hyperlinks like ~[[(name)]]~ (i.e., the reference
|
||||
name enclosed in single parenthesis). In HTML, hovering the mouse over such
|
||||
a link will remote-highlight the corresponding code line, which is kind of
|
||||
cool.
|
||||
|
||||
You can also add a ~-r~ switch which removes the labels from the source code.
|
||||
With the ~-n~ switch, links to these references will be labeled by the line
|
||||
numbers from the code listing, otherwise links will use the labels with no
|
||||
parentheses. Here is an example:
|
||||
|
||||
#+header: :eval no
|
||||
#+begin_src emacs-lisp -n -r
|
||||
(save-excursion ; (ref:sc)
|
||||
(goto-char (point-min))) ; (ref:jump)
|
||||
#+end_src
|
||||
|
||||
In line [[(sc)]], we remember the current position. [[(jump)][Line (jump)]] jumps to
|
||||
~point-min~.
|
||||
|
||||
*** Output
|
||||
|
||||
The output from the *execution* of programs, scripts or commands can be inserted
|
||||
in the document itself, allowing you to work in the /reproducible research/
|
||||
mindset.
|
||||
|
||||
**** Text
|
||||
|
||||
A one-liner result:
|
||||
|
||||
#+begin_src sh :exports both :results verbatim
|
||||
date +"%Y-%m-%d"
|
||||
#+end_src
|
||||
|
||||
#+results:
|
||||
: 2014-03-15
|
||||
|
||||
# A multiple-line result:
|
||||
#
|
||||
# #+name: list-of-styles
|
||||
# #+begin_src sh :exports both :results verbatim
|
||||
# # output all styles, but the default one (if any)
|
||||
# ls styles | grep -v "default"
|
||||
# #+end_src
|
||||
#
|
||||
# #+results: list-of-styles
|
||||
# #+begin_example
|
||||
# bigblow
|
||||
# leuven
|
||||
# maunakea
|
||||
# #+end_example
|
||||
|
||||
**** Graphics
|
||||
|
||||
Data to be charted:
|
||||
|
||||
#+name: data
|
||||
| Month | Degrees |
|
||||
|-------+---------|
|
||||
| 1 | 3.8 |
|
||||
| 2 | 4.1 |
|
||||
| 3 | 6.3 |
|
||||
| 4 | 9.0 |
|
||||
| 5 | 11.9 |
|
||||
| 6 | 15.1 |
|
||||
| 7 | 17.1 |
|
||||
| 8 | 17.4 |
|
||||
| 9 | 15.7 |
|
||||
| 10 | 11.8 |
|
||||
| 11 | 7.7 |
|
||||
| 12 | 4.8 |
|
||||
|
||||
Code:
|
||||
|
||||
#+name: R-plot
|
||||
#+begin_src R :var data=data :results graphics :file ../../images/Rplot.png :exports both
|
||||
plot(data, type="b", bty="l", col=c("#ABD249"), las=1, lwd=4)
|
||||
grid(nx=NULL, ny=NULL, col=c("#E8E8E8"), lwd=1)
|
||||
legend("bottom", legend=c("Degrees"), col=c("#ABD249"), pch=c(19))
|
||||
#+end_src
|
||||
|
||||
The resulting chart:
|
||||
|
||||
#+results: R-plot
|
||||
[[file:../../images/Rplot.png]]
|
||||
|
||||
**** R code block
|
||||
|
||||
#+begin_src R
|
||||
library(ggplot2)
|
||||
summary(cars)
|
||||
#+end_src
|
||||
|
||||
Plot:
|
||||
|
||||
#+begin_src R
|
||||
library(ggplot2)
|
||||
qplot(speed, dist, data = cars) + geom_smooth()
|
||||
#+end_src
|
||||
|
||||
** Inline code
|
||||
|
||||
You can also evaluate code inline as follows: 1 + 1 is src_R{1 + 1}.
|
||||
|
||||
** Notes at the footer
|
||||
|
||||
It is possible to define named footnotes[fn:myfootnote], or ones with
|
||||
automatic anchors[fn:2].
|
||||
|
||||
** Formatting text
|
||||
|
||||
*** Text effects
|
||||
|
||||
/Emphasize/ (italics), *strongly* (bold), and */very strongly/* (bold italics).
|
||||
|
||||
Markup elements could be nested: this is /italic text which contains
|
||||
_underlined text_ within it/, whereas _this is normal underlined text_.
|
||||
|
||||
Markup can span across multiple lines, by default *no more than 2*:
|
||||
|
||||
*This
|
||||
is not
|
||||
bold*
|
||||
|
||||
Other elements to use sparingly are:
|
||||
- monospaced typewriter font for ~inline code~
|
||||
- monospaced typewriter font for =verbatim text=
|
||||
- +deleted+ text (vs. _inserted_ text)
|
||||
- text with^{superscript} (for example: ~m/s^{2}~ gives m/s^{2})
|
||||
- text with_{subscript}
|
||||
|
||||
*** Quotations
|
||||
|
||||
Use the ~quote~ block to typeset quoted text.
|
||||
|
||||
#+begin_quote
|
||||
Let us change our traditional attitude to the construction of programs:
|
||||
Instead of imagining that our main task is to instruct a computer what to do,
|
||||
let us concentrate rather on explaining to human beings what we want a
|
||||
computer to do.
|
||||
|
||||
The practitioner of literate programming can be regarded as an essayist, whose
|
||||
main concern is with exposition and excellence of style. Such an author, with
|
||||
thesaurus in hand, chooses the names of variables carefully and explains what
|
||||
each variable means. He or she strives for a program that is comprehensible
|
||||
because its concepts have been introduced in an order that is best for human
|
||||
understanding, using a mixture of formal and informal methods that reinforce
|
||||
each other.
|
||||
|
||||
--- Donald Knuth
|
||||
#+end_quote
|
||||
|
||||
A short one:
|
||||
|
||||
#+begin_quote
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+end_quote
|
||||
|
||||
In a ~verse~ environment, there is an implicit line break at the end of each
|
||||
line, and indentation and vertical space are preserved:
|
||||
|
||||
#+begin_verse
|
||||
Everything should be made as simple as possible,
|
||||
but not any simpler -- Albert Einstein
|
||||
#+end_verse
|
||||
|
||||
Typically used for quoting passages of an email message:
|
||||
|
||||
#+begin_verse
|
||||
>> This is an email message with "nested" quoting. Lorem ipsum dolor sit amet,
|
||||
>> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
|
||||
>> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
|
||||
>
|
||||
> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id sem
|
||||
> consectetuer libero luctus adipiscing.
|
||||
|
||||
Itemized or unordered lists (~ul~):
|
||||
- This is the first list item.
|
||||
- This is the second list item.
|
||||
|
||||
Enumerated or ordered Lists (~ol~):
|
||||
1. This is the first list item.
|
||||
2. This is the second list item.
|
||||
|
||||
Maybe an equation here?
|
||||
|
||||
See http://www.google.com/ for more information...
|
||||
#+end_verse
|
||||
|
||||
*** Spaces
|
||||
|
||||
Using non-breaking spaces.
|
||||
|
||||
Insert the Unicode character ~00A0~ to add a non-breaking space. FIXME
|
||||
Or add/use an Org entity?
|
||||
|
||||
** Mathematical formulae
|
||||
|
||||
You can embed LaTeX math formatting in Org mode files using the following
|
||||
syntax:
|
||||
|
||||
- For *inline math* expressions, use ~\(...\)~: \(x^2\) or \(1 < 2\).
|
||||
|
||||
It's /not/ advised to use the constructs ~$...$~ (both for Org and MathJax).
|
||||
|
||||
- Centered display equation (the /Euler theorem/):
|
||||
|
||||
\[
|
||||
\int_0^\infty e^{-x^2} dx = {{\sqrt{\pi}} \over {2}}
|
||||
\]
|
||||
|
||||
The use of ~\[...\]~ is for mathematical expressions which you want to make
|
||||
*stand out, on their own lines*.
|
||||
|
||||
LaTeX allows to inline such ~\[...\]~ constructs (/quadratic formula/):
|
||||
\[ \frac{-b \pm \sqrt{b^2 - 4 a c}}{2a} \]
|
||||
|
||||
*Double dollar signs (~$$~) should not be used*.
|
||||
|
||||
- The /sinus theorem/ can then be written as the equation:
|
||||
|
||||
\begin{equation}
|
||||
\label{eqn:sinalpha}
|
||||
\frac{\sin\alpha}{a}=\frac{\sin\beta}{b}
|
||||
\end{equation}
|
||||
|
||||
- See Equation [[the-first]],
|
||||
|
||||
#+name: the-first
|
||||
\begin{equation}
|
||||
n_{i+1} = \frac{n_{i} (d-i) (e-1)}{(i+1)}
|
||||
\end{equation}
|
||||
|
||||
Only captioned equations are numbered
|
||||
|
||||
- Other alternative: use \begin{equation*} or \begin{displaymath} (= the verbose
|
||||
form of the ~\[...\]~ construct). M-q does not fill those.
|
||||
|
||||
Differently from $...$ and \(...\), an equation environment produces a *numbered*
|
||||
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 ($$, ...).
|
||||
|
||||
** Special characters
|
||||
|
||||
Some of the widely used special characters (converted from text characters to
|
||||
their typographically correct entitites):
|
||||
|
||||
*** Accents
|
||||
|
||||
\Agrave \Aacute
|
||||
|
||||
*** Punctuation
|
||||
|
||||
Dash: \ndash \mdash
|
||||
|
||||
Marks: \iexcl \iquest
|
||||
|
||||
Quotations: \laquo \raquo
|
||||
|
||||
Miscellaneous: \para \ordf
|
||||
|
||||
*** Commercial symbols
|
||||
|
||||
Property marks: \copy \reg
|
||||
|
||||
Currency: \cent \EUR \yen \pound
|
||||
|
||||
*** Greek characters
|
||||
|
||||
The Greek letters \alpha, \beta, and \gamma are used to denote angles.
|
||||
|
||||
*** Math characters
|
||||
|
||||
Science: \pm \div
|
||||
|
||||
Arrows: \to \rarr \larr \harr \rArr \lArr \hArr
|
||||
|
||||
Function names: \arccos \cos
|
||||
|
||||
Signs and symbols: \bull \star
|
||||
|
||||
*** Misc
|
||||
|
||||
# Smilies: \smiley \sad
|
||||
|
||||
Suits: \clubs \spades
|
||||
|
||||
** Comments
|
||||
|
||||
It's possible to add comments in the document.
|
||||
|
||||
# This Org comment here won't be displayed.
|
||||
|
||||
** Tables
|
||||
|
||||
You can create tables with an optional header row (by using an horizontal line
|
||||
of dashes to separate it from the rest of the table).
|
||||
|
||||
#+CAPTION: An example of table
|
||||
| Header 1 | Header 2 | Header 3 |
|
||||
|-------------+---------------+----------|
|
||||
| Top left | Top middle | |
|
||||
| | | Right |
|
||||
| Bottom left | Bottom middle | |
|
||||
|
||||
Columns are automatically aligned:
|
||||
|
||||
- Number-rich columns to the right, and
|
||||
- String-rich columns to the left.
|
||||
|
||||
If you want to override the automatic alignment, use ~<r>~, ~<c>~ or ~<l>~.
|
||||
|
||||
#+CAPTION: Table with alignment
|
||||
| <r> | <c> | <l> |
|
||||
| 1 | 2 | 3 |
|
||||
| right | center | left |
|
||||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
|
||||
|
||||
Placement:
|
||||
|
||||
#+ATTR_LATEX: :center nil
|
||||
| a | b |
|
||||
| 1 | 2 |
|
||||
|
||||
XXX
|
||||
Different from the following:
|
||||
|
||||
| a | b |
|
||||
| 1 | 2 |
|
||||
|
||||
*** Align tables on the page
|
||||
|
||||
Here is a table on the left side:
|
||||
|
||||
#+LATEX: \noindent
|
||||
#+ATTR_LATEX: :center nil
|
||||
| a | b | c |
|
||||
|---+---+---|
|
||||
| 1 | 2 | 3 |
|
||||
| 4 | 5 | 6 |
|
||||
#+LATEX: \hfill
|
||||
|
||||
The noindent just gets rid of the indentation of the first line of a paragraph
|
||||
which in this case is the table. The hfill adds infinite stretch after the
|
||||
table, so it pushes the table to the left.
|
||||
|
||||
Here is a centered table:
|
||||
|
||||
| a | b | c |
|
||||
|---+---+---|
|
||||
| 1 | 2 | 3 |
|
||||
| 4 | 5 | 6 |
|
||||
|
||||
And here's a table on the right side:
|
||||
|
||||
#+LATEX: \hfill
|
||||
#+ATTR_LATEX: :center nil
|
||||
| a | b | c |
|
||||
|---+---+---|
|
||||
| 1 | 2 | 3 |
|
||||
| 4 | 5 | 6 |
|
||||
|
||||
Here the hfill adds infinite stretch before the table, so it pushes the table
|
||||
to the right.
|
||||
|
||||
** Images, video and audio
|
||||
|
||||
*** Images
|
||||
|
||||
You can insert *image* files of different *formats* to a page:
|
||||
|
||||
| | HTML | PDF |
|
||||
|------+------------------------------+-----|
|
||||
| gif | yes | |
|
||||
| jpeg | yes | |
|
||||
| png | yes | |
|
||||
| bmp | (depends on browser support) | |
|
||||
|
||||
In-line picture:
|
||||
|
||||
#+CAPTION: Org mode logo
|
||||
#+ATTR_LaTeX: :width 0.25\linewidth
|
||||
[[file:../../images/org-mode-unicorn.png]]
|
||||
|
||||
Direct link to just the [[file:org-mode-unicorn.png][Unicorn picture file]].
|
||||
|
||||
XXX Available HTML image tags include:
|
||||
|
||||
- align
|
||||
- border
|
||||
- bordercolor
|
||||
- hspace
|
||||
- vspace
|
||||
- width
|
||||
- height
|
||||
- title
|
||||
- alt
|
||||
|
||||
Place images side by side: XXX
|
||||
|
||||
*** Video
|
||||
|
||||
Videos can't be added directly but you can add an image with a link to the video like this:
|
||||
|
||||
[[http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg][http://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE]]
|
||||
|
||||
*** Sounds
|
||||
|
||||
** Special text boxes
|
||||
|
||||
Simple box ("inline task"): XXX
|
||||
|
||||
# *************** TODO Do this task
|
||||
# Description of inline task.
|
||||
# *************** END
|
||||
#
|
||||
# or:
|
||||
#
|
||||
# *************** WAIT [#B] Do also this other task :phone:
|
||||
# *************** END
|
||||
|
||||
*** Example
|
||||
|
||||
You can have ~example~ blocks.
|
||||
|
||||
Find entries with an *exact phrase* -- To do this, put the phrase in quotes:
|
||||
|
||||
: "hd ready"
|
||||
|
||||
You can create several other boxes (~info~, ~tip~, ~note~ or ~warning~) which all have
|
||||
a different default image.
|
||||
|
||||
*** Info
|
||||
|
||||
An info box is displayed as follows:
|
||||
|
||||
#+begin_info
|
||||
*Info example* \\
|
||||
Did you know...
|
||||
#+end_info
|
||||
|
||||
*** Tip
|
||||
|
||||
A tip box is displayed as follows:
|
||||
|
||||
#+begin_tip
|
||||
*Tip example* \\
|
||||
Try doing it this way...
|
||||
#+end_tip
|
||||
|
||||
*** Note
|
||||
|
||||
A note box is displayed as follows:
|
||||
|
||||
#+begin_note
|
||||
*Note example* \\
|
||||
This is a useful note...
|
||||
#+end_note
|
||||
|
||||
*** Warning
|
||||
|
||||
A warning box is displayed as follows:
|
||||
|
||||
#+begin_warning
|
||||
*Warning example* \\
|
||||
Be careful! Check that you have...
|
||||
#+end_warning
|
||||
|
||||
** Links
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: links
|
||||
:END:
|
||||
|
||||
*** Anchors
|
||||
:PROPERTIES:
|
||||
:ID: 0d2b0cb2-116c-4a61-a076-4c641faf4346
|
||||
:END:
|
||||
|
||||
Links generally point to an headline.
|
||||
|
||||
They can also point to a link anchor <<name-of-anchor-here>> in the current
|
||||
document or in another document.
|
||||
|
||||
*** Hyperlinks
|
||||
|
||||
This document is available in [[file:example.txt][plain text]], [[file:example.html][HTML]] and [[file:example.pdf][PDF]].
|
||||
|
||||
The links are delimited by ~[square brackets]~.
|
||||
|
||||
**** Internal links
|
||||
|
||||
See:
|
||||
- chapter [[#links][Links]]
|
||||
- section [[id:0d2b0cb2-116c-4a61-a076-4c641faf4346][Anchors]]
|
||||
- [[name-of-anchor-here][target in the document]]
|
||||
|
||||
**** External links
|
||||
|
||||
See the [[http://orgmode.org/][Org mode Web site]].
|
||||
|
||||
# Clicking on the image [[http://orgmode.org/][file:org-mode-unicorn.png]] leads to the Org mode home
|
||||
# page.
|
||||
|
||||
[[mailto:concat.fni.at-sign.pirilampo.org][Mailto link]]
|
||||
|
||||
* Org miscellaneous
|
||||
|
||||
** Dates
|
||||
|
||||
Timestamps: [2014-01-16 Thu] and <2014-01-16 Thu>.
|
||||
|
||||
** DONE [#A] Buy GTD book :online:
|
||||
:LOGBOOK:
|
||||
- State "TODO" -> "DONE" [2014-01-16 Thu 09:52]
|
||||
:END:
|
||||
|
||||
By default, ~DONE~ actions will be collapsed.
|
||||
|
||||
Note that I should probably implement that default behavior only for ~ARCHIVE~'d
|
||||
items.
|
||||
|
||||
** TODO [#A] Read GTD book
|
||||
SCHEDULED: <2014-09-11 Thu>
|
||||
|
||||
By default, *all* (active) entries will be expanded at page load, so that their
|
||||
contents is visible.
|
||||
|
||||
That can be changed by adding such a line (into your Org document):
|
||||
|
||||
#+begin_src org
|
||||
,#+HTML_HEAD: <script> var HS_STARTUP_FOLDED = true; </script>
|
||||
#+end_src
|
||||
|
||||
** TODO [#B] Apply GTD methodoloy
|
||||
DEADLINE: <2014-12-01 Mon>
|
||||
:PROPERTIES:
|
||||
:HTML_CONTAINER_CLASS: hsCollapsed
|
||||
:END:
|
||||
|
||||
This section will be collapsed when loading the page because the entry has the
|
||||
value ~hsCollapsed~ for the property ~:HTML_CONTAINER_CLASS:~.
|
||||
|
||||
Powerful, no?
|
||||
|
||||
** Some note :computer:write:
|
||||
|
||||
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 "Dashboard".
|
||||
|
||||
** Weekly review :computer:
|
||||
|
||||
Now, you can even make your weekly review in the HTML export... Press the ~r~ key
|
||||
to start entering the "review mode" where all but one active entry are
|
||||
collapsed, so that you can really focus on one item at a time!
|
||||
|
||||
* Org macros
|
||||
|
||||
#+MACRO: color @@html:<span style="color: $1">$2</span>@@
|
||||
|
||||
{{{color(blue, This text is colored in blue.)}}}
|
||||
|
||||
{{{color(red, This other text is in red.)}}}
|
||||
|
||||
Find more macros on [[https://github.com/fniessen/org-macros][GitHub]].
|
||||
|
||||
* BigBlow addons
|
||||
|
||||
The string ~fixme~ (in *upper case*) gets replaced by a "Fix Me!" image:
|
||||
|
||||
FIXME Delete this...
|
||||
|
||||
* Footnotes
|
||||
|
||||
[fn:myfootnote] Extensively used in large documents.
|
||||
|
||||
[fn:2] 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.
|
||||
|
||||
# This is for the sake of Emacs.
|
||||
# Local Variables:
|
||||
# org-html-postamble: nil
|
||||
# End:
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,47 @@
|
|||
$( document ).ready(function() {
|
||||
// Shift nav in mobile when clicking the menu.
|
||||
$(document).on('click', "[data-toggle='wy-nav-top']", function() {
|
||||
$("[data-toggle='wy-nav-shift']").toggleClass("shift");
|
||||
$("[data-toggle='rst-versions']").toggleClass("shift");
|
||||
});
|
||||
// Close menu when you click a link.
|
||||
$(document).on('click', ".wy-menu-vertical .current ul li a", function() {
|
||||
$("[data-toggle='wy-nav-shift']").removeClass("shift");
|
||||
$("[data-toggle='rst-versions']").toggleClass("shift");
|
||||
});
|
||||
$(document).on('click', "[data-toggle='rst-current-version']", function() {
|
||||
$("[data-toggle='rst-versions']").toggleClass("shift-up");
|
||||
});
|
||||
// Make tables responsive
|
||||
$("table.docutils:not(.field-list)").wrap("<div class='wy-table-responsive'></div>");
|
||||
});
|
||||
|
||||
window.SphinxRtdTheme = (function (jquery) {
|
||||
var stickyNav = (function () {
|
||||
var navBar,
|
||||
win,
|
||||
stickyNavCssClass = 'stickynav',
|
||||
applyStickNav = function () {
|
||||
if (navBar.height() <= win.height()) {
|
||||
navBar.addClass(stickyNavCssClass);
|
||||
} else {
|
||||
navBar.removeClass(stickyNavCssClass);
|
||||
}
|
||||
},
|
||||
enable = function () {
|
||||
applyStickNav();
|
||||
win.on('resize', applyStickNav);
|
||||
},
|
||||
init = function () {
|
||||
navBar = jquery('nav.wy-nav-side:first');
|
||||
win = jquery(window);
|
||||
};
|
||||
jquery(init);
|
||||
return {
|
||||
enable : enable
|
||||
};
|
||||
}());
|
||||
return {
|
||||
StickyNav : stickyNav
|
||||
};
|
||||
}($));
|
||||
Loading…
Reference in New Issue