update generated journal, csv manuals

[ci skip]
This commit is contained in:
Simon Michael 2019-01-19 15:29:23 -08:00
parent 240406706a
commit d4fa546d27
6 changed files with 333 additions and 308 deletions

View File

@ -112,15 +112,15 @@ Examples:
.IP .IP
.nf .nf
\f[C] \f[C]
#\ for\ dates\ like\ "6/11/2013": #\ for\ dates\ like\ "11/06/2013":
date\-format\ %\-d/%\-m/%Y date\-format\ %m/%d/%Y
\f[] \f[]
.fi .fi
.IP .IP
.nf .nf
\f[C] \f[C]
#\ for\ dates\ like\ "11/06/2013": #\ for\ dates\ like\ "6/11/2013"\ (note\ the\ \-\ to\ make\ leading\ zeros\ optional):
date\-format\ %m/%d/%Y date\-format\ %\-d/%\-m/%Y
\f[] \f[]
.fi .fi
.IP .IP

View File

@ -113,12 +113,12 @@ File: hledger_csv.info, Node: date-format, Next: field list, Prev: skip, Up:
DATEFMT is a strptime-like date parsing pattern, which must parse the DATEFMT is a strptime-like date parsing pattern, which must parse the
date field values completely. Examples: date field values completely. Examples:
# for dates like "6/11/2013":
date-format %-d/%-m/%Y
# for dates like "11/06/2013": # for dates like "11/06/2013":
date-format %m/%d/%Y date-format %m/%d/%Y
# for dates like "6/11/2013" (note the - to make leading zeros optional):
date-format %-d/%-m/%Y
# for dates like "2013-Nov-06": # for dates like "2013-Nov-06":
date-format %Y-%h-%d date-format %Y-%h-%d
@ -323,27 +323,27 @@ Node: skip2539
Ref: #skip2633 Ref: #skip2633
Node: date-format2805 Node: date-format2805
Ref: #date-format2932 Ref: #date-format2932
Node: field list3438 Node: field list3482
Ref: #field-list3575 Ref: #field-list3619
Node: field assignment4280 Node: field assignment4324
Ref: #field-assignment4435 Ref: #field-assignment4479
Node: conditional block4939 Node: conditional block4983
Ref: #conditional-block5093 Ref: #conditional-block5137
Node: include5989 Node: include6033
Ref: #include6119 Ref: #include6163
Node: newest-first6350 Node: newest-first6394
Ref: #newest-first6464 Ref: #newest-first6508
Node: CSV TIPS6875 Node: CSV TIPS6919
Ref: #csv-tips6969 Ref: #csv-tips7013
Node: CSV ordering7087 Node: CSV ordering7131
Ref: #csv-ordering7205 Ref: #csv-ordering7249
Node: CSV accounts7386 Node: CSV accounts7430
Ref: #csv-accounts7524 Ref: #csv-accounts7568
Node: CSV amounts7778 Node: CSV amounts7822
Ref: #csv-amounts7924 Ref: #csv-amounts7968
Node: CSV balance assertions8699 Node: CSV balance assertions8743
Ref: #csv-balance-assertions8881 Ref: #csv-balance-assertions8925
Node: Reading multiple CSV files9086 Node: Reading multiple CSV files9130
Ref: #reading-multiple-csv-files9256 Ref: #reading-multiple-csv-files9300
 
End Tag Table End Tag Table

View File

@ -88,12 +88,12 @@ CSV RULES
is a strptime-like date parsing pattern, which must parse the date is a strptime-like date parsing pattern, which must parse the date
field values completely. Examples: field values completely. Examples:
# for dates like "6/11/2013":
date-format %-d/%-m/%Y
# for dates like "11/06/2013": # for dates like "11/06/2013":
date-format %m/%d/%Y date-format %m/%d/%Y
# for dates like "6/11/2013" (note the - to make leading zeros optional):
date-format %-d/%-m/%Y
# for dates like "2013-Nov-06": # for dates like "2013-Nov-06":
date-format %Y-%h-%d date-format %Y-%h-%d

View File

