Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs update, including ISO date formatting for doc/mockups #1172

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs update, including ISO date formatting for doc/mockups #1172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f17905
Doc changes from clean rebuild: ./Shake manuals ; stack build
bwignall Jan 11, 2020
b6f3686
Update doc/mockups to ISO date format
bwignall Jan 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/mockups/budget-reporting.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ budget report mockups
$ hledger bal ^expenses -M --depth 1 --average # add average & total columns
Change of balance (flow):

|| 2014/01/01-2014/01/31 2014/02/01-2014/02/28 2014/03/01-2014/03/31 average total
|| 2014-01-01-2014-01-31 2014-02-01-2014-02-28 2014-03-01-2014-03-31 average total
==========++============================================================================================
expenses || $3500.00 $3400.00 $4200.00 $3700.00 $11100.00
----------++--------------------------------------------------------------------------------------------
Expand All @@ -12,7 +12,7 @@ Change of balance (flow):
$ hledger bal ^expenses -M --depth 1 --budget-simple # assume a fixed budget
Change of balance (flow, with simple budget):

|| | 2014/01/01-2014/01/31 2014/02/01-2014/02/28 2014/03/01-2014/03/31 | average total
|| | 2014-01-01-2014-01-31 2014-02-01-2014-02-28 2014-03-01-2014-03-31 | average total
|| budget | actual over actual over actual over | over over
==========++=======================================================================================================
expenses || $4000 | $3500.00 $-500.00 $3400.00 $-600.00 $4200.00 $200.00 | $-300.00 $-900.00
Expand All @@ -22,7 +22,7 @@ Change of balance (flow, with simple budget):
$ hledger bal ^expenses -M --depth 1 --budget # budget can change per period
Change of balance (flow, with budget):

|| 2014/01/01-2014/01/31 2014/02/01-2014/02/28 2014/03/01-2014/03/31 average total
|| 2014-01-01-2014-01-31 2014-02-01-2014-02-28 2014-03-01-2014-03-31 average total
|| budget actual over budget actual over budget actual over over over
==========++=========================================================================================================================
expenses || $4000 $3500.00 $-500.00 $4000 $3400.00 $-600.00 $4000 $4200.00 $200.00 $-300.00 $-900.00
Expand All @@ -32,7 +32,7 @@ Change of balance (flow, with budget):
$ hledger bal ^expenses -M --depth 1 --budget --cumulative
Ending balance (cumulative, with budget):

|| 2014/01/01-2014/01/31 2014/02/01-2014/02/28 2014/03/01-2014/03/31 average final
|| 2014-01-01-2014-01-31 2014-02-01-2014-02-28 2014-03-01-2014-03-31 average final
|| budget actual over budget actual over budget actual over over over
==========++==========================================================================================================================
expenses || $4000 $3500.00 $-500.00 $8000 $6900.00 $-1100.00 $12000 $11100.00 $-900.00 $-833.33 $-900.00
Expand All @@ -42,7 +42,7 @@ Ending balance (cumulative, with budget):
$ hledger bal ^expenses -M --depth 1 --budget --historical # assume $10000 budget, $20000 expenses starting balances
Ending balance (historical, with budget):

|| 2014/01/01-2014/01/31 2014/02/01-2014/02/28 2014/03/01-2014/03/31 average final
|| 2014-01-01-2014-01-31 2014-02-01-2014-02-28 2014-03-01-2014-03-31 average final
|| budget actual over budget actual over budget actual over over over
==========++==========================================================================================================================
expenses || $14000 $23500.00 $9500.00 $18000 $26900.00 $8900.00 $22000 $31100.00 $9100.00 $9166.66 $9100.00
Expand Down
6 changes: 3 additions & 3 deletions doc/mockups/entry-macros.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ $ hledger entry laundry 20
assets:personal:cash:wallet $-20

$ hledger entry date 5/3 23.24
2015/05/03 date ; date:$23.24
2015-05-03 date ; date:$23.24
expenses:personal:food:dining $11.62
expenses:personal:gifts:eleonore $11.62
assets:personal:bank:wf:checking:food $-11.62
Expand All @@ -32,7 +32,7 @@ $ cat t.j
2015/04/29 * trader joes personal 0 1 18 2.07 50

$ hledger expand < t.j
2015/04/29 * trader joes
2015-04-29 * trader joes
expenses:personal:food:snacks $1.00
expenses:personal:gifts:eleonore $18.00
expenses:personal:spiritual:lodge $2.07
Expand All @@ -59,7 +59,7 @@ entry trader joes personal GROCERIES SNACKS ELEONORE LODGE CASH
2015/04/29 * trader joes personal 0 1 18 2.07 50

$ hledger print -f t.j
2015/04/29 * trader joes personal
2015-04-29 * trader joes personal
expenses:personal:gifts:eleonore $18.00
expenses:personal:spiritual:lodge $2.07
expenses:personal:food:snacks $1.00
Expand Down
62 changes: 31 additions & 31 deletions hledger-lib/hledger_csv.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ DESCRIPTION
layout, date format etc.), and how to construct hledger journal entries
(transactions) from it. Often there will also be a list of conditional
rules for categorising transactions based on their descriptions.
Here's an overview of the CSV rules; these are described more fully be-
low, after the examples:
Here's an overview of the CSV rules; these are described more fully
below, after the examples:

skip skip one or more header
lines or matched CSV
Expand Down Expand Up @@ -367,8 +367,8 @@ CSV RULES
can be left unnamed. Currently there must be least two items (there
must be at least one comma).

