fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-07-03 15: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

67
recipes.html
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>