Updated docs from master

This commit is contained in:
Jon Johnson 2014-06-24 13:41:12 -04:00
parent f4344c8793
commit 73f50a40cd
59 changed files with 720 additions and 840 deletions

View file

@ -1,4 +1,3 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
@ -14,7 +13,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
URL_ROOT: './',
VERSION: '1.8.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
@ -103,10 +102,12 @@
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Although it seems intuitive to use the <cite>#</cite> character for tags, there&#8217;s a drawback: on most shells, this is interpreted as a meta-character starting a comment. This means that if you type</p>
<div class="highlight-note"><pre>jrnl Implemented endless scrolling on the #frontend of our website.</pre>
<div class="highlight-note"><div class="highlight"><pre>jrnl Implemented endless scrolling on the #frontend of our website.
</pre></div>
</div>
<p>your bash will chop off everything after the <tt class="docutils literal"><span class="pre">#</span></tt> before passing it to _jrnl_). To avoid this, wrap your input into quotation marks like this:</p>
<div class="highlight-note"><pre>jrnl "Implemented endless scrolling on the #frontend of our website."</pre>
<div class="highlight-note"><div class="highlight"><pre>jrnl &quot;Implemented endless scrolling on the #frontend of our website.&quot;
</pre></div>
</div>
<p class="last">Or use the built-in prompt or an external editor to compose your entries.</p>
</div>
@ -142,9 +143,11 @@
</pre></div>
</div>
<p>The <tt class="docutils literal"><span class="pre">default</span></tt> journal gets created the first time you start _jrnl_. Now you can access the <tt class="docutils literal"><span class="pre">work</span></tt> journal by using <tt class="docutils literal"><span class="pre">jrnl</span> <span class="pre">work</span></tt> instead of <tt class="docutils literal"><span class="pre">jrnl</span></tt>, eg.</p>
<div class="highlight-python"><pre>jrnl work at 10am: Meeting with @Steve</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl work at 10am: Meeting with @Steve
</pre></div>
</div>
<div class="highlight-python"><pre>jrnl work -n 3</pre>
<div class="highlight-python"><div class="highlight"><pre>jrnl work -n 3
</pre></div>
</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_config</span></tt> looks like this:</p>