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

Updated Readme from master

Browse source
This commit is contained in:
Manuel Ebert 2012-05-24 18:27:19 +02:00
parent 0ba2e496f2
commit 46b67dccc3
5 changed files with 86 additions and 80 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
CHANGELOG.md
View file

@ -1,47 +1,53 @@
Changelog Changelog
========= =========
### 0.2.4 ### 0.3.0 (May 24, 2012)
* Fixes parsing of new lines in journal files and entries * [Fixed] Dates such as "May 3" will now be interpreted as being in the past if the current day is at least 28 days in the future
* Adds support for encrypting and decrypting into new files * [Fixed] Bug where composed entry is lost when the journal file fails to load
* Changed directory structure and install scripts (removing the necessity to make an alias from `jrnl` to `jrnl.py`)
### 0.2.3 #### 0.2.4 (May 21, 2012)
* Adds a `-short` option that will only display the titles of entries (or, when filtering by tags, the context of the tag) * [Fixed] Parsing of new lines in journal files and entries
* Adds tag export * [Improved] Adds support for encrypting and decrypting into new files
* Adds coloured highlight of tags (by default, highlights all tags - when filtering by tags, only highlights search tags)
* `.jrnl_config` will get automatically updated when updating jrnl to a new version
### 0.2.2 #### 0.2.3 (May 3, 2012)
* Adds --encrypt and --decrypt to encrypt / descrypt existing journal files * [Improved] Adds a `-short` option that will only display the titles of entries (or, when filtering by tags, the context of the tag)
* Adds markdown export (kudos to dedan) * [Improved] Adds tag export
* [Improved] Adds coloured highlight of tags (by default, highlights all tags - when filtering by tags, only highlights search tags)
* [Improved] `.jrnl_config` will get automatically updated when updating jrnl to a new version
### 0.2.1 #### 0.2.2 (April 17, 2012)
* Submitted to [PyPi](http://pypi.python.org/pypi/jrnl/0.2.1). * [Improved] Adds --encrypt and --decrypt to encrypt / decrypt existing journal files
* [Improved] Adds markdown export (kudos to dedan)
### 0.2.0 #### 0.2.1 (April 17, 2012)
* Encrypts using CBC * [Improved] Submitted to [PyPi](http://pypi.python.org/pypi/jrnl/0.2.1).
* `key` has been renamed to `password` in config to avoid confusion. (The key use to encrypt and decrypt a journal is the SHA256-hash of the password.)
### 0.1.1 ### 0.2.0 (April 16, 2012)
* Removed unnecessary print commands * [Improved] Encrypts using CBC
* Created the documentation * [Fixed] `key` has been renamed to `password` in config to avoid confusion. (The key use to encrypt and decrypt a journal is the SHA256-hash of the password.)
### 0.1.0 #### 0.1.1 (April 15, 2012)
* Supports encrypted journals using AES encryption * [Fixed] Removed unnecessary print commands
* Support external editors for composing entries * [Improved] Created the documentation
### 0.0.2 ### 0.1.0 (April 13, 2012)
* Filtering by tags and dates * [Improved] Supports encrypted journals using AES encryption
* Now using dedicated classes for Journals and entries * [Improved] Support external editors for composing entries
### 0.0.1 #### 0.0.2 (April 5, 2012)
* [Improved] Filtering by tags and dates
* [Fixed] Now using dedicated classes for Journals and entries
#### 0.0.1 (March 29, 2012)
* Composing entries works. That's pretty much it. * Composing entries works. That's pretty much it.

17
README.md
View file

@ -73,23 +73,20 @@ Timestamps that work:
Installation Installation
------------ ------------
You can install _jrnl_ manually by cloning the repository: Install _jrnl_ using pip:
pip install jrnl
Alternatively, install manually by cloning the repository:
git clone git://github.com/maebert/jrnl.git git clone git://github.com/maebert/jrnl.git
cd jrnl cd jrnl
python setup.py install python setup.py install
or by using pip:
pip install jrnl
Afterwards, you may want to create an alias in your `.bashrc` or `.bash_profile` or whatever floats your shell:
alias jrnl="jrnl.py"
### Known Issues ### Known Issues
_jrnl_ relies on the `Crypto` package to encrypt journals, which has some known problems in automatically installing within virtual environments. - 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 `Crypto` package to encrypt journals, which has some known problems with installing within virtual environments.
Advanced usage Advanced usage
-------------- --------------

84
index.html
View file

@ -52,7 +52,7 @@
<div class="row"> <div class="row">
<div class="span2 navcontain"> <div class="span2 navcontain">
<div class="leftlogo"></div> <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">
@ -144,26 +144,24 @@ Used the time to clean the house and spent 4h on writing my book.
<h2>Installation</h2> <h2>Installation</h2>
<p>You can install <em>jrnl</em> manually by cloning the repository:</p> <p>Install <em>jrnl</em> using pip:</p>
<pre><code>pip install jrnl
</code></pre>
<p>Alternatively, install manually by cloning the repository:</p>
<pre><code>git clone git://github.com/maebert/jrnl.git <pre><code>git clone git://github.com/maebert/jrnl.git
cd jrnl cd jrnl
python setup.py install python setup.py install
</code></pre> </code></pre>
<p>or by using pip:</p>
<pre><code>pip install jrnl
</code></pre>
<p>Afterwards, you may want to create an alias in your <code>.bashrc</code> or <code>.bash_profile</code> or whatever floats your shell:</p>
<pre><code>alias jrnl="jrnl.py"
</code></pre>
<h3>Known Issues</h3> <h3>Known Issues</h3>
<p><em>jrnl</em> relies on the <code>Crypto</code> package to encrypt journals, which has some known problems in automatically installing within virtual environments.</p> <ul>
<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 <code>chcp 1252</code> before using <code>jrnl</code> (Thanks to Yves Pouplard for solving this!)</li>
<li><em>jrnl</em> relies on the <code>Crypto</code> package to encrypt journals, which has some known problems with installing within virtual environments.</li>
</ul>
<h2>Advanced usage</h2> <h2>Advanced usage</h2>
@ -263,64 +261,72 @@ with open("my_journal.txt") as f:
</code></pre> </code></pre>
<h1>Changelog</h1> <h1>Changelog</h1>
<h3>0.2.4</h3> <h3>0.3.0 (May 24, 2012)</h3>
<ul> <ul>
<li>Fixes parsing of new lines in journal files and entries</li> <li>[Fixed] Dates such as "May 3" will now be interpreted as being in the past if the current day is at least 28 days in the future</li>
<li>Adds support for encrypting and decrypting into new files</li> <li>[Fixed] Bug where composed entry is lost when the journal file fails to load</li>
<li>Changed directory structure and install scripts (removing the necessity to make an alias from <code>jrnl</code> to <code>jrnl.py</code>)</li>
</ul> </ul>
<h3>0.2.3</h3> <h4>0.2.4 (May 21, 2012)</h4>
<ul> <ul>
<li>Adds a <code>-short</code> option that will only display the titles of entries (or, when filtering by tags, the context of the tag)</li> <li>[Fixed] Parsing of new lines in journal files and entries</li>
<li>Adds tag export</li> <li>[Improved] Adds support for encrypting and decrypting into new files</li>
<li>Adds coloured highlight of tags (by default, highlights all tags - when filtering by tags, only highlights search tags)</li>
<li><code>.jrnl_config</code> will get automatically updated when updating jrnl to a new version</li>
</ul> </ul>
<h3>0.2.2</h3> <h4>0.2.3 (May 3, 2012)</h4>
<ul> <ul>
<li>Adds --encrypt and --decrypt to encrypt / descrypt existing journal files</li> <li>[Improved] Adds a <code>-short</code> option that will only display the titles of entries (or, when filtering by tags, the context of the tag)</li>
<li>Adds markdown export (kudos to dedan)</li> <li>[Improved] Adds tag export</li>
<li>[Improved] Adds coloured highlight of tags (by default, highlights all tags - when filtering by tags, only highlights search tags)</li>
<li>[Improved] <code>.jrnl_config</code> will get automatically updated when updating jrnl to a new version</li>
</ul> </ul>
<h3>0.2.1</h3> <h4>0.2.2 (April 17, 2012)</h4>
<ul> <ul>
<li>Submitted to <a href="http://pypi.python.org/pypi/jrnl/0.2.1">PyPi</a>.</li> <li>[Improved] Adds --encrypt and --decrypt to encrypt / decrypt existing journal files</li>
<li>[Improved] Adds markdown export (kudos to dedan)</li>
</ul> </ul>
<h3>0.2.0</h3> <h4>0.2.1 (April 17, 2012)</h4>
<ul> <ul>
<li>Encrypts using CBC</li> <li>[Improved] Submitted to <a href="http://pypi.python.org/pypi/jrnl/0.2.1">PyPi</a>.</li>
<li><code>key</code> has been renamed to <code>password</code> in config to avoid confusion. (The key use to encrypt and decrypt a journal is the SHA256-hash of the password.)</li>
</ul> </ul>
<h3>0.1.1</h3> <h3>0.2.0 (April 16, 2012)</h3>
<ul> <ul>
<li>Removed unnecessary print commands</li> <li>[Improved] Encrypts using CBC</li>
<li>Created the documentation</li> <li>[Fixed] <code>key</code> has been renamed to <code>password</code> in config to avoid confusion. (The key use to encrypt and decrypt a journal is the SHA256-hash of the password.)</li>
</ul> </ul>
<h3>0.1.0</h3> <h4>0.1.1 (April 15, 2012)</h4>
<ul> <ul>
<li>Supports encrypted journals using AES encryption</li> <li>[Fixed] Removed unnecessary print commands</li>
<li>Support external editors for composing entries</li> <li>[Improved] Created the documentation</li>
</ul> </ul>
<h3>0.0.2</h3> <h3>0.1.0 (April 13, 2012)</h3>
<ul> <ul>
<li>Filtering by tags and dates</li> <li>[Improved] Supports encrypted journals using AES encryption</li>
<li>Now using dedicated classes for Journals and entries</li> <li>[Improved] Support external editors for composing entries</li>
</ul> </ul>
<h3>0.0.1</h3> <h4>0.0.2 (April 5, 2012)</h4>
<ul>
<li>[Improved] Filtering by tags and dates</li>
<li>[Fixed] Now using dedicated classes for Journals and entries</li>
</ul>
<h4>0.0.1 (March 29, 2012)</h4>
<ul> <ul>
<li>Composing entries works. That's pretty much it.</li> <li>Composing entries works. That's pretty much it.</li>

5
js/jrnl.js
View file

@ -7,12 +7,9 @@ $(window).scroll(function(){
var w = $(window).width(); var w = $(window).width();
if (w > 768) { if (w > 768) {
$('.leftlogo').show(); $('.leftlogo').show();
var lt = -300 + $(window).scrollTop()*2 lt = - $("#navbar").position().top - $("#navbar").height() - $('.leftlogo').height() + $(window).scrollTop()
if (lt > 30) lt = 30; if (lt > 30) lt = 30;
$('.leftlogo').css('top', lt); $('.leftlogo').css('top', lt);
if ($(window).scrollTop() > 30) {
$('#navbar').css('margin-top', $(window).scrollTop()-30)
}
} else { } else {
$('.leftlogo').hide(); $('.leftlogo').hide();
} }

2
templates/header.html
View file

@ -52,7 +52,7 @@
<div class="row"> <div class="row">
<div class="span2 navcontain"> <div class="span2 navcontain">
<div class="leftlogo"></div> <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">