branch: elpa/csv2ledger
commit 03b2aeb4a73845096854fbbb2822d79827f65145
Author: Joost Kremers <joostkrem...@fastmail.fm>
Commit: Joost Kremers <joostkrem...@fastmail.fm>
Update the README.
---
README.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/README.md b/README.md
index 11b8293a5e..85201dcf9e 100644
--- a/README.md
+++ b/README.md
@@ -81,6 +81,7 @@ This means that the `description` field is checked first,
then the `payee`, then
Note that this is the *only* reason for including the `type` field in
`c2l-csv-columns` above: I use its value to help determine the target account.
As mentioned, the `type` field is not included in the ledger entry.
+
## Modifying field values ##
Depending on the format of your CSV file, it may also be necessary to set the
variable `c2l-field-parse-functions`. This is a list mapping fields to
functions that take the field's value and convert it to something else. For
example, my CSV files provide the date in the format `DD.MM.YYYY`, but ledger
expects them to be in the format `YYYY-MM-DD`. `csv2ledger` comes with a
function that performs this conversion,
`c2l-convert-little-endian-to-iso8601-date`. I therefore set `c2l-field-pars
[...]
@@ -114,6 +115,8 @@ You can then add this to `c2l-field-parse-functions`:
(amount . c2l-convert-postbank-to-ledger-amount)))
```
+By default, ledger entries are created uncleared. If you want to mark all
transactions as cleared, set the variable `c2l-auto-cleared`.
+
A final variable you may want to set is `c2l-alignment-column`. This should
most likely have the same value as `ledger-post-amount-alignment-column`,
although `csv2ledger` currently assumes that `ledger-post-amount-alignment-at`
is set to `:end` and that the commodity precedes the amount. If either is not
true, alignment is probably not optimal.
