Typos and new style

This commit is contained in:
Manuel Ebert 2013-03-13 01:06:31 -07:00
parent c1ba5df0f1
commit 868af3704e
9 changed files with 2886 additions and 45 deletions

23
.gitignore vendored Normal file
View file

@ -0,0 +1,23 @@
*.py[cod]
# C extensions
*.so
# Packages
*.egg
*.egg-info
dist
build
eggs
parts
bin
var
sdist
develop-eggs
.installed.cfg
lib
lib64
# Installer logs
pip-log.txt
.DS_Store

View file

@ -1,6 +1,10 @@
Changelog Changelog
========= =========
### 1.0.1 (March 12, 2013)
* [Fixed] Requires parsedatetime 1.1.2 or newer
### 1.0.0 (March 4, 2013) ### 1.0.0 (March 4, 2013)
* [New] Integrates seamlessly with DayOne * [New] Integrates seamlessly with DayOne

View file

@ -20,7 +20,7 @@ to make a new entry, just type
and hit return. `yesterday:` will be interpreted as a timestamp. Everything until the first sentence mark (`.?!`) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this: and hit return. `yesterday:` will be interpreted as a timestamp. Everything until the first sentence mark (`.?!`) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this:
2012-03-29 09:00 Called in sick. 2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book. Used the time to clean the house and spent 4h on writing my book.
If you just call `jrnl`, you will be prompted to compose your entry - but you can also configure _jrnl_ to use your external editor. If you just call `jrnl`, you will be prompted to compose your entry - but you can also configure _jrnl_ to use your external editor.
@ -44,15 +44,15 @@ The first time you run `jrnl` you will be asked where your journal file should b
Usage Usage
----- -----
_jrnl_ has to modes: __composing__ and __viewing__. _jrnl_ has to modes: __composing__ and __viewing__.
### Viewing: ### Viewing:
jrnl -n 10 jrnl -n 10
will list you the ten latest entries, will list you the ten latest entries,
jrnl -from "last year" -to march jrnl -from "last year" -to march
everything that happened from the start of last year to the start of last march. If you only want to see the titles of your entries, use everything that happened from the start of last year to the start of last march. If you only want to see the titles of your entries, use
@ -62,7 +62,7 @@ everything that happened from the start of last year to the start of last march.
Keep track of people, projects or locations, by tagging them with an `@` in your entries: Keep track of people, projects or locations, by tagging them with an `@` in your entries:
jrnl Had a wonderful day on the #beach with @Tom and @Anna. jrnl Had a wonderful day on the @beach with @Tom and @Anna.
You can filter your journal entries just like this: You can filter your journal entries just like this:
@ -74,7 +74,14 @@ Will print all entries in which either `@pinkie` or `@WorldDomination` occurred.
the last five entries containing both `@pineapple` __and__ `@lubricant`. You can change which symbols you'd like to use for tagging in the configuration. the last five entries containing both `@pineapple` __and__ `@lubricant`. You can change which symbols you'd like to use for tagging in the configuration.
> __Note:__ `jrnl @pinkie @WorldDomination` will switch to viewing mode because although now command line arguments are given, all the input strings look like tags - _jrnl_ will assume you want to filter by tag. > __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.
### Composing:
Composing mode is entered by either starting `jrnl` without any arguments -- which will prompt you to write an entry or launch your editor -- or by just writing an entry on the prompt, such as
jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
### Smart timestamps: ### Smart timestamps:
@ -111,6 +118,7 @@ Why not create a beautiful [timeline](http://timeline.verite.co/) of your journa
jrnl --markdown jrnl --markdown
Markdown is a simple markup language that is human readable and can be used to be rendered to other formats (html, pdf). This README for example is formatted in markdown and github makes it look nice. Markdown is a simple markup language that is human readable and can be used to be rendered to other formats (html, pdf). This README for example is formatted in markdown and github makes it look nice.
Encryption Encryption
@ -143,25 +151,30 @@ The configuration file is a simple JSON file with the following options.
- `tagsymbols`: Symbols to be interpreted as tags. (__See note below__) - `tagsymbols`: Symbols to be interpreted as tags. (__See note below__)
- `default_hour` and `default_minute`: if you supply a date, such as `last thursday`, but no specific time, the entry will be created at this time - `default_hour` and `default_minute`: if you supply a date, such as `last thursday`, but no specific time, the entry will be created at this time
- `timeformat`: how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference - `timeformat`: how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference
- `highlight`: if `true` and you have [clint](http://www.nicosphere.net/clint-command-line-library-for-python/) installed, tags will be highlighted in cyan. <<<<<<< HEAD
- `highlight`: if `true` and you have [clint](http://www.nicosphere.net/clint-command-line-library-for-python/) installed, tags will be highlighted in cyan.
=======
- `highlight`: if `true` and you have [clint](http://www.nicosphere.net/clint-command-line-library-for-python/) installed, tags will be highlighted in cyan.
>>>>>>> Typos and new style
- `linewrap`: controls the width of the output. Set to `0` or `false` if you don't want to wrap long lines. - `linewrap`: controls the width of the output. Set to `0` or `false` if you don't want to wrap long lines.
> __Note on `tagsymbols`:__ Although it seems intuitive to use the `#` character for tags, there's a drawback: on most shells, this is interpreted as a meta-character starting a comment. This means that if you type > __Note on `tagsymbols`:__ Although it seems intuitive to use the `#` character for tags, there's a drawback: on most shells, this is interpreted as a meta-character starting a comment. This means that if you type
> >
> jrnl Implemented endless scrolling on the #frontend of our website. > jrnl Implemented endless scrolling on the #frontend of our website.
> >
> your bash will chop off everything after the `#` before passing it to _jrnl_). To avoid this, wrap your input into quotation marks like this: > your bash will chop off everything after the `#` before passing it to _jrnl_). To avoid this, wrap your input into quotation marks like this:
> >
> jrnl "Implemented endless scrolling on the #frontend of our website." > jrnl "Implemented endless scrolling on the #frontend of our website."
> >
> Or use the built-in prompt or an external editor to compose your entries. > Or use the built-in prompt or an external editor to compose your entries.
### DayOne Integration ### DayOne Integration
<<<<<<< HEAD
Using your DayOne journal instead of a flat text file is dead simple - instead of pointing to a text file, set the `"journal"` key in 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, set the `"journal"` key in your `.jrnl_conf` 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 * `~/Library/Application Support/Day One/` by default
* `~/Dropbox/Apps/Day One/` if you're syncing with Dropbox and * `~/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. * `~/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. You can also star entries when you write them: Instead of all entries being in a single file, each entry will live in a separate `plist` file. You can also star entries when you write them:
@ -177,14 +190,45 @@ You can configure _jrnl_ to use with multiple journals (eg. `private` and `work`
"work": "~/work.txt" "work": "~/work.txt"
}, },
The `default` journal gets created the first time you start _jrnl_. Now you can access the `work` journal by using `jrnl work` instead of `jrnl`, eg. The `default` journal gets created the first time you start _jrnl_. Now you can access the `work` journal by using `jrnl work` instead of `jrnl`, eg.
jrnl work at 10am: Meeting with @Steve jrnl work at 10am: Meeting with @Steve
jrnl work -n 3 jrnl work -n 3
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`). 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_conf` looks like this:
=======
Using your DayOne journal instead of a flat text file is dead simple - instead of pointing to a text file, set the `"journal"` key in your `.jrnl_conf` 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
* `~/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. You can also star entries when you write them:
jrnl -star yesterday: Lunch with @Arthur
### Multiple journal files
You can configure _jrnl_ to use with multiple journals (eg. `private` and `work`) by defining more journals in your `.jrnl_config`, for example:
"journals": {
"default": "~/journal.txt",
"work": "~/work.txt"
},
The `default` journal gets created the first time you start _jrnl_. Now you can access the `work` journal by using `jrnl work` instead of `jrnl`, eg.
jrnl work at 10am: Meeting with @Steve
jrnl work -n 3
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:
>>>>>>> Typos and new style
{ {
... ...
"encrypt": false "encrypt": false

View file

@ -145,9 +145,19 @@ blockquote p{
font-size: 11pt; font-size: 11pt;
} }
.logo .span10 { .logo .span12 {
text-align: center; text-align: center;
height: 180px; height: 180px;
padding-bottom: 180px;
background: url(../img/header.png) center bottom no-repeat;
}
@media screen and (max-width: 550px) {
.logo .span12 {
background-size: 100%;
padding-bottom: 30%;
}
} }
.logo .span2 { .logo .span2 {

BIN
img/header.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

2746
img/header.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 137 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

View file

@ -43,10 +43,10 @@
<a href="http://github.com/maebert/jrnl"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> <a href="http://github.com/maebert/jrnl"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
<div class="container">
<div class="container">
<div class="logo row"> <div class="logo row">
<div class="span2">&nbsp;</div> <div class="span12"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
<div class="span10"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
</div> </div>
<div class="row"> <div class="row">
@ -54,7 +54,7 @@
<a href="#" title="Top"><div class="leftlogo"></div></a> <a href="#" title="Top"><div class="leftlogo"></div></a>
<div class="sidebar-nav" id='navbar'> <div class="sidebar-nav" id='navbar'>
<ul class="nav nav-list"> <ul class="nav nav-list">
</ul> </ul>
</div> </div>
&nbsp; &nbsp;
@ -81,7 +81,7 @@
<p>and hit return. <code>yesterday:</code> will be interpreted as a timestamp. Everything until the first sentence mark (<code>.?!</code>) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this:</p> <p>and hit return. <code>yesterday:</code> will be interpreted as a timestamp. Everything until the first sentence mark (<code>.?!</code>) will be interpreted as the title, the rest as the body. In your journal file, the result will look like this:</p>
<pre><code>2012-03-29 09:00 Called in sick. <pre><code>2012-03-29 09:00 Called in sick.
Used the time to clean the house and spent 4h on writing my book. Used the time to clean the house and spent 4h on writing my book.
</code></pre> </code></pre>
@ -105,7 +105,7 @@ python setup.py install
<h2>Usage</h2> <h2>Usage</h2>
<p><em>jrnl</em> has to modes: <strong>composing</strong> and <strong>viewing</strong>. </p> <p><em>jrnl</em> has to modes: <strong>composing</strong> and <strong>viewing</strong>.</p>
<h3>Viewing:</h3> <h3>Viewing:</h3>
@ -126,7 +126,7 @@ python setup.py install
<p>Keep track of people, projects or locations, by tagging them with an <code>@</code> in your entries:</p> <p>Keep track of people, projects or locations, by tagging them with an <code>@</code> in your entries:</p>
<pre><code>jrnl Had a wonderful day on the #beach with @Tom and @Anna. <pre><code>jrnl Had a wonderful day on the @beach with @Tom and @Anna.
</code></pre> </code></pre>
<p>You can filter your journal entries just like this:</p> <p>You can filter your journal entries just like this:</p>
@ -142,9 +142,16 @@ python setup.py install
<p>the last five entries containing both <code>@pineapple</code> <strong>and</strong> <code>@lubricant</code>. You can change which symbols you'd like to use for tagging in the configuration.</p> <p>the last five entries containing both <code>@pineapple</code> <strong>and</strong> <code>@lubricant</code>. You can change which symbols you'd like to use for tagging in the configuration.</p>
<blockquote> <blockquote>
<p><strong>Note:</strong> <code>jrnl @pinkie @WorldDomination</code> will switch to viewing mode because although now 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><strong>Note:</strong> <code>jrnl @pinkie @WorldDomination</code> will switch to viewing mode because although <em>no</em> command line arguments are given, all the input strings look like tags - <em>jrnl</em> will assume you want to filter by tag.</p>
</blockquote> </blockquote>
<h3>Composing:</h3>
<p>Composing mode is entered by either starting <code>jrnl</code> without any arguments -- which will prompt you to write an entry or launch your editor -- or by just writing an entry on the prompt, such as</p>
<pre><code>jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
</code></pre>
<h3>Smart timestamps:</h3> <h3>Smart timestamps:</h3>
<p>Timestamps that work:</p> <p>Timestamps that work:</p>
@ -216,7 +223,7 @@ python setup.py install
<li><code>tagsymbols</code>: Symbols to be interpreted as tags. (<strong>See note below</strong>)</li> <li><code>tagsymbols</code>: Symbols to be interpreted as tags. (<strong>See note below</strong>)</li>
<li><code>default_hour</code> and <code>default_minute</code>: if you supply a date, such as <code>last thursday</code>, but no specific time, the entry will be created at this time</li> <li><code>default_hour</code> and <code>default_minute</code>: if you supply a date, such as <code>last thursday</code>, but no specific time, the entry will be created at this time</li>
<li><code>timeformat</code>: how to format the timestamps in your journal, see the <a href="http://docs.python.org/library/time.html#time.strftime">python docs</a> for reference</li> <li><code>timeformat</code>: how to format the timestamps in your journal, see the <a href="http://docs.python.org/library/time.html#time.strftime">python docs</a> for reference</li>
<li><code>highlight</code>: if <code>true</code> and you have <a href="http://www.nicosphere.net/clint-command-line-library-for-python/">clint</a> installed, tags will be highlighted in cyan. </li> <li><code>highlight</code>: if <code>true</code> and you have <a href="http://www.nicosphere.net/clint-command-line-library-for-python/">clint</a> installed, tags will be highlighted in cyan.</li>
<li><code>linewrap</code>: controls the width of the output. Set to <code>0</code> or <code>false</code> if you don't want to wrap long lines.</li> <li><code>linewrap</code>: controls the width of the output. Set to <code>0</code> or <code>false</code> if you don't want to wrap long lines.</li>
</ul> </ul>
@ -225,12 +232,12 @@ python setup.py install
<pre><code>jrnl Implemented endless scrolling on the #frontend of our website. <pre><code>jrnl Implemented endless scrolling on the #frontend of our website.
</code></pre> </code></pre>
<p>your bash will chop off everything after the <code>#</code> before passing it to <em>jrnl</em>). To avoid this, wrap your input into quotation marks like this:</p> <p>your bash will chop off everything after the <code>#</code> before passing it to <em>jrnl</em>). To avoid this, wrap your input into quotation marks like this:</p>
<pre><code>jrnl "Implemented endless scrolling on the #frontend of our website." <pre><code>jrnl "Implemented endless scrolling on the #frontend of our website."
</code></pre> </code></pre>
<p>Or use the built-in prompt or an external editor to compose your entries.</p> <p>Or use the built-in prompt or an external editor to compose your entries.</p>
</blockquote> </blockquote>
@ -239,7 +246,7 @@ python setup.py install
<p>Using your DayOne journal instead of a flat text file is dead simple - instead of pointing to a text file, set the <code>"journal"</code> key in your <code>.jrnl_conf</code> to point to your DayOne journal. This is a folder ending with <code>.dayone</code>, and it's located at</p> <p>Using your DayOne journal instead of a flat text file is dead simple - instead of pointing to a text file, set the <code>"journal"</code> key in your <code>.jrnl_conf</code> to point to your DayOne journal. This is a folder ending with <code>.dayone</code>, and it's located at</p>
<pre><code>* `~/Library/Application Support/Day One/` by default <pre><code>* `~/Library/Application Support/Day One/` by default
* `~/Dropbox/Apps/Day One/` if you're syncing with Dropbox and * `~/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. * `~/Library/Mobile Documents/5U8NS4GX82~com~dayoneapp~dayone/Documents/` if you're syncing with iCloud.
</code></pre> </code></pre>
@ -258,7 +265,7 @@ python setup.py install
}, },
</code></pre> </code></pre>
<p>The <code>default</code> journal gets created the first time you start <em>jrnl</em>. Now you can access the <code>work</code> journal by using <code>jrnl work</code> instead of <code>jrnl</code>, eg. </p> <p>The <code>default</code> journal gets created the first time you start <em>jrnl</em>. Now you can access the <code>work</code> journal by using <code>jrnl work</code> instead of <code>jrnl</code>, eg.</p>
<pre><code>jrnl work at 10am: Meeting with @Steve <pre><code>jrnl work at 10am: Meeting with @Steve
jrnl work -n 3 jrnl work -n 3
@ -266,18 +273,20 @@ jrnl work -n 3
<p>will both use <code>~/work.txt</code>, while <code>jrnl -n 3</code> will display the last three entries from <code>~/journal.txt</code> (and so does <code>jrnl default -n 3</code>).</p> <p>will both use <code>~/work.txt</code>, while <code>jrnl -n 3</code> will display the last three entries from <code>~/journal.txt</code> (and so does <code>jrnl default -n 3</code>).</p>
<p>You can also override the default options for each individual journal. If you <code>.jrnl_conf</code> looks like this: <p>You can also override the default options for each individual journal. If you <code>.jrnl_conf</code> looks like this:</p>
{
... <pre><code>{
"encrypt": false ...
"journals": { "encrypt": false
"default": "~/journal.txt", "journals": {
"work": { "default": "~/journal.txt",
"journal": "~/work.txt", "work": {
"encrypt": true "journal": "~/work.txt",
}, "encrypt": true
"food": "~/my_recipes.txt", },
}</p> "food": "~/my_recipes.txt",
}
</code></pre>
<p>Your <code>default</code> and your <code>food</code> journals won't be encrypted, however your <code>work</code> journal will! You can override all options that are present at the top level of <code>.jrnl_conf</code>, just make sure that at the very least you specify a <code>"journal": ...</code> key that points to the journal file of that journal.</p> <p>Your <code>default</code> and your <code>food</code> journals won't be encrypted, however your <code>work</code> journal will! You can override all options that are present at the top level of <code>.jrnl_conf</code>, just make sure that at the very least you specify a <code>"journal": ...</code> key that points to the journal file of that journal.</p>
@ -301,6 +310,12 @@ with open("my_journal.txt") as f:
</ul> </ul>
<h1>Changelog</h1> <h1>Changelog</h1>
<h3>1.0.1 (March 12, 2013)</h3>
<ul>
<li class="badge"><span class="change-fixed">Fixed</span> Requires parsedatetime 1.1.2 or newer</li>
</ul>
<h3>1.0.0 (March 4, 2013)</h3> <h3>1.0.0 (March 4, 2013)</h3>
<ul> <ul>
@ -401,7 +416,7 @@ with open("my_journal.txt") as f:
<div class="row"> <div class="row">
<footer class="span10 offset2"> <footer class="span10 offset2">
<b>jrnl</b> is an open source project created with love by <a href="http://www.portwempreludium.de">Manuel Ebert</a> and <a href="http://www.github.com/dedan">Stephan Gabler</a>. <b>jrnl</b> is an open source project created with love by <a href="http://www.portwempreludium.de">Manuel Ebert</a> and <a href="http://www.github.com/dedan">Stephan Gabler</a>.
</footer> </footer>
</div> </div>
</div> </div>

View file

@ -43,10 +43,9 @@
<a href="http://github.com/maebert/jrnl"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> <a href="http://github.com/maebert/jrnl"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
<div class="container"> <div class="container">
<div class="logo row"> <div class="logo row">
<div class="span2">&nbsp;</div> <div class="span12"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
<div class="span10"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
</div> </div>
<div class="row"> <div class="row">
@ -54,10 +53,10 @@
<a href="#" title="Top"><div class="leftlogo"></div></a> <a href="#" title="Top"><div class="leftlogo"></div></a>
<div class="sidebar-nav" id='navbar'> <div class="sidebar-nav" id='navbar'>
<ul class="nav nav-list"> <ul class="nav nav-list">
</ul> </ul>
</div> </div>
&nbsp; &nbsp;
</div> </div>
<div class="span10 content"> <div class="span10 content">