Note, always use comma in the fields list, even if your CSV uses an-
other separator character.
Note, always use comma in the fields list, even if your CSV uses
another separator character.

Here are the standard hledger field/pseudo-field names. For more about
the transaction parts they refer to, see the manual for hledger's jour-
Expand All @@ -380,10 +380,10 @@ CSV RULES

Posting field names
accountN, where N is 1 to 9, generates a posting, with that account
name. Most often there are two postings, so you'll want to set ac-
count1 and account2. If a posting's account name is left unset but its
amount is set, a default account name will be chosen (like expenses:un-
known or income:unknown).
name. Most often there are two postings, so you'll want to set
account1 and account2. If a posting's account name is left unset but
its amount is set, a default account name will be chosen (like
expenses:unknown or income:unknown).

amountN sets posting N's amount. Or, amount with no N sets posting
1's. If the CSV has debits and credits in separate fields, use
Expand All @@ -396,8 +396,8 @@ CSV RULES
cating an unbalanced posting.)

If the CSV has the currency symbol in a separate field, you can use
currencyN to prepend it to posting N's amount. currency with no N af-
fects ALL postings.
currencyN to prepend it to posting N's amount. currency with no N
affects ALL postings.

balanceN sets a balance assertion amount (or if the posting amount is
left empty, a balance assignment). You may need to adjust this with
Expand All @@ -411,8 +411,8 @@ CSV RULES
field assignment
HLEDGERFIELDNAME FIELDVALUE

Instead of or in addition to a fields list, you can use a "field as-
signment" rule to set the value of a single hledger field, by writing
Instead of or in addition to a fields list, you can use a "field
assignment" rule to set the value of a single hledger field, by writing
its name (any of the standard hledger field names above) followed by a
text value. The value may contain interpolated CSV fields, referenced
by their 1-based position in the CSV record (%N), or by the name they
Expand All @@ -424,9 +424,9 @@ CSV RULES
# combine three fields to make a comment, containing note: and date: tags
comment note: %somefield - %anotherfield, date: %1

Interpolation strips outer whitespace (so a CSV value like " 1 " be-
comes 1 when interpolated) (#1051). See TIPS below for more about ref-
erencing other fields.
Interpolation strips outer whitespace (so a CSV value like " 1 "
becomes 1 when interpolated) (#1051). See TIPS below for more about
referencing other fields.

separator
You can use the separator directive to read other kinds of character-
Expand Down Expand Up @@ -459,8 +459,8 @@ CSV RULES
ple patterns can be written on the following lines, non-indented. Mul-
tiple patterns are OR'd (any one of them can match). Patterns are
case-insensitive regular expressions which try to match anywhere within
the whole CSV record (POSIX extended regular expressions with some ad-
ditions, see https://hledger.org/hledger.html#regular-expressions).
the whole CSV record (POSIX extended regular expressions with some
additions, see https://hledger.org/hledger.html#regular-expressions).
Note the CSV record they see is close to, but not identical to, the one
in the CSV file; enclosing double quotes will be removed, and the sepa-
rator character is always comma.
Expand All @@ -471,9 +471,9 @@ CSV RULES
# match "foo" in the fourth field
if ^([^,]*,){3}foo

After the patterns there should be one or more rules to apply, all in-
dented by at least one space. Three kinds of rule are allowed in con-
ditional blocks:
After the patterns there should be one or more rules to apply, all
indented by at least one space. Three kinds of rule are allowed in
conditional blocks:

o field assignments (to set a hledger field)

Expand Down Expand Up @@ -600,8 +600,8 @@ TIPS
read the output.

Valid CSV
hledger accepts CSV conforming to RFC 4180. When CSV values are en-
closed in quotes, note:
hledger accepts CSV conforming to RFC 4180. When CSV values are
enclosed in quotes, note:

o they must be double quotes (not single quotes)

Expand All @@ -622,8 +622,8 @@ TIPS

There is one exception: balance assertions, if you have generated them,
will not be checked, since normally these will work only when the CSV
data is part of the main journal. If you do need to check balance as-
sertions generated from CSV right away, pipe into another hledger:
data is part of the main journal. If you do need to check balance
assertions generated from CSV right away, pipe into another hledger:

$ hledger -f file.csv print | hledger -f- print

Expand Down Expand Up @@ -739,8 +739,8 @@ TIPS
(At each include point the file is inlined and scanned for further
includes, recursively, before proceeding.)

Then "global" rules are evaluated, top to bottom. If a rule is re-
peated, the last one wins:
Then "global" rules are evaluated, top to bottom. If a rule is
repeated, the last one wins:

o skip (at top level)

Expand All @@ -753,18 +753,18 @@ TIPS

Then for each CSV record in turn:

o test all if blocks. If any of them contain a end rule, skip all re-
maining CSV records. Otherwise if any of them contain a skip rule,
o test all if blocks. If any of them contain a end rule, skip all
remaining CSV records. Otherwise if any of them contain a skip rule,
skip that many CSV records. If there are multiple matched skip
rules, the first one wins.

o collect all field assignments at top level and in matched if blocks.
When there are multiple assignments for a field, keep only the last
one.

o compute a value for each hledger field - either the one that was as-
signed to it (and interpolate the %CSVFIELDNAME references), or a de-
fault
o compute a value for each hledger field - either the one that was
assigned to it (and interpolate the %CSVFIELDNAME references), or a
default

o generate a synthetic hledger transaction from these values.

Expand Down
Loading