mirror of
https://github.com/jrnl-org/jrnl.git
synced 2025-05-10 16:48:31 +02:00
Updated Readme, mainly on tag symbols
This commit is contained in:
parent
6e640dec3d
commit
d271b18232
1 changed files with 46 additions and 27 deletions
71
README.md
71
README.md
|
@ -10,12 +10,14 @@ Journals aren't only for 13-year old girls and people who have too much time on
|
||||||
|
|
||||||
to make a new entry, just type
|
to make a new entry, just type
|
||||||
|
|
||||||
jrnl
|
jrnl yesterday: Called in sick. Used the time to clean the house and spent 4h on writing my book.
|
||||||
|
|
||||||
and hit return. You will be asked to compose your entry. Everything until the first sentence mark (`.?!`) will be interpreted as the title, the rest as the body. In your journal file, the result may 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 17:16 Solved the animal-sorting problem.
|
2012-03-29 09:0 Called in sick.
|
||||||
Solution is to squeeze each instance and Fourier-transform the emitted sound.
|
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.
|
||||||
|
|
||||||
### Smart timestamps:
|
### Smart timestamps:
|
||||||
|
|
||||||
|
@ -31,25 +33,10 @@ will list you the ten latest entries,
|
||||||
|
|
||||||
everything that happened from the start of last year to the start of last march.
|
everything that happened from the start of last year to the start of last march.
|
||||||
|
|
||||||
### Tagging:
|
|
||||||
|
|
||||||
Keep track of people, projects or locations: start names with an `@` character and all other things with a hash:
|
> __Note:__ _jrnl_ has to modes: __composing__ and __viewing__. The mode depends on which arguments (starting with `-`) you specify. If no arguments are given, _jrnl_ will guess the mode: if all the input looks like tags, it will switch to viewing mode and filter by the specified tags., such as in
|
||||||
|
|
||||||
Wonderful day on the #beach with @Tom and @Anna.
|
|
||||||
|
|
||||||
You can filter your journal entries just like this:
|
|
||||||
|
|
||||||
jrnl @pinkie #WorldDomination
|
|
||||||
|
|
||||||
Will print all entries in which either `@pinkie` or `#WorldDomination` occured;
|
|
||||||
|
|
||||||
jrnl -5 -and #pineapple #lubricant
|
|
||||||
|
|
||||||
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_ has to modes: __composing__ and __viewing__. The mode depends on which arguments (starting with `-`) you specify. If no arguments are given, _jrnl_ will guess the mode: if all the input looks like tags, it will switch to viewing mode and filter by the specified tags., such as in
|
|
||||||
>
|
>
|
||||||
> jrnl #WorldDomination
|
> jrnl @WorldDomination
|
||||||
>
|
>
|
||||||
> If there is some non-argument input, _jrnl_ will treat it as a new entry, such as in
|
> If there is some non-argument input, _jrnl_ will treat it as a new entry, such as in
|
||||||
>
|
>
|
||||||
|
@ -57,6 +44,23 @@ the last five entries containing both `#pineapple` _and_ `#lubricant`. You can c
|
||||||
>
|
>
|
||||||
> If there is no input, you can still go to viewing mode by just hitting `return` when prompted to compose an entry.
|
> If there is no input, you can still go to viewing mode by just hitting `return` when prompted to compose an entry.
|
||||||
|
|
||||||
|
|
||||||
|
### Tagging:
|
||||||
|
|
||||||
|
Keep track of people, projects or locations, by tagging them with an `@`:
|
||||||
|
|
||||||
|
Wonderful day on the #beach with @Tom and @Anna.
|
||||||
|
|
||||||
|
You can filter your journal entries just like this:
|
||||||
|
|
||||||
|
jrnl @pinkie @WorldDomination
|
||||||
|
|
||||||
|
Will print all entries in which either `@pinkie` or `@WorldDomination` occured;
|
||||||
|
|
||||||
|
jrnl -n 5 -and @pineapple @lubricant
|
||||||
|
|
||||||
|
the last five entries containing both `@pineapple` _and_ `@lubricant`. You can change which symbols you'd like to use for tagging in the configuration.
|
||||||
|
|
||||||
### JSON Export
|
### JSON Export
|
||||||
|
|
||||||
Can do:
|
Can do:
|
||||||
|
@ -70,19 +74,34 @@ Can do:
|
||||||
|
|
||||||
## Advanced configuration
|
## Advanced configuration
|
||||||
|
|
||||||
After installation, _jrnl_ will create a file called `.jrnl_config` in your home directory. It's just a regular `json` file:
|
The first time launched, _jrnl_ will create a file called `.jrnl_config` in your home directory. It's just a regular `json` file:
|
||||||
|
|
||||||
{
|
{
|
||||||
journal: "~/journal.txt",
|
journal: "~/journal.txt",
|
||||||
|
editor: "",
|
||||||
|
encrypt: false,
|
||||||
|
key: ""
|
||||||
|
tagsymbols: '@'
|
||||||
default_hour: 9,
|
default_hour: 9,
|
||||||
default_minute: 0,
|
default_minute: 0,
|
||||||
timeformat: "%Y-%m-%d %H:%M",
|
timeformat: "%Y-%m-%d %H:%M",
|
||||||
tagsymbols: '#@'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Before using _jrnl_ I recommend changing your journal location to somewhere it belongs, for example your Dropbox folder.
|
|
||||||
|
|
||||||
- `journal`: path to your journal file
|
- `journal`: path to your journal file
|
||||||
|
- `editor`: if set, executes this command to launch an external editor for writing your entries, e.g. `vim` or `subl -w` (note the `-w` flag to make sure _jrnl_ waits for Sublime Text to close the file before writing into the journal).
|
||||||
|
- `encrypt`: if true, encrypts your journal using AES encryption.
|
||||||
|
- `key`: you may store the key you used to encrypt your journal in plaintext here. This is useful if your journal file lives in an unsecure space (ie. your Dropbox), but the config file itself is more or less safe.
|
||||||
|
- `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
|
||||||
- `tagsymbols`: Symbols to be interpreted as tags. _jrnl_ is agnostic about the semantic of your tags, so using `@` for people and `#` for places, events or projects is just a convention that you may or may not decide to follow too.
|
|
||||||
|
|
||||||
|
> __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.
|
||||||
|
>
|
||||||
|
> 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."
|
||||||
|
>
|
||||||
|
> Or use the built-in prompt or an external editor to compose your entries.
|
||||||
|
|
Loading…
Add table
Reference in a new issue