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

Updated docs from master

Browse source
This commit is contained in:
Manuel Ebert 2014-01-26 12:03:09 +01:00
parent 09a96d832f
commit 1fb5cca898
55 changed files with 310 additions and 218 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/environment.pickle vendored
View file

Binary file not shown.

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

Binary file not shown.

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

Binary file not shown.

BIN
docs/_build/doctrees/usage.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: 33c9943a8f514c706f3a1c21c8c907c0
config: cf5ee9599852b57d8c94c60461aa5295
tags: fbb0d17656682115ca4d033fb2f83ba1

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

@ -6,12 +6,19 @@ 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_config``. If you have the ``XDG_CONFIG_HOME`` variable set, the configuration file will be saved under ``$XDG_CONFIG_HOME/jrnl``.
.. note::
On Windows, The configuration file is typically found at ``C:\Users\[Your Username]\.jrnl_config``.
The configuration file is a simple JSON file with the following options and can be edited with any plain text editor.
- ``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``. Some editors require special options to work properly, see :doc:`FAQ <recipes>` for details.
- ``encrypt``
if ``true``, encrypts your journal using AES.
- ``tagsymbols``
@ -44,7 +51,7 @@ You can configure the way jrnl behaves in a configuration file. By default, this
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_conf`` 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 ending with ``.dayone``, and it's located at
* ``~/Library/Application Support/Day One/`` by default
* ``~/Dropbox/Apps/Day One/`` if you're syncing with Dropbox and
@ -77,7 +84,7 @@ The ``default`` journal gets created the first time you start _jrnl_. Now you ca
will both use ``~/work.txt``, while ``jrnl -n 3`` will display the last three entries from ``~/journal.txt`` (and so does ``jrnl default -n 3``).
You can also override the default options for each individual journal. If you ``.jrnl_conf`` looks like this:
You can also override the default options for each individual journal. If you ``.jrnl_config`` looks like this:
.. code-block:: javascript
@ -93,7 +100,7 @@ You can also override the default options for each individual journal. If you ``
"food": "~/my_recipes.txt",
}
Your ``default`` and your ``food`` journals won't be encrypted, however your ``work`` journal will! You can override all options that are present at the top level of ``.jrnl_conf``, just make sure that at the very least you specify a ``"journal": ...`` key that points to the journal file of that journal.
Your ``default`` and your ``food`` journals won't be encrypted, however your ``work`` journal will! You can override all options that are present at the top level of ``.jrnl_config``, just make sure that at the very least you specify a ``"journal": ...`` key that points to the journal file of that journal.
.. note::

51
docs/_build/html/_sources/recipes.txt vendored
View file

@ -24,11 +24,36 @@ You can do things like ::
To get a short summary of the 10 most recent, favourited entries before January 1, 2013 that are tagged with ``@fixed``.
External editors
----------------
Using iA Writer to write entries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To use external editors for writing and editing journal entries, set them up in your ``.jrnl_config`` (see :doc:`advanced usage <advanced>` for details). Generally, after writing an entry, you will have to save and close the file to save the changes to jrnl.
On OS X, you can use the fabulous `iA Writer <http://www.iawriter.com/mac>`_ to write entries. Configure your ``.jrnl_conf`` like this:
Sublime Text
~~~~~~~~~~~~
To use Sublime Text, install the command line tools for Sublime Text and configure your ``.jrnl_config`` like this:
.. code-block:: javascript
"editor": "subl -w"
Note the ``-w`` flag to make sure jrnl waits for Sublime Text to close the file before writing into the journal.
MacVim
~~~~~~
Similar to Sublime Text, MacVim must be started with a flag that tells the the process to wait until the file is closed before passing control back to journal. In the case of MacVim, this is ``-f``:
.. code-block:: javascript
"editor": "mvim -f"
iA Writer
~~~~~~~~~
On OS X, you can use the fabulous `iA Writer <http://www.iawriter.com/mac>`_ to write entries. Configure your ``.jrnl_config`` like this:
.. code-block:: javascript
@ -37,27 +62,13 @@ On OS X, you can use the fabulous `iA Writer <http://www.iawriter.com/mac>`_ to
What does this do? ``open -b ...`` opens a file using the application identified by the bundle identifier (a unique string for every app out there). ``-Wn`` tells the application to wait until it's closed before passing back control, and to use a new instance of the application.
Using Notepad++ to write entries on Windows
Notepad++ on Windows
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. note::
The configuration file is typically found at ``C:\Users\[Your Username]\.jrnl_conf``. This is just a text file and so can be edited in a text editor (but don't use Notepad, it will mess with the line endings).
To set `Notepad++ <http://notepad-plus-plus.org/>`_ as your editor, edit the jrnl config file (``.jrnl_conf``) like this:
To set `Notepad++ <http://notepad-plus-plus.org/>`_ as your editor, edit the jrnl config file (``.jrnl_config``) like this:
.. code-block:: javascript
{
...
"editor": "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst",
}
The double backslashes are needed so jrnl can read the file path correctly. The ``-multiInst`` option will cause jrnl to open its own Notepad++ window. When you're done editing an entry in Notepad++, save the file and close the Notepad++ window for jrnl to know you're done editing and record your changes.
Known Issues
------------
- The Windows shell prior to Windows 7 has issues with unicode encoding. If you want to use non-ascii characters, change the codepage with ``chcp 1252`` before using `jrnl` (Thanks to Yves Pouplard for solving this!)
- _jrnl_ relies on the `PyCrypto` package to encrypt journals, which has some known problems with installing on Windows and within virtual environments.
The double backslashes are needed so jrnl can read the file path correctly. The ``-multiInst`` option will cause jrnl to open its own Notepad++ window.

23
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.5 documentation</title>
<title>Advanced Usage &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 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,12 @@
<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 <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>
<p>You can configure the way jrnl behaves in a configuration file. By default, this is <tt class="docutils literal"><span class="pre">~/.jrnl_config</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>.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">On Windows, The configuration file is typically found at <tt class="docutils literal"><span class="pre">C:\Users\[Your</span> <span class="pre">Username]\.jrnl_config</span></tt>.</p>
</div>
<p>The configuration file is a simple JSON file with the following options and can be edited with any plain text editor.</p>
<ul>
<li><dl class="first docutils">
<dt><tt class="docutils literal"><span class="pre">journals</span></tt></dt>
@ -54,7 +59,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 <em>jrnl</em> waits for Sublime Text to close the file before writing into the journal. If you&#8217;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>. Some editors require special options to work properly, see <a class="reference internal" href="recipes.html"><em>FAQ</em></a> for details.</p>
</dd>
</dl>
</li>
@ -108,7 +113,7 @@
</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_conf</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 ending with <tt class="docutils literal"><span class="pre">.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>
@ -134,7 +139,7 @@
<div class="highlight-python"><pre>jrnl work -n 3</pre>
</div>
<p>will both use <tt class="docutils literal"><span class="pre">~/work.txt</span></tt>, while <tt class="docutils literal"><span class="pre">jrnl</span> <span class="pre">-n</span> <span class="pre">3</span></tt> will display the last three entries from <tt class="docutils literal"><span class="pre">~/journal.txt</span></tt> (and so does <tt class="docutils literal"><span class="pre">jrnl</span> <span class="pre">default</span> <span class="pre">-n</span> <span class="pre">3</span></tt>).</p>
<p>You can also override the default options for each individual journal. If you <tt class="docutils literal"><span class="pre">.jrnl_conf</span></tt> looks like this:</p>
<p>You can also override the default options for each individual journal. If you <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt> looks like this:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="p">...</span>
<span class="s2">&quot;encrypt&quot;</span><span class="o">:</span> <span class="kc">false</span>
@ -148,7 +153,7 @@
<span class="p">}</span>
</pre></div>
</div>
<p>Your <tt class="docutils literal"><span class="pre">default</span></tt> and your <tt class="docutils literal"><span class="pre">food</span></tt> journals won&#8217;t be encrypted, however your <tt class="docutils literal"><span class="pre">work</span></tt> journal will! You can override all options that are present at the top level of <tt class="docutils literal"><span class="pre">.jrnl_conf</span></tt>, just make sure that at the very least you specify a <tt class="docutils literal"><span class="pre">&quot;journal&quot;:</span> <span class="pre">...</span></tt> key that points to the journal file of that journal.</p>
<p>Your <tt class="docutils literal"><span class="pre">default</span></tt> and your <tt class="docutils literal"><span class="pre">food</span></tt> journals won&#8217;t be encrypted, however your <tt class="docutils literal"><span class="pre">work</span></tt> journal will! You can override all options that are present at the top level of <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt>, just make sure that at the very least you specify a <tt class="docutils literal"><span class="pre">&quot;journal&quot;:</span> <span class="pre">...</span></tt> key that points to the journal file of that journal.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">Changing <tt class="docutils literal"><span class="pre">encrypt</span></tt> to a different value will not encrypt or decrypt your journal file, it merely says whether or not your journal <cite>is</cite> encrypted. Hence manually changing this option will most likely result in your journal file being impossible to load.</p>
@ -206,7 +211,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

