fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-07-07 08:46:13 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated docs from master

Browse source
This commit is contained in:
Manuel Ebert 2014-04-10 18:00:45 -04:00
parent df03996934
commit 3b752597ed
41 changed files with 121 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/_build/doctrees/advanced.doctree vendored
View file

Binary file not shown.

BIN
docs/_build/doctrees/encryption.doctree vendored
View file

Binary file not shown.

BIN
docs/_build/doctrees/environment.pickle vendored
View file

Binary file not shown.

BIN
docs/_build/doctrees/export.doctree vendored
View file

Binary file not shown.

BIN
docs/_build/doctrees/index.doctree vendored
View file

Binary file not shown.

2
docs/_build/html/.buildinfo vendored
View file

@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: b09a7639281d8cac79b5805dcb78aabe
config: 0cb5b3ee0cc70978537b33c6a95755d0
tags: fbb0d17656682115ca4d033fb2f83ba1

14
docs/_build/html/_sources/advanced.txt vendored
View file

@ -51,13 +51,23 @@ The configuration file is a simple JSON file with the following options and can
DayOne Integration
------------------
Using your DayOne journal instead of a flat text file is dead simple -- instead of pointing to a text file, change your ``.jrnl_config`` to point to your DayOne journal. This is a folder ending with ``.dayone``, and it's located at
Using your DayOne journal instead of a flat text file is dead simple -- instead of pointing to a text file, change your ``.jrnl_config`` to point to your DayOne journal. This is a folder named something like ``Journal_dayone`` or ``Journal.dayone``, and it's located at
* ``~/Library/Application Support/Day One/`` by default
* ``~/Dropbox/Apps/Day One/`` if you're syncing with Dropbox and
* ``~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/`` if you're syncing with iCloud.
Instead of all entries being in a single file, each entry will live in a separate `plist` file.
Instead of all entries being in a single file, each entry will live in a separate `plist` file. So your ``.jrnl_config`` should look like this:
.. code-block:: javascript
{
...
"journals": {
"default": "~/journal.txt",
"dayone": "~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/Journal_dayone"
}
Multiple journal files
----------------------

18
docs/_build/html/advanced.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Advanced Usage &mdash; jrnl 1.7.17 documentation</title>
<title>Advanced Usage &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<link rel="next" title="FAQ" href="recipes.html" />
<link rel="prev" title="Import and Export" href="export.html" />
@ -113,13 +113,21 @@
</div>
<div class="section" id="dayone-integration">
<h2>DayOne Integration<a class="headerlink" href="#dayone-integration" title="Permalink to this headline"></a></h2>
<p>Using your DayOne journal instead of a flat text file is dead simple &#8211; instead of pointing to a text file, change your <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt> to point to your DayOne journal. This is a folder ending with <tt class="docutils literal"><span class="pre">.dayone</span></tt>, and it&#8217;s located at</p>
<p>Using your DayOne journal instead of a flat text file is dead simple &#8211; instead of pointing to a text file, change your <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt> to point to your DayOne journal. This is a folder named something like <tt class="docutils literal"><span class="pre">Journal_dayone</span></tt> or <tt class="docutils literal"><span class="pre">Journal.dayone</span></tt>, and it&#8217;s located at</p>
<ul class="simple">
<li><tt class="docutils literal"><span class="pre">~/Library/Application</span> <span class="pre">Support/Day</span> <span class="pre">One/</span></tt> by default</li>
<li><tt class="docutils literal"><span class="pre">~/Dropbox/Apps/Day</span> <span class="pre">One/</span></tt> if you&#8217;re syncing with Dropbox and</li>
<li><tt class="docutils literal"><span class="pre">~/Library/Mobile</span> <span class="pre">Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/</span></tt> if you&#8217;re syncing with iCloud.</li>
</ul>
<p>Instead of all entries being in a single file, each entry will live in a separate <cite>plist</cite> file.</p>
<p>Instead of all entries being in a single file, each entry will live in a separate <cite>plist</cite> file. So your <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt> should look like this:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="p">...</span>
<span class="s2">&quot;journals&quot;</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">&quot;default&quot;</span><span class="o">:</span> <span class="s2">&quot;~/journal.txt&quot;</span><span class="p">,</span>
<span class="s2">&quot;dayone&quot;</span><span class="o">:</span> <span class="s2">&quot;~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/Journal_dayone&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="multiple-journal-files">
<h2>Multiple journal files<a class="headerlink" href="#multiple-journal-files" title="Permalink to this headline"></a></h2>

6
docs/_build/html/encryption.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Encryption &mdash; jrnl 1.7.17 documentation</title>
<title>Encryption &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<link rel="next" title="Import and Export" href="export.html" />
<link rel="prev" title="Basic Usage" href="usage.html" />

6
docs/_build/html/export.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Import and Export &mdash; jrnl 1.7.17 documentation</title>
<title>Import and Export &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<link rel="next" title="Advanced Usage" href="advanced.html" />
<link rel="prev" title="Encryption" href="encryption.html" />

6
docs/_build/html/genindex.html vendored
View file

@ -9,7 +9,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Index &mdash; jrnl 1.7.17 documentation</title>
<title>Index &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -17,7 +17,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -26,7 +26,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">
<link rel="apple-touch-icon-precomposed" href="_static/img/favicon-152.png">

6
docs/_build/html/installation.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Getting started &mdash; jrnl 1.7.17 documentation</title>
<title>Getting started &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<link rel="next" title="Basic Usage" href="usage.html" />
<link rel="prev" title="Overview" href="overview.html" />

BIN
docs/_build/html/objects.inv vendored
View file

Binary file not shown.

6
docs/_build/html/overview.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Overview &mdash; jrnl 1.7.17 documentation</title>
<title>Overview &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<link rel="next" title="Getting started" href="installation.html" />
<link rel="prev" title="jrnl: The command-line journal" href="index.html" />

6
docs/_build/html/recipes.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>FAQ &mdash; jrnl 1.7.17 documentation</title>
<title>FAQ &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<link rel="prev" title="Advanced Usage" href="advanced.html" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9">

6
docs/_build/html/search.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Search &mdash; jrnl 1.7.17 documentation</title>
<title>Search &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -25,7 +25,7 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>

2
docs/_build/html/searchindex.js vendored
View file

File diff suppressed because one or more lines are too long

6
docs/_build/html/usage.html vendored
View file

@ -7,7 +7,7 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Basic Usage &mdash; jrnl 1.7.17 documentation</title>
<title>Basic Usage &mdash; jrnl 1.7.19 documentation</title>
<link rel="stylesheet" href="_static/css/jrnl.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
@ -15,7 +15,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.7.17',
VERSION: '1.7.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
@ -24,7 +24,7 @@
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="jrnl 1.7.17 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.19 documentation" href="index.html" />
<link rel="next" title="Encryption" href="encryption.html" />
<link rel="prev" title="Getting started" href="installation.html" />

14
docs/advanced.rst
View file

@ -51,13 +51,23 @@ The configuration file is a simple JSON file with the following options and can
DayOne Integration
------------------
Using your DayOne journal instead of a flat text file is dead simple -- instead of pointing to a text file, change your ``.jrnl_config`` to point to your DayOne journal. This is a folder ending with ``.dayone``, and it's located at
Using your DayOne journal instead of a flat text file is dead simple -- instead of pointing to a text file, change your ``.jrnl_config`` to point to your DayOne journal. This is a folder named something like ``Journal_dayone`` or ``Journal.dayone``, and it's located at
* ``~/Library/Application Support/Day One/`` by default
* ``~/Dropbox/Apps/Day One/`` if you're syncing with Dropbox and
* ``~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/`` if you're syncing with iCloud.
Instead of all entries being in a single file, each entry will live in a separate `plist` file.
Instead of all entries being in a single file, each entry will live in a separate `plist` file. So your ``.jrnl_config`` should look like this:
.. code-block:: javascript
{
...
"journals": {
"default": "~/journal.txt",
"dayone": "~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/Journal_dayone"
}
Multiple journal files
----------------------