slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

csv: doc: more tweaks (#1000)

Browse Source 
[ci skip]
This commit is contained in:
Simon Michael 2019-04-03 13:25:50 -07:00
parent 9f4decb4f6
commit bd08dd3858
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
hledger-lib/hledger_csv.m4.md
View File

@ -233,12 +233,12 @@ It's conventional and recommended to use `account1` for the account whose CSV we
## CSV amounts ## CSV amounts
An amount must be set, in one of these ways: A transaction [amount](/journal.html#amounts) must be set, in one of these ways:
- with an `amount` field assignment, which sets the first posting's [amount](/journal.html#amounts) - with an `amount` field assignment, which sets the first posting's amount
- (If the CSV has debit and credit amounts in separate fields:) with - (When the CSV has debit and credit amounts in separate fields:)\
field assignments for the `amount-in` and `amount-out` pseudo fields with field assignments for the `amount-in` and `amount-out` pseudo fields
instead (both of them). Whichever one has a value will be used, with instead (both of them). Whichever one has a value will be used, with
appropriate sign. (If both contain a value, it might not work so well.) appropriate sign. (If both contain a value, it might not work so well.)
@ -251,7 +251,8 @@ There is some special handling for sign in amounts:
If the currency/commodity symbol is provided as a separate CSV field, If the currency/commodity symbol is provided as a separate CSV field,
assign it to the `currency` pseudo field; the symbol will be prepended assign it to the `currency` pseudo field; the symbol will be prepended
to the amount (<s>when there is an amount</s> TODO). to the amount
(TODO: <s>when there is an amount</s>).
Or, you can use an `amount` [field assignment](#field-assignment) more control, eg: Or, you can use an `amount` [field assignment](#field-assignment) more control, eg:
``` ```
fields date,description,currency,amount fields date,description,currency,amount
@ -263,9 +264,10 @@ amount %amount %currency
If the CSV includes a running balance, you can assign that to one of the pseudo fields If the CSV includes a running balance, you can assign that to one of the pseudo fields
`balance` (or `balance1`) or `balance2`. `balance` (or `balance1`) or `balance2`.
This will generate a [balance assertion](/journal.html#balance-assertions) This will generate a [balance assertion](/journal.html#balance-assertions)
(or if the amount is left empty, a [balance assignment](/journal.html#balance-assignments)) (or if the amount is left empty, a [balance assignment](/journal.html#balance-assignments)),
on the first or second posting, on the first or second posting,
whenever the running balance field is non-empty. whenever the running balance field is non-empty.
(TODO: [#1000](https://github.com/simonmichael/hledger/issues/1000))
## Reading multiple CSV files ## Reading multiple CSV files