branch: elpa/csv2ledger
commit 57ba8731929cd1ced7294f6aae38dade53a5a1ce
Author: Joost Kremers <joostkrem...@fastmail.com>
Commit: Joost Kremers <joostkrem...@fastmail.com>
Update the README.
---
README.md | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index d1a0efe593..45abab7b22 100644
--- a/README.md
+++ b/README.md
@@ -131,9 +131,11 @@ The matchers are simple substrings, not regular
expressions. I have not found th
`c2l-matcher-regexps` is not a customisable option. However, if you set it to
a value yourself, `csv2ledger` will not overwrite it (and ignore the value of
`c2l-account-matchers-file` if it is set.). Just make sure that the value is
set before calling any functions from `csv2ledger` (but after loading the
library), and keep in mind that if you have multiple regexps matching a
transaction, the first regexp that matches wins out.
-Matching an account specifically means matching the values of the fields
listed in `c2l-target-match-fields` against the regexps in
`c2l-matcher-regexps`. The first regexp that matches wins. By default,
`c2l-target-match-fields` only contains the `payee` and `description` fields,
but you can add other fields to it as well. (In fact, I set it to the value
`(description payee sender type)`.)
+Matching an account specifically means matching the values of the fields
listed in `c2l-target-match-fields` against the regexps in
`c2l-matcher-regexps`. The first regexp that matches wins. By default,
`c2l-target-match-fields` only contains the `payee` and `description` fields,
but you can add other fields to it as well.
-Two things are of note here: first, the order of this list determines the
order in which the fields get checked. The default value is `(payee
description)`, so the `payee` field is checked before `description`. I prefer
for the `description` field to be checked first, because it tends to contain
more information than the `payee` field, so in my setup, I put `description`
first. Second, I added the `type` field to the list. As already mentioned,
`csv2ledger` does not do anything with this [...]
+As an example, I set `c2l-target-match-fields` to the value `(description
payee sender type)`.) Two things are of note here: first, the order of this
list determines the order in which the fields get checked. The default value is
`(payee description)`, so the `payee` field is checked before `description`. I
prefer for the `description` field to be checked first, because it tends to
contain more information than the `payee` field, so in my setup, I put
`description` first.
+
+Second, I add the `type` field to the list. As already mentioned, `csv2ledger`
does not do anything with this field, but I include it in `c2l-csv-columns` and
I use it here to match the target account. Specifically, I use it to capture
ATM withdrawals and set the target account to `Assets:Cash`.
Note that if you wish, you can completely forego the account matching
mechanism discussed here and write your own function to find a target account.
This is explained in a bit more detail below.