@ -635,6 +635,13 @@ Balance assertions are checked against all postings, both real and
virtual. virtual.
They are not affected by the \f[C]\-\-real/\-R\f[] flag or They are not affected by the \f[C]\-\-real/\-R\f[] flag or
\f[C]real:\f[] query. \f[C]real:\f[] query.
.SS Assertions and precision
.PP
Balance assertions compare the exactly calculated amounts, which are not
always what is shown by reports.
Eg a commodity directive may limit the display precision, but this will
not affect balance assertions.
Balance assertion failure messages show exact amounts.
.SS Balance Assignments .SS Balance Assignments
.PP .PP
Ledger\-style balance assignments are also supported. Ledger\-style balance assignments are also supported.
@ -1514,21 +1521,20 @@ Partial or relative dates (M/D, D, tomorrow, last week) in the period
expression can work (useful or not). expression can work (useful or not).
They will be relative to today's date, unless a Y default year directive They will be relative to today's date, unless a Y default year directive
is in effect, in which case they will be relative to Y/1/1. is in effect, in which case they will be relative to Y/1/1.
.SS Two spaces after the period expression
.PP .PP
Period expressions must be terminated by \f[B]two or more spaces\f[] if If the period expression is followed by a transaction description, these
followed by additional fields. must be separated by \f[B]two or more spaces\f[].
For example, the periodic transaction given below includes a transaction This helps hledger know where the period expression ends, so that
description \[lq]paycheck\[rq], which is separated from the period descriptions can not accidentally alter their meaning, as in this
expression by a double space. example:
If not for the second space, hledger would attempt (and fail) to parse
\[lq]paycheck\[rq] as a part of the period expression.
.IP .IP
.nf .nf
\f[C] \f[C]
;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ 2\ or\ more\ spaces ;\ 2\ or\ more\ spaces\ needed\ here,\ so\ the\ period\ is\ not\ understood\ as\ "every\ 2\ months\ in\ 2020"
;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ || ;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ ||
;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ vv ;\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ vv
~\ every\ 2\ weeks\ from\ 2018/6/4\ to\ 2018/9\ \ paycheck ~\ every\ 2\ months\ \ in\ 2020,\ we\ will\ review
\ \ \ \ assets:bank:checking\ \ \ $1500 \ \ \ \ assets:bank:checking\ \ \ $1500
\ \ \ \ income:acme\ inc \ \ \ \ income:acme\ inc
\f[] \f[]

View File

@ -476,6 +476,7 @@ or for reading Ledger files.
* Assertions and prices:: * Assertions and prices::
* Assertions and subaccounts:: * Assertions and subaccounts::
* Assertions and virtual postings:: * Assertions and virtual postings::
* Assertions and precision::
 
File: hledger_journal.info, Node: Assertions and ordering, Next: Assertions and included files, Up: Balance Assertions File: hledger_journal.info, Node: Assertions and ordering, Next: Assertions and included files, Up: Balance Assertions
@ -599,7 +600,7 @@ $ hledger bal checking --flat
2 2
 
File: hledger_journal.info, Node: Assertions and virtual postings, Prev: Assertions and subaccounts, Up: Balance Assertions File: hledger_journal.info, Node: Assertions and virtual postings, Next: Assertions and precision, Prev: Assertions and subaccounts, Up: Balance Assertions
1.9.7 Assertions and virtual postings 1.9.7 Assertions and virtual postings
------------------------------------- -------------------------------------
@ -608,6 +609,17 @@ Balance assertions are checked against all postings, both real and
virtual. They are not affected by the '--real/-R' flag or 'real:' virtual. They are not affected by the '--real/-R' flag or 'real:'
query. query.

File: hledger_journal.info, Node: Assertions and precision, Prev: Assertions and virtual postings, Up: Balance Assertions
1.9.8 Assertions and precision
------------------------------
Balance assertions compare the exactly calculated amounts, which are not
always what is shown by reports. Eg a commodity directive may limit the
display precision, but this will not affect balance assertions. Balance
assertion failure messages show exact amounts.
 
File: hledger_journal.info, Node: Balance Assignments, Next: Transaction prices, Prev: Balance Assertions, Up: FILE FORMAT File: hledger_journal.info, Node: Balance Assignments, Next: Transaction prices, Prev: Balance Assertions, Up: FILE FORMAT
@ -1342,30 +1354,34 @@ date must fall on a natural boundary of the interval. Eg 'monthly from
expression can work (useful or not). They will be relative to today's expression can work (useful or not). They will be relative to today's
date, unless a Y default year directive is in effect, in which case they date, unless a Y default year directive is in effect, in which case they
will be relative to Y/1/1. will be relative to Y/1/1.
Period expressions must be terminated by *two or more spaces* if
followed by additional fields. For example, the periodic transaction
given below includes a transaction description "paycheck", which is
separated from the period expression by a double space. If not for the
second space, hledger would attempt (and fail) to parse "paycheck" as a
part of the period expression.
; 2 or more spaces
; ||
; vv
~ every 2 weeks from 2018/6/4 to 2018/9 paycheck
assets:bank:checking $1500
income:acme inc
* Menu: * Menu:
* Two spaces after the period expression::
* Forecasting with periodic transactions:: * Forecasting with periodic transactions::
* Budgeting with periodic transactions:: * Budgeting with periodic transactions::
 
File: hledger_journal.info, Node: Forecasting with periodic transactions, Next: Budgeting with periodic transactions, Up: Periodic transactions File: hledger_journal.info, Node: Two spaces after the period expression, Next: Forecasting with periodic transactions, Up: Periodic transactions
1.15.1 Forecasting with periodic transactions 1.15.1 Two spaces after the period expression
---------------------------------------------
If the period expression is followed by a transaction description, these
must be separated by *two or more spaces*. This helps hledger know
where the period expression ends, so that descriptions can not
accidentally alter their meaning, as in this example:
; 2 or more spaces needed here, so the period is not understood as "every 2 months in 2020"
; ||
; vv
~ every 2 months in 2020, we will review
assets:bank:checking $1500
income:acme inc

File: hledger_journal.info, Node: Forecasting with periodic transactions, Next: Budgeting with periodic transactions, Prev: Two spaces after the period expression, Up: Periodic transactions
1.15.2 Forecasting with periodic transactions
--------------------------------------------- ---------------------------------------------
With the '--forecast' flag, each periodic transaction rule generates With the '--forecast' flag, each periodic transaction rule generates
@ -1408,7 +1424,7 @@ disables forecast transactions on previous dates.)
 
File: hledger_journal.info, Node: Budgeting with periodic transactions, Prev: Forecasting with periodic transactions, Up: Periodic transactions File: hledger_journal.info, Node: Budgeting with periodic transactions, Prev: Forecasting with periodic transactions, Up: Periodic transactions
1.15.2 Budgeting with periodic transactions 1.15.3 Budgeting with periodic transactions
------------------------------------------- -------------------------------------------
With the '--budget' flag, currently supported by the balance command, With the '--budget' flag, currently supported by the balance command,
@ -1549,71 +1565,75 @@ Node: Virtual Postings15032
Ref: #virtual-postings15191 Ref: #virtual-postings15191
Node: Balance Assertions16411 Node: Balance Assertions16411
Ref: #balance-assertions16586 Ref: #balance-assertions16586
Node: Assertions and ordering17508 Node: Assertions and ordering17537
Ref: #assertions-and-ordering17694 Ref: #assertions-and-ordering17723
Node: Assertions and included files18394 Node: Assertions and included files18423
Ref: #assertions-and-included-files18635 Ref: #assertions-and-included-files18664
Node: Assertions and multiple -f options18968 Node: Assertions and multiple -f options18997
Ref: #assertions-and-multiple--f-options19222 Ref: #assertions-and-multiple--f-options19251
Node: Assertions and commodities19354 Node: Assertions and commodities19383
Ref: #assertions-and-commodities19584 Ref: #assertions-and-commodities19613
Node: Assertions and prices20772 Node: Assertions and prices20801
Ref: #assertions-and-prices20984 Ref: #assertions-and-prices21013
Node: Assertions and subaccounts21093 Node: Assertions and subaccounts21122
Ref: #assertions-and-subaccounts21320 Ref: #assertions-and-subaccounts21349
Node: Assertions and virtual postings21841 Node: Assertions and virtual postings21870
Ref: #assertions-and-virtual-postings22048 Ref: #assertions-and-virtual-postings22110
Node: Balance Assignments22190 Node: Assertions and precision22252
Ref: #balance-assignments22371 Ref: #assertions-and-precision22443
Node: Transaction prices23491 Node: Balance Assignments22710
Ref: #transaction-prices23660 Ref: #balance-assignments22891
Node: Comments25928 Node: Transaction prices24011
Ref: #comments26062 Ref: #transaction-prices24180
Node: Tags27232 Node: Comments26448
Ref: #tags27350 Ref: #comments26582
Node: Directives28752 Node: Tags27752
Ref: #directives28895 Ref: #tags27870
Node: Comment blocks34502 Node: Directives29272
Ref: #comment-blocks34647 Ref: #directives29415
Node: Including other files34823 Node: Comment blocks35022
Ref: #including-other-files35003 Ref: #comment-blocks35167
Node: Default year35411 Node: Including other files35343
Ref: #default-year35580 Ref: #including-other-files35523
Node: Declaring commodities36003 Node: Default year35931
Ref: #declaring-commodities36186 Ref: #default-year36100
Node: Default commodity37413 Node: Declaring commodities36523
Ref: #default-commodity37589 Ref: #declaring-commodities36706
Node: Market prices38225 Node: Default commodity37933
Ref: #market-prices38390 Ref: #default-commodity38109
Node: Declaring accounts39231 Node: Market prices38745
Ref: #declaring-accounts39407 Ref: #market-prices38910
Node: Account types40364 Node: Declaring accounts39751
Ref: #account-types40513 Ref: #declaring-accounts39927
Node: Account comments41587 Node: Account types40884
Ref: #account-comments41772 Ref: #account-types41033
Node: Account display order42093 Node: Account comments42107
Ref: #account-display-order42266 Ref: #account-comments42292
Node: Rewriting accounts43388 Node: Account display order42613
Ref: #rewriting-accounts43573 Ref: #account-display-order42786
Node: Basic aliases44307 Node: Rewriting accounts43908
Ref: #basic-aliases44453 Ref: #rewriting-accounts44093
Node: Regex aliases45157 Node: Basic aliases44827
Ref: #regex-aliases45328 Ref: #basic-aliases44973
Node: Multiple aliases46046 Node: Regex aliases45677
Ref: #multiple-aliases46221 Ref: #regex-aliases45848
Node: end aliases46719 Node: Multiple aliases46566
Ref: #end-aliases46866 Ref: #multiple-aliases46741
Node: Default parent account46967 Node: end aliases47239
Ref: #default-parent-account47133 Ref: #end-aliases47386
Node: Periodic transactions48017 Node: Default parent account47487
Ref: #periodic-transactions48199 Ref: #default-parent-account47653
Node: Forecasting with periodic transactions49902 Node: Periodic transactions48537
Ref: #forecasting-with-periodic-transactions50145 Ref: #periodic-transactions48719
Node: Budgeting with periodic transactions51832 Node: Two spaces after the period expression49844
Ref: #budgeting-with-periodic-transactions52071 Ref: #two-spaces-after-the-period-expression50089
Node: Transaction Modifiers52530 Node: Forecasting with periodic transactions50574
Ref: #transaction-modifiers52693 Ref: #forecasting-with-periodic-transactions50864
Node: EDITOR SUPPORT54674 Node: Budgeting with periodic transactions52551
Ref: #editor-support54792 Ref: #budgeting-with-periodic-transactions52790
Node: Transaction Modifiers53249
Ref: #transaction-modifiers53412
Node: EDITOR SUPPORT55393
Ref: #editor-support55511
 
