mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-07-03 23:16:14 +02:00
Updated docs from master
This commit is contained in:
parent
82f9a713dc
commit
7d577baf66
54 changed files with 451 additions and 156 deletions
2
docs/_build/html/.buildinfo
vendored
2
docs/_build/html/.buildinfo
vendored
|
@ -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: cdd3d9dc24c56f542788a30876de826e
|
||||
config: dba46e56c477091f1d2bb4513e29807e
|
||||
tags: fbb0d17656682115ca4d033fb2f83ba1
|
||||
|
|
5
docs/_build/html/_sources/advanced.txt
vendored
5
docs/_build/html/_sources/advanced.txt
vendored
|
@ -6,12 +6,12 @@ Advanced Usage
|
|||
Configuration File
|
||||
-------------------
|
||||
|
||||
You can configure the way jrnl behaves in a configuration file. By default, this is `~/.jrnl_conf`. If you have the `XDG_CONFIG_HOME` variable set, the configuration file will be saved under `$XDG_CONFIG_HOME/jrnl`. The configuration file is a simple JSON file with the following options.
|
||||
You can configure the way jrnl behaves in a configuration file. By default, this is ``~/.jrnl_conf``. If you have the ``XDG_CONFIG_HOME`` variable set, the configuration file will be saved under ``$XDG_CONFIG_HOME/jrnl``. The configuration file is a simple JSON file with the following options.
|
||||
|
||||
- ``journals``
|
||||
paths to your journal files
|
||||
- ``editor``
|
||||
if set, executes this command to launch an external editor for writing your entries, e.g. ``vim`` or ``subl -w`` (note the ``-w`` flag to make sure _jrnl_ waits for Sublime Text to close the file before writing into the journal. If you're using MacVim, that would be ``mvim -f``).
|
||||
if set, executes this command to launch an external editor for writing your entries, e.g. ``vim`` or ``subl -w`` (note the ``-w`` flag to make sure *jrnl* waits for Sublime Text to close the file before writing into the journal. If you're using MacVim, that would be ``mvim -f``).
|
||||
- ``encrypt``
|
||||
if ``true``, encrypts your journal using AES.
|
||||
- ``tagsymbols``
|
||||
|
@ -51,6 +51,7 @@ Using your DayOne journal instead of a flat text file is dead simple -- instead
|
|||
* ``~/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.
|
||||
|
||||
Multiple journal files
|
||||
----------------------
|
||||
|
||||
|
|
2
docs/_build/html/_sources/export.txt
vendored
2
docs/_build/html/_sources/export.txt
vendored
|
@ -15,6 +15,8 @@ you'll get a list of all tags you used in your journal, sorted by most frequent.
|
|||
List of all entries
|
||||
-------------------
|
||||
|
||||
::
|
||||
|
||||
jrnl --short
|
||||
|
||||
Will only display the date and title of each entry.
|
||||
|
|
6
docs/_build/html/_sources/overview.txt
vendored
6
docs/_build/html/_sources/overview.txt
vendored
|
@ -15,5 +15,9 @@ Optionally, your journal can be encrypted using the `256-bit AES <http://en.wiki
|
|||
Why keep a journal?
|
||||
-------------------
|
||||
|
||||
Journals aren't only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it.
|
||||
Journals aren't only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't.
|
||||
|
||||
For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it.
|
||||
|
||||
For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it. Or use it as a quick way to keep a change log. Or use it to keep a lab book.
|
||||
|
||||
|
|
36
docs/_build/html/_sources/usage.txt
vendored
36
docs/_build/html/_sources/usage.txt
vendored
|
@ -83,5 +83,39 @@ the last five entries containing both ``@pineapple`` **and** ``@lubricant``. You
|
|||
|
||||
.. note::
|
||||
|
||||
``jrnl @pinkie @WorldDomination`` will switch to viewing mode because although _no_ command line arguments are given, all the input strings look like tags - *jrnl* will assume you want to filter by tag.
|
||||
``jrnl @pinkie @WorldDomination`` will switch to viewing mode because although **no** command line arguments are given, all the input strings look like tags - *jrnl* will assume you want to filter by tag.
|
||||
|
||||
Editing older entries
|
||||
---------------------
|
||||
|
||||
You can edit selected entries after you wrote them. This is particularly useful when your journal file is encrypted or if you're using a DayOne journal. To use this feature, you need to have an editor configured in your journal configuration file (see :doc:`advanced usage <advanced>`)::
|
||||
|
||||
jrnl -until 1950 @texas -and @history --edit
|
||||
|
||||
Will open your editor with all entries tagged with ``@texas`` and ``@history`` before 1950. You can make any changes to them you want; after you save the file and close the editor, your journal will be updated.
|
||||
|
||||
Of course, if you are using multiple journals, you can also edit e.g. the latest entry of your work journal with ``jrnl work -n 1 --edit``. In any case, this will bring up your editor and save (and, if applicable, encrypt) your edited journal after you save and exit the editor.
|
||||
|
||||
You can also use this feature for deleting entries from your journal::
|
||||
|
||||
jrnl @girlfriend -until 'june 2012' --edit
|
||||
|
||||
Just select all text, press delete, and everything is gone...
|
||||
|
||||
Editing DayOne Journals
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
DayOne journals can be edited exactly the same way, however the output looks a little bit different because of the way DayOne stores its entries:
|
||||
|
||||
.. code-block:: output
|
||||
|
||||
# af8dbd0d43fb55458f11aad586ea2abf
|
||||
2013-05-02 15:30 I told everyone I built my @robot wife for sex.
|
||||
But late at night when we're alone we mostly play Battleship.
|
||||
|
||||
# 2391048fe24111e1983ed49a20be6f9e
|
||||
2013-08-10 03:22 I had all kinds of plans in case of a @zombie attack.
|
||||
I just figured I'd be on the other side.
|
||||
|
||||
The long strings starting with hash symbol are the so-called UUIDs, unique identifiers for each entry. Don't touch them. If you do, then the old entry would get deleted and a new one written, which means that you could DayOne loose data that jrnl can't handle (such as as the entry's geolocation).
|
||||
|
||||
|
|
18
docs/_build/html/advanced.html
vendored
18
docs/_build/html/advanced.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Advanced Usage — jrnl 1.6.6 documentation</title>
|
||||
<title>Advanced Usage — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 documentation" href="index.html" />
|
||||
<link rel="next" title="FAQ" href="recipes.html" />
|
||||
<link rel="prev" title="Import and Export" href="export.html" />
|
||||
|
||||
|
@ -44,7 +44,7 @@
|
|||
<span id="advanced"></span><h1>Advanced Usage<a class="headerlink" href="#advanced-usage" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="configuration-file">
|
||||
<h2>Configuration File<a class="headerlink" href="#configuration-file" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can configure the way jrnl behaves in a configuration file. By default, this is <cite>~/.jrnl_conf</cite>. If you have the <cite>XDG_CONFIG_HOME</cite> variable set, the configuration file will be saved under <cite>$XDG_CONFIG_HOME/jrnl</cite>. The configuration file is a simple JSON file with the following options.</p>
|
||||
<p>You can configure the way jrnl behaves in a configuration file. By default, this is <tt class="docutils literal"><span class="pre">~/.jrnl_conf</span></tt>. If you have the <tt class="docutils literal"><span class="pre">XDG_CONFIG_HOME</span></tt> variable set, the configuration file will be saved under <tt class="docutils literal"><span class="pre">$XDG_CONFIG_HOME/jrnl</span></tt>. The configuration file is a simple JSON file with the following options.</p>
|
||||
<ul>
|
||||
<li><dl class="first docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">journals</span></tt></dt>
|
||||
|
@ -54,7 +54,7 @@
|
|||
</li>
|
||||
<li><dl class="first docutils">
|
||||
<dt><tt class="docutils literal"><span class="pre">editor</span></tt></dt>
|
||||
<dd><p class="first last">if set, executes this command to launch an external editor for writing your entries, e.g. <tt class="docutils literal"><span class="pre">vim</span></tt> or <tt class="docutils literal"><span class="pre">subl</span> <span class="pre">-w</span></tt> (note the <tt class="docutils literal"><span class="pre">-w</span></tt> flag to make sure _jrnl_ waits for Sublime Text to close the file before writing into the journal. If you’re using MacVim, that would be <tt class="docutils literal"><span class="pre">mvim</span> <span class="pre">-f</span></tt>).</p>
|
||||
<dd><p class="first last">if set, executes this command to launch an external editor for writing your entries, e.g. <tt class="docutils literal"><span class="pre">vim</span></tt> or <tt class="docutils literal"><span class="pre">subl</span> <span class="pre">-w</span></tt> (note the <tt class="docutils literal"><span class="pre">-w</span></tt> flag to make sure <em>jrnl</em> waits for Sublime Text to close the file before writing into the journal. If you’re using MacVim, that would be <tt class="docutils literal"><span class="pre">mvim</span> <span class="pre">-f</span></tt>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</li>
|
||||
|
@ -114,9 +114,10 @@
|
|||
<li><tt class="docutils literal"><span class="pre">~/Dropbox/Apps/Day</span> <span class="pre">One/</span></tt> if you’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’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.
|
||||
Multiple journal files
|
||||
———————-</p>
|
||||
<p>Instead of all entries being in a single file, each entry will live in a separate <cite>plist</cite> file.</p>
|
||||
</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>
|
||||
<p>You can configure _jrnl_ to use with multiple journals (eg. <tt class="docutils literal"><span class="pre">private</span></tt> and <tt class="docutils literal"><span class="pre">work</span></tt>) by defining more journals in your <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt>, for example:</p>
|
||||
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
|
||||
<span class="p">...</span>
|
||||
|
@ -171,6 +172,7 @@ Multiple journal files
|
|||
<li class="toctree-l1 current"><a class="current reference internal" href="">Advanced Usage</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#configuration-file">Configuration File</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#dayone-integration">DayOne Integration</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#multiple-journal-files">Multiple journal files</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="recipes.html">FAQ</a></li>
|
||||
|
|
6
docs/_build/html/encryption.html
vendored
6
docs/_build/html/encryption.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Encryption — jrnl 1.6.6 documentation</title>
|
||||
<title>Encryption — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 documentation" href="index.html" />
|
||||
<link rel="next" title="Import and Export" href="export.html" />
|
||||
<link rel="prev" title="Basic Usage" href="usage.html" />
|
||||
|
||||
|
|
11
docs/_build/html/export.html
vendored
11
docs/_build/html/export.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Import and Export — jrnl 1.6.6 documentation</title>
|
||||
<title>Import and Export — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 documentation" href="index.html" />
|
||||
<link rel="next" title="Advanced Usage" href="advanced.html" />
|
||||
<link rel="prev" title="Encryption" href="encryption.html" />
|
||||
|
||||
|
@ -52,8 +52,9 @@
|
|||
</div>
|
||||
<div class="section" id="list-of-all-entries">
|
||||
<h2>List of all entries<a class="headerlink" href="#list-of-all-entries" title="Permalink to this headline">¶</a></h2>
|
||||
<blockquote>
|
||||
<div>jrnl –short</div></blockquote>
|
||||
<div class="highlight-python"><div class="highlight"><pre><span class="n">jrnl</span> <span class="o">--</span><span class="n">short</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Will only display the date and title of each entry.</p>
|
||||
</div>
|
||||
<div class="section" id="json-export">
|
||||
|
|
6
docs/_build/html/genindex.html
vendored
6
docs/_build/html/genindex.html
vendored
|
@ -9,7 +9,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Index — jrnl 1.6.6 documentation</title>
|
||||
<title>Index — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 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
6
docs/_build/html/installation.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Getting started — jrnl 1.6.6 documentation</title>
|
||||
<title>Getting started — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 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
BIN
docs/_build/html/objects.inv
vendored
Binary file not shown.
10
docs/_build/html/overview.html
vendored
10
docs/_build/html/overview.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Overview — jrnl 1.6.6 documentation</title>
|
||||
<title>Overview — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 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" />
|
||||
|
||||
|
@ -50,7 +50,9 @@
|
|||
</div>
|
||||
<div class="section" id="why-keep-a-journal">
|
||||
<h2>Why keep a journal?<a class="headerlink" href="#why-keep-a-journal" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Journals aren’t only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn’t. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven’t wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you’ve done it.</p>
|
||||
<p>Journals aren’t only for 13-year old girls and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn’t.</p>
|
||||
<p>For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven’t wasted it.</p>
|
||||
<p>For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you’ve done it. Or use it as a quick way to keep a change log. Or use it to keep a lab book.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
6
docs/_build/html/recipes.html
vendored
6
docs/_build/html/recipes.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>FAQ — jrnl 1.6.6 documentation</title>
|
||||
<title>FAQ — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 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
6
docs/_build/html/search.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Search — jrnl 1.6.6 documentation</title>
|
||||
<title>Search — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 documentation" href="index.html" />
|
||||
<script type="text/javascript">
|
||||
jQuery(function() { Search.loadIndex("searchindex.js"); });
|
||||
</script>
|
||||
|
|
2
docs/_build/html/searchindex.js
vendored
2
docs/_build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
37
docs/_build/html/usage.html
vendored
37
docs/_build/html/usage.html
vendored
|
@ -7,7 +7,7 @@
|
|||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
|
||||
<title>Basic Usage — jrnl 1.6.6 documentation</title>
|
||||
<title>Basic Usage — jrnl 1.7.2 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.6.6',
|
||||
VERSION: '1.7.2',
|
||||
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.6.6 documentation" href="index.html" />
|
||||
<link rel="top" title="jrnl 1.7.2 documentation" href="index.html" />
|
||||
<link rel="next" title="Encryption" href="encryption.html" />
|
||||
<link rel="prev" title="Getting started" href="installation.html" />
|
||||
|
||||
|
@ -109,7 +109,32 @@
|
|||
<p>the last five entries containing both <tt class="docutils literal"><span class="pre">@pineapple</span></tt> <strong>and</strong> <tt class="docutils literal"><span class="pre">@lubricant</span></tt>. You can change which symbols you’d like to use for tagging in the configuration.</p>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p class="last"><tt class="docutils literal"><span class="pre">jrnl</span> <span class="pre">@pinkie</span> <span class="pre">@WorldDomination</span></tt> will switch to viewing mode because although _no_ command line arguments are given, all the input strings look like tags - <em>jrnl</em> will assume you want to filter by tag.</p>
|
||||
<p class="last"><tt class="docutils literal"><span class="pre">jrnl</span> <span class="pre">@pinkie</span> <span class="pre">@WorldDomination</span></tt> will switch to viewing mode because although <strong>no</strong> command line arguments are given, all the input strings look like tags - <em>jrnl</em> will assume you want to filter by tag.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="editing-older-entries">
|
||||
<h2>Editing older entries<a class="headerlink" href="#editing-older-entries" title="Permalink to this headline">¶</a></h2>
|
||||
<p>You can edit selected entries after you wrote them. This is particularly useful when your journal file is encrypted or if you’re using a DayOne journal. To use this feature, you need to have an editor configured in your journal configuration file (see <a class="reference internal" href="advanced.html"><em>advanced usage</em></a>):</p>
|
||||
<div class="highlight-python"><pre>jrnl -until 1950 @texas -and @history --edit</pre>
|
||||
</div>
|
||||
<p>Will open your editor with all entries tagged with <tt class="docutils literal"><span class="pre">@texas</span></tt> and <tt class="docutils literal"><span class="pre">@history</span></tt> before 1950. You can make any changes to them you want; after you save the file and close the editor, your journal will be updated.</p>
|
||||
<p>Of course, if you are using multiple journals, you can also edit e.g. the latest entry of your work journal with <tt class="docutils literal"><span class="pre">jrnl</span> <span class="pre">work</span> <span class="pre">-n</span> <span class="pre">1</span> <span class="pre">--edit</span></tt>. In any case, this will bring up your editor and save (and, if applicable, encrypt) your edited journal after you save and exit the editor.</p>
|
||||
<p>You can also use this feature for deleting entries from your journal:</p>
|
||||
<div class="highlight-python"><pre>jrnl @girlfriend -until 'june 2012' --edit</pre>
|
||||
</div>
|
||||
<p>Just select all text, press delete, and everything is gone...</p>
|
||||
<div class="section" id="editing-dayone-journals">
|
||||
<h3>Editing DayOne Journals<a class="headerlink" href="#editing-dayone-journals" title="Permalink to this headline">¶</a></h3>
|
||||
<p>DayOne journals can be edited exactly the same way, however the output looks a little bit different because of the way DayOne stores its entries:</p>
|
||||
<div class="highlight-output"><pre># af8dbd0d43fb55458f11aad586ea2abf
|
||||
2013-05-02 15:30 I told everyone I built my @robot wife for sex.
|
||||
But late at night when we're alone we mostly play Battleship.
|
||||
|
||||
# 2391048fe24111e1983ed49a20be6f9e
|
||||
2013-08-10 03:22 I had all kinds of plans in case of a @zombie attack.
|
||||
I just figured I'd be on the other side.</pre>
|
||||
</div>
|
||||
<p>The long strings starting with hash symbol are the so-called UUIDs, unique identifiers for each entry. Don’t touch them. If you do, then the old entry would get deleted and a new one written, which means that you could DayOne loose data that jrnl can’t handle (such as as the entry’s geolocation).</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -132,6 +157,10 @@
|
|||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#viewing">Viewing</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#using-tags">Using Tags</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#editing-older-entries">Editing older entries</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#editing-dayone-journals">Editing DayOne Journals</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="encryption.html">Encryption</a></li>
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue