mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
Typos and new style
This commit is contained in:
parent
c1ba5df0f1
commit
868af3704e
9 changed files with 2886 additions and 45 deletions
23
.gitignore
vendored
Normal file
23
.gitignore
vendored
Normal 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
|
|
@ -1,6 +1,10 @@
|
|||
Changelog
|
||||
=========
|
||||
|
||||
### 1.0.1 (March 12, 2013)
|
||||
|
||||
* [Fixed] Requires parsedatetime 1.1.2 or newer
|
||||
|
||||
### 1.0.0 (March 4, 2013)
|
||||
|
||||
* [New] Integrates seamlessly with DayOne
|
||||
|
|
48
README.md
48
README.md
|
@ -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:
|
||||
|
||||
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:
|
||||
|
||||
|
@ -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.
|
||||
|
||||
> __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:
|
||||
|
||||
|
@ -111,6 +118,7 @@ Why not create a beautiful [timeline](http://timeline.verite.co/) of your journa
|
|||
|
||||
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.
|
||||
|
||||
Encryption
|
||||
|
@ -143,7 +151,11 @@ The configuration file is a simple JSON file with the following options.
|
|||
- `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
|
||||
- `timeformat`: how to format the timestamps in your journal, see the [python docs](http://docs.python.org/library/time.html#time.strftime) for reference
|
||||
<<<<<<< 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.
|
||||
|
||||
> __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
|
||||
|
@ -157,6 +169,7 @@ The configuration file is a simple JSON file with the following options.
|
|||
> Or use the built-in prompt or an external editor to compose your entries.
|
||||
|
||||
### 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
|
||||
|
||||
|
@ -185,6 +198,37 @@ The `default` journal gets created the first time you start _jrnl_. Now you can
|
|||
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:
|
||||
=======
|
||||
|
||||
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
|
||||
|
|
12
css/jrnl.css
12
css/jrnl.css
|
@ -145,9 +145,19 @@ blockquote p{
|
|||
font-size: 11pt;
|
||||
}
|
||||
|
||||
.logo .span10 {
|
||||
.logo .span12 {
|
||||
text-align: center;
|
||||
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 {
|
||||
|
|
BIN
img/header.png
Normal file
BIN
img/header.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 21 KiB |
2746
img/header.svg
Normal file
2746
img/header.svg
Normal file
File diff suppressed because one or more lines are too long
After Width: | Height: | Size: 137 KiB |
BIN
img/logo-top.png
BIN
img/logo-top.png
Binary file not shown.
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
35
index.html
35
index.html
|
@ -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>
|
||||
|
||||
|
||||
<div class="container">
|
||||
<div class="logo row">
|
||||
<div class="span2"> </div>
|
||||
<div class="span10"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
|
||||
<div class="span12"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
|
||||
|
@ -105,7 +105,7 @@ python setup.py install
|
|||
|
||||
<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>
|
||||
|
||||
|
@ -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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>
|
||||
|
||||
<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>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>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>
|
||||
</ul>
|
||||
|
||||
|
@ -258,7 +265,7 @@ python setup.py install
|
|||
},
|
||||
</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
|
||||
jrnl work -n 3
|
||||
|
@ -266,8 +273,9 @@ 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>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": {
|
||||
|
@ -277,7 +285,8 @@ jrnl work -n 3
|
|||
"encrypt": true
|
||||
},
|
||||
"food": "~/my_recipes.txt",
|
||||
}</p>
|
||||
}
|
||||
</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>
|
||||
|
||||
|
@ -301,6 +310,12 @@ with open("my_journal.txt") as f:
|
|||
</ul>
|
||||
<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>
|
||||
|
||||
<ul>
|
||||
|
|
|
@ -45,8 +45,7 @@
|
|||
|
||||
<div class="container">
|
||||
<div class="logo row">
|
||||
<div class="span2"> </div>
|
||||
<div class="span10"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
|
||||
<div class="span12"><img src="img/logo-top.png" title="jrnl - the friendly Command Jine Journal"/></div>
|
||||
</div>
|
||||
<div class="row">
|
||||
|
||||
|
|
Loading…
Add table
Reference in a new issue