End Tag Table End Tag Table

View File

@ -472,6 +472,12 @@ FILE FORMAT
Balance assertions are checked against all postings, both real and vir- Balance assertions are checked against all postings, both real and vir-
tual. They are not affected by the --real/-R flag or real: query. tual. They are not affected by the --real/-R flag or real: query.
Assertions and precision
Balance assertions compare the exactly calculated amounts, which are
not always what is shown by reports. Eg a commodity directive may
limit the display precision, but this will not affect balance asser-
tions. Balance assertion failure messages show exact amounts.
Balance Assignments Balance Assignments
Ledger-style balance assignments are also supported. These are like Ledger-style balance assignments are also supported. These are like
balance assertions, but with no posting amount on the left side of the balance assertions, but with no posting amount on the left side of the
@ -675,12 +681,6 @@ FILE FORMAT
in reports in reports
D declare a commodity, number commodity: all com- D declare a commodity, number commodity: all com-
notation & display style for modityless entries notation & display style for modityless entries
commodityless amounts in all files; num- commodityless amounts in all files; num-
@ -1090,17 +1090,16 @@ FILE FORMAT
date, unless a Y default year directive is in effect, in which case date, unless a Y default year directive is in effect, in which case
they will be relative to Y/1/1. they will be relative to Y/1/1.
Period expressions must be terminated by two or more spaces if followed Two spaces after the period expression
by additional fields. For example, the periodic transaction given If the period expression is followed by a transaction description,
below includes a transaction description "paycheck", which is separated these must be separated by two or more spaces. This helps hledger know
from the period expression by a double space. If not for the second where the period expression ends, so that descriptions can not acciden-
space, hledger would attempt (and fail) to parse "paycheck" as a part tally alter their meaning, as in this example:
of the period expression.
; 2 or more spaces ; 2 or more spaces needed here, so the period is not understood as "every 2 months in 2020"
; || ; ||
; vv ; vv
~ every 2 weeks from 2018/6/4 to 2018/9 paycheck ~ every 2 months in 2020, we will review
assets:bank:checking $1500 assets:bank:checking $1500
income:acme inc income:acme inc