Smaller doc fixes, fixes #486

Found and removed another angsty teenager
This commit is contained in:
Manuel Ebert 2019-08-23 18:38:05 -07:00
parent 623fa6c307
commit 328faa401c
5 changed files with 46 additions and 40 deletions

View file

@ -9,7 +9,7 @@ Optionally, your journal can be encrypted using the [256-bit AES](http://en.wiki
### Why keep a journal? ### Why keep a journal?
Journals aren't just for angsty teenagers and people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it. Journals aren't just for people who have too much time on their summer vacation. A journal helps you to keep track of the things you get done and how you did them. Your imagination may be limitless, but your memory isn't. For personal use, make it a good habit to write at least 20 words a day. Just to reflect what made this day special, why you haven't wasted it. For professional use, consider a text-based journal to be the perfect complement to your GTD todo list - a documentation of what and how you've done it.
In a Nutshell In a Nutshell
------------- -------------

View file

@ -135,13 +135,11 @@ that journal.
this option will most likely result in your journal file being this option will most likely result in your journal file being
impossible to load. impossible to load.
### Known Issues ## Known Issues
- The Windows shell prior to Windows 7 has issues with unicode ### Unicode on Windows
encoding. If you want to use non-ascii characters, change the
codepage with `chcp 1252` before using The Windows shell prior to Windows 7 has issues with unicode encoding.
`jrnl` (Thanks to Yves Pouplard for To use non-ascii characters, first tweak Python to recognize the encoding by adding `'cp65001': 'utf_8'`, to `Lib/encoding/aliases.py`. Then, change the codepage with `chcp 1252` before using `jrnl`.
solving this!)
- `jrnl`relies on the PyCrypto (Related issue: [#486](https://github.com/jrnl-org/jrnl/issues/486))
package to encrypt journals, which has some known problems with
installing on Windows and within virtual environments.

View file

@ -17,7 +17,7 @@ AES](http://en.wikipedia.org/wiki/Advanced_Encryption_Standard).
## Why keep a journal? ## Why keep a journal?
Journals aren't just for angsty teenagers and people who have too much Journals aren't just for people who have too much
time on their summer vacation. A journal helps you to keep track of the time on their summer vacation. A journal helps you to keep track of the
things you get done and how you did them. Your imagination may be things you get done and how you did them. Your imagination may be
limitless, but your memory isn't. limitless, but your memory isn't.

View file

@ -15,9 +15,8 @@ And will get something like `@melo: 9`, meaning there are 9 entries
where both `@alberto` and `@melo` are tagged. How does this work? First, where both `@alberto` and `@melo` are tagged. How does this work? First,
`jrnl @alberto` will filter the journal to only entries containing the `jrnl @alberto` will filter the journal to only entries containing the
tag `@alberto`, and then the `--tags` option will print out how often tag `@alberto`, and then the `--tags` option will print out how often
each tag occurred in this <span class="title-ref">filtered</span> each tag occurred in this filtered journal. Finally, we pipe this to
journal. Finally, we pipe this to `grep` which will only display the `grep` which will only display the line containing `@melo`.
line containing `@melo`.
### Combining filters ### Combining filters
@ -73,10 +72,12 @@ jrnlimport () {
### Using templates ### Using templates
Say you always want to use the same template for creating new entries. Say you always want to use the same template for creating new entries.
If you have an `external editor <advanced>` set up, you can use this : If you have an [external editor](../advanced) set up, you can use this:
jrnl < my_template.txt ```sh
$ jrnl -1 --edit jrnl < my_template.txt
jrnl -1 --edit
```
Another nice solution that allows you to define individual prompts comes Another nice solution that allows you to define individual prompts comes
from [Jacobo de from [Jacobo de
@ -105,8 +106,10 @@ close the file to save the changes to jrnl.
To use Sublime Text, install the command line tools for Sublime Text and To use Sublime Text, install the command line tools for Sublime Text and
configure your `.jrnl_config` like this: configure your `.jrnl_config` like this:
``` javascript ``` json
"editor": "subl -w" {
"editor": "subl -w"
}
``` ```
Note the `-w` flag to make sure jrnl waits for Sublime Text to close the Note the `-w` flag to make sure jrnl waits for Sublime Text to close the
@ -118,8 +121,10 @@ Similar to Sublime Text, MacVim must be started with a flag that tells
the the process to wait until the file is closed before passing control the the process to wait until the file is closed before passing control
back to journal. In the case of MacVim, this is `-f`: back to journal. In the case of MacVim, this is `-f`:
``` javascript ``` json
"editor": "mvim -f" {
"editor": "mvim -f"
}
``` ```
### iA Writer ### iA Writer
@ -128,8 +133,10 @@ On OS X, you can use the fabulous [iA
Writer](http://www.iawriter.com/mac) to write entries. Configure your Writer](http://www.iawriter.com/mac) to write entries. Configure your
`.jrnl_config` like this: `.jrnl_config` like this:
``` javascript ``` json
"editor": "open -b pro.writer.mac -Wn" {
"editor": "open -b pro.writer.mac -Wn"
}
``` ```
What does this do? `open -b ...` opens a file using the application What does this do? `open -b ...` opens a file using the application
@ -142,9 +149,7 @@ you can find the right string to use by inspecting iA Writer's
`Info.plist` file in your shell: `Info.plist` file in your shell:
``` sh ``` sh
$ grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist
<key>CFBundleIdentifier</key>
<string>pro.writer.mac</string>
``` ```
### Notepad++ on Windows ### Notepad++ on Windows
@ -152,8 +157,10 @@ $ grep -A 1 CFBundleIdentifier /Applications/iA\ Writer.app/Contents/Info.plist
To set [Notepad++](http://notepad-plus-plus.org/) as your editor, edit To set [Notepad++](http://notepad-plus-plus.org/) as your editor, edit
the jrnl config file (`.jrnl_config`) like this: the jrnl config file (`.jrnl_config`) like this:
``` javascript ``` json
"editor": "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession", {
"editor": "C:\\Program Files (x86)\\Notepad++\\notepad++.exe -multiInst -nosession",
}
``` ```
The double backslashes are needed so jrnl can read the file path The double backslashes are needed so jrnl can read the file path
@ -164,7 +171,7 @@ its own Notepad++ window.
To set [Visual Studo Code](https://code.visualstudio.com) as your editor on Linux, edit `.jrnl_config` like this: To set [Visual Studo Code](https://code.visualstudio.com) as your editor on Linux, edit `.jrnl_config` like this:
```javascript ```json
{ {
"editor": "/usr/bin/code --wait", "editor": "/usr/bin/code --wait",
} }

View file

@ -37,7 +37,8 @@ jrnl today at 3am: I just met Steve Buscemi in a bar! He looked funny.
!!! note !!! note
Most shell contains a certain number of reserved characters, such as `#` Most shell contains a certain number of reserved characters, such as `#`
and `*`. Unbalanced quotes, parenthesis, and so on will also get into and `*`. Unbalanced quotes, parenthesis, and so on will also get into
the way of your editing. For writing longer entries, just enter `jrnl` the way of your editing.
For writing longer entries, just enter `jrnl`
and hit `return`. Only then enter the text of your journal entry. and hit `return`. Only then enter the text of your journal entry.
Alternatively, `use an external editor <advanced>`). Alternatively, `use an external editor <advanced>`).
@ -164,7 +165,7 @@ DayOne journals can be edited exactly the same way, however the output
looks a little bit different because of the way DayOne stores its looks a little bit different because of the way DayOne stores its
entries: entries:
``` output ```md
# af8dbd0d43fb55458f11aad586ea2abf # af8dbd0d43fb55458f11aad586ea2abf
2013-05-02 15:30 I told everyone I built my @robot wife for sex. 2013-05-02 15:30 I told everyone I built my @robot wife for sex.
But late at night when we're alone we mostly play Battleship. But late at night when we're alone we mostly play Battleship.