8
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.5 documentation</title>
<title>Encryption &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 documentation" href="index.html" />
<link rel="next" title="Import and Export" href="export.html" />
<link rel="prev" title="Basic Usage" href="usage.html" />
@ -113,7 +113,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

8
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.5 documentation</title>
<title>Import and Export &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 documentation" href="index.html" />
<link rel="next" title="Advanced Usage" href="advanced.html" />
<link rel="prev" title="Encryption" href="encryption.html" />
@ -137,7 +137,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

8
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.5 documentation</title>
<title>Index &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 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">
@ -82,7 +82,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

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

@ -79,7 +79,7 @@
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</div>

8
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.5 documentation</title>
<title>Getting started &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 documentation" href="index.html" />
<link rel="next" title="Basic Usage" href="usage.html" />
<link rel="prev" title="Overview" href="overview.html" />
@ -109,7 +109,7 @@ Used the time to clean the house and spent 4h on writing my book.</pre>
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

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

Binary file not shown.

8
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.5 documentation</title>
<title>Overview &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 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" />
@ -95,7 +95,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

67
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.5 documentation</title>
<title>FAQ &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 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">
@ -57,37 +57,42 @@
</div>
<p>To get a short summary of the 10 most recent, favourited entries before January 1, 2013 that are tagged with <tt class="docutils literal"><span class="pre">&#64;fixed</span></tt>.</p>
</div>
<div class="section" id="using-ia-writer-to-write-entries">
<h3>Using iA Writer to write entries<a class="headerlink" href="#using-ia-writer-to-write-entries" title="Permalink to this headline"></a></h3>
<p>On OS X, you can use the fabulous <a class="reference external" href="http://www.iawriter.com/mac">iA Writer</a> to write entries. Configure your <tt class="docutils literal"><span class="pre">.jrnl_conf</span></tt> like this:</p>
</div>
<div class="section" id="external-editors">
<h2>External editors<a class="headerlink" href="#external-editors" title="Permalink to this headline"></a></h2>
<p>To use external editors for writing and editing journal entries, set them up in your <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt> (see <a class="reference internal" href="advanced.html"><em>advanced usage</em></a> for details). Generally, after writing an entry, you will have to save and close the file to save the changes to jrnl.</p>
<div class="section" id="sublime-text">
<h3>Sublime Text<a class="headerlink" href="#sublime-text" title="Permalink to this headline"></a></h3>
<p>To use Sublime Text, install the command line tools for Sublime Text and configure your <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt> like this:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="s2">&quot;editor&quot;</span><span class="o">:</span> <span class="s2">&quot;subl -w&quot;</span>
</pre></div>
</div>
<p>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.</p>
</div>
<div class="section" id="macvim">
<h3>MacVim<a class="headerlink" href="#macvim" title="Permalink to this headline"></a></h3>
<p>Similar to Sublime Text, MacVim must be started with a flag that tells the the process to wait until the file is closed before passing control back to journal. In the case of MacVim, this is <tt class="docutils literal"><span class="pre">-f</span></tt>:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="s2">&quot;editor&quot;</span><span class="o">:</span> <span class="s2">&quot;mvim -f&quot;</span>
</pre></div>
</div>
</div>
<div class="section" id="ia-writer">
<h3>iA Writer<a class="headerlink" href="#ia-writer" title="Permalink to this headline"></a></h3>
<p>On OS X, you can use the fabulous <a class="reference external" href="http://www.iawriter.com/mac">iA Writer</a> to write entries. Configure your <tt class="docutils literal"><span class="pre">.jrnl_config</span></tt> like this:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="s2">&quot;editor&quot;</span><span class="o">:</span> <span class="s2">&quot;open -b jp.informationarchitects.WriterForMacOSX -Wn&quot;</span>
</pre></div>
</div>
<p>What does this do? <tt class="docutils literal"><span class="pre">open</span> <span class="pre">-b</span> <span class="pre">...</span></tt> opens a file using the application identified by the bundle identifier (a unique string for every app out there). <tt class="docutils literal"><span class="pre">-Wn</span></tt> tells the application to wait until it&#8217;s closed before passing back control, and to use a new instance of the application.</p>
</div>
<div class="section" id="using-notepad-to-write-entries-on-windows">
<h3>Using Notepad++ to write entries on Windows<a class="headerlink" href="#using-notepad-to-write-entries-on-windows" title="Permalink to this headline"></a></h3>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The configuration file is typically found at <tt class="docutils literal"><span class="pre">C:\Users\[Your</span> <span class="pre">Username]\.jrnl_conf</span></tt>. This is just a text file and so can be edited in a text editor (but don&#8217;t use Notepad, it will mess with the line endings).</p>
</div>
<p>To set <a class="reference external" href="http://notepad-plus-plus.org/">Notepad++</a> as your editor, edit the jrnl config file (<tt class="docutils literal"><span class="pre">.jrnl_conf</span></tt>) like this:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
<span class="p">...</span>
<span class="s2">&quot;editor&quot;</span><span class="o">:</span> <span class="s2">&quot;C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst&quot;</span><span class="p">,</span>
<span class="p">}</span>
<div class="section" id="notepad-on-windows">
<h3>Notepad++ on Windows<a class="headerlink" href="#notepad-on-windows" title="Permalink to this headline"></a></h3>
<p>To set <a class="reference external" href="http://notepad-plus-plus.org/">Notepad++</a> as your editor, edit the jrnl config file (<tt class="docutils literal"><span class="pre">.jrnl_config</span></tt>) like this:</p>
<div class="highlight-javascript"><div class="highlight"><pre><span class="s2">&quot;editor&quot;</span><span class="o">:</span> <span class="s2">&quot;C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst&quot;</span><span class="p">,</span>
</pre></div>
</div>
<p>The double backslashes are needed so jrnl can read the file path correctly. The <tt class="docutils literal"><span class="pre">-multiInst</span></tt> option will cause jrnl to open its own Notepad++ window. When you&#8217;re done editing an entry in Notepad++, save the file and close the Notepad++ window for jrnl to know you&#8217;re done editing and record your changes.</p>
<p>The double backslashes are needed so jrnl can read the file path correctly. The <tt class="docutils literal"><span class="pre">-multiInst</span></tt> option will cause jrnl to open its own Notepad++ window.</p>
</div>
</div>
<div class="section" id="known-issues">
<h2>Known Issues<a class="headerlink" href="#known-issues" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>The Windows shell prior to Windows 7 has issues with unicode encoding. If you want to use non-ascii characters, change the codepage with <tt class="docutils literal"><span class="pre">chcp</span> <span class="pre">1252</span></tt> before using <cite>jrnl</cite> (Thanks to Yves Pouplard for solving this!)</li>
<li>_jrnl_ relies on the <cite>PyCrypto</cite> package to encrypt journals, which has some known problems with installing on Windows and within virtual environments.</li>
</ul>
</div>
</div>
@ -108,11 +113,15 @@
<li class="toctree-l2"><a class="reference internal" href="#id1">Recipes</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#co-occurrence-of-tags">Co-occurrence of tags</a></li>
<li class="toctree-l3"><a class="reference internal" href="#combining-filters">Combining filters</a></li>
<li class="toctree-l3"><a class="reference internal" href="#using-ia-writer-to-write-entries">Using iA Writer to write entries</a></li>
<li class="toctree-l3"><a class="reference internal" href="#using-notepad-to-write-entries-on-windows">Using Notepad++ to write entries on Windows</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#known-issues">Known Issues</a></li>
<li class="toctree-l2"><a class="reference internal" href="#external-editors">External editors</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#sublime-text">Sublime Text</a></li>
<li class="toctree-l3"><a class="reference internal" href="#macvim">MacVim</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ia-writer">iA Writer</a></li>
<li class="toctree-l3"><a class="reference internal" href="#notepad-on-windows">Notepad++ on Windows</a></li>
</ul>
</li>
</ul>
</li>
</ul>
@ -135,7 +144,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

8
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.5 documentation</title>
<title>Search &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 documentation" href="index.html" />
<script type="text/javascript">
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
@ -89,7 +89,7 @@
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>

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

File diff suppressed because one or more lines are too long

8
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.5 documentation</title>
<title>Basic Usage &mdash; jrnl 1.7.6 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.5',
VERSION: '1.7.6',
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.5 documentation" href="index.html" />
<link rel="top" title="jrnl 1.7.6 documentation" href="index.html" />
<link rel="next" title="Encryption" href="encryption.html" />
<link rel="prev" title="Getting started" href="installation.html" />
@ -187,7 +187,7 @@ I just figured I'd be on the other side.</pre>
<div class="clearer"></div>
</div>
<div class="footer">
Journal is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributtors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
jrnl is made with love by <a href="http://www.1450.me">Manuel Ebert</a> and <a href="https://github.com/maebert/jrnl/graphs/contributors" title="Contributors">other fabulous people</a>. If you need help, tweet to <a href="https://twitter.com/maebert" title="Follow @maebert on twitter">@maebert</a> or <a href="https://github.com/maebert/jrnl/issues/new" title="Open a new issue on Github">submit an issue</a> on Github.
</div>
</body>
</html>