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

Finished docs

Browse source
This commit is contained in:
Manuel Ebert 2013-11-03 20:31:24 -08:00
parent 588229581b
commit ddf2eda194
4 changed files with 69 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
docs/export.rst
View file

@ -3,7 +3,6 @@
Import and Export
=================
Tag export
----------
@ -13,6 +12,13 @@ With::
you'll get a list of all tags you used in your journal, sorted by most frequent. Tags occurring several times in the same entry are only counted as one.
List of all entries
-------------------
jrnl --short
Will only display the date and title of each entry.
JSON export
-----------
@ -20,7 +26,7 @@ Can do::
jrnl --export json
Why not create a beautiful [timeline](http://timeline.verite.co/) of your journal?
Why not create a `beautiful timeline <http://timeline.verite.co/>`_ of your journal?
Markdown export
---------------
@ -29,10 +35,6 @@ Use::
jrnl --export markdown
or::
jrnl --export md
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.
Text export
@ -42,10 +44,6 @@ Text export
jrnl --export text
or ::
jrnl --export txt
Pretty-prints your entire journal.
Export to files

2
docs/index.rst
View file

@ -4,7 +4,7 @@
jrnl: The command-line journal
==============================
Release v\ |version|. (:ref:`Installation <install>`)
Release v\ |version|.
Contents:

16
docs/recipes.rst
View file

@ -6,9 +6,23 @@ FAQ
Recipes
-------
Co-occurrence of tags
~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~
If I want to find out how often I mentioned my flatmates Alberto and Melo in the same entry, I run ::
jrnl @alberto --tags | grep @melo
And will get something like ``@melo: 9``, meaning there are 9 entries where both ``@alberto`` and ``@melo`` are tagged. How does this work? First, ``jrnl @alberto`` will filter the journal to only entries containing the tag ``@alberto``, and then the ``--tags`` option will print out how often each tag occurred in this `filtered` journal. Finally, we pipe this to ``grep`` which will only display the line containing ``@melo``.
Combining filters
~~~~~~~~~~~~~~~~~
You can do things like ::
jrnl @fixed -starred -n 10 -until "jan 2013" --short
To get a short summary of the 10 most recent, favourited entries before January 1, 2013 that are tagged with ``@fixed``.
Known Issues
------------

70
docs/usage.rst
View file

@ -3,7 +3,48 @@
Basic Usage
===========
*jrnl* has two modes: **composing** and **viewing**.
*jrnl* has two modes: **composing** and **viewing**. Basically, whenever you `don't` supply any arguments that start with a dash or double-dash, you're in composing mode, meaning you can write your entry on the command line or an editor of your choice.
We intentionally break a convention on command line arguments: all arguments starting with a `single dash` will `filter` your journal before viewing it, and can be combined arbitrarily. Arguments with a `double dash` will control how your journal is displayed or exported and are mutually exclusive (ie. you can only specify one way to display or export your journal at a time).
Composing Entries
-----------------
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
~~~~~~~~~~~~~~~~
Timestamps that work:
* at 6am
* yesterday
* last monday
* sunday at noon
* 2 march 2012
* 7 apr
* 5/20/1998 at 23:42
Starring entries
~~~~~~~~~~~~~~~~
To mark an entry as a favourite, simply "star" it::
jrnl last sunday *: Best day of my life.
If you don't want to add a date (ie. your entry will be dated as now), The following options are equivalent:
* ``jrnl *: Best day of my life.``
* ``jrnl *Best day of my life.``
* ``jrnl Best day of my life.*``
.. note::
Just make sure that the asterisk sign is **not** surrounded by whitespaces, e.g. ``jrnl Best day of my life! *`` will **not** work (the reason being that the ``*`` sign has a special meaning on most shells).
Viewing
-------
@ -14,11 +55,11 @@ Viewing
will list you the ten latest entries, ::
jrnl -from "last year" -to march
jrnl -from "last year" -until 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. To only see your favourite entries, use ::
jrnl -short
jrnl -starred
Using Tags
----------
@ -41,24 +82,3 @@ the last five entries containing both ``@pineapple`` **and** ``@lubricant``. You
``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
~~~~~~~~~~~~~~~~
Timestamps that work:
* at 6am
* yesterday
* last monday
* sunday at noon
* 2 march 2012
* 7 apr
* 5/20/1998 at 23:42