[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/csv2ledger 2b2f8267f2 161/190: Update README.
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/csv2ledger 2b2f8267f2 161/190: Update README. |
Date: |
Sun, 2 Jun 2024 15:59:54 -0400 (EDT) |
branch: elpa/csv2ledger
commit 2b2f8267f2fcf26348b144c885202083b17d219e
Author: Joost Kremers <joostkremers@fastmail.com>
Commit: Joost Kremers <joostkremers@fastmail.com>
Update README.
---
README.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index 833a435be4..a211c7c18d 100644
--- a/README.md
+++ b/README.md
@@ -47,11 +47,11 @@ Several customisation options are present. The full list
with a short explanatio
- `c2l-fallback-account` (`nil`) — Target account if one cannot be determined
automatically.
- `c2l-account-holder` (`nil`) — Name of the account holder that may appear as
payee or sender.
- `c2l-csv-columns` (`()`) — List describing the columns in the CSV file.
-- `c2l-transaction-modify-functions` (`'(c2l-create-title c2l-create-amount
c2l-create-account)`) — Functions used to modify the transaction data.
- `c2l-field-modify-functions` (`nil`) — Functions used to modify field values.
+- `c2l-transaction-modify-functions` (`'(c2l-create-title c2l-create-amount
c2l-create-account)`) — Functions used to modify the transaction data.
- `c2l-entry-function` (`c2l-compose-entry`) — Function used to create the
actual ledger transaction.
- `c2l-account-matchers-file` (`nil`) — File with substrings matching specific
target accounts.
-- `c2l-target-match-fields` (`(payee description)`) — Fields in the
transaction used to match against target accounts.
+- `c2l-target-match-fields` (`(payee description)`) — Fields in the
transaction used to match against account targets in
`c2l-account-matchers-file`.
- `c2l-auto-cleared` (`nil`) — Whether to auto-clear transactions.
- `c2l-alignment-column` (`52`) — Column to which the amount is aligned.
@@ -72,9 +72,9 @@ At the very least, you will need to set two user options:
`c2l-base-account` and
- `debit`: the amount payed
- `_` (underscore): ignored column
-In the default setup, all these fields (except the underscore, obviously) may
be used to create the Ledger entry, though some of them are only used in
specific circumstances. Note that `c2l-csv-columns` should contain entries for
*all* columns in the CSV file. Columns that you do not use should therefore be
indicated with an underscore.
+In the default setup, all these fields (except the underscore, obviously) may
be used to create the Ledger entry, though some of them are only used in
specific circumstances or if certain other options have been set. Note that
`c2l-csv-columns` should contain entries for *all* columns in the CSV file.
Columns that you do not use should therefore be indicated with an underscore.
-The `payee` and `sender` columns never appear both. By default, `payee` is
used as the title of the ledger entry and `sender` is ignored. If you set the
option `c2l-account-holder` however, the `sender` will be used as the title for
transactions in which you are the payee, i.e., when you receive money. If you
do not have a `sender` field in your CSV files, you may simply leave it out. In
that case, the `payee` will always be used as the title (at least in the
default setup).
+The `payee` and `sender` fields never appear both in the ledger entry. By
default, `payee` is used as the title of the entry and `sender` is ignored. If
you set the option `c2l-account-holder` however, the `sender` will be used as
the title for transactions in which you are the payee, i.e., when you receive
money. If you do not have a `sender` field in your CSV files, you may simply
leave it out. In that case, the `payee` will always be used as the title (at
least in the default setup).
The `amount` field is intended for the CSV field that contains the amount of
the transaction. If your CSV files have two separate columns for amounts credit
and amounts debit, use the column names `credit` and `debit` instead.
`csv2ledger` then checks for each transaction which one of those fields
actually contains an amount and uses that to create the ledger entry. Note that
in this case, it is assumed that the `debit` field contains a negative amount,
i.e., that it has a minus sign. If [...]
- [nongnu] elpa/csv2ledger 799beb345b 035/190: New function `c2l-has-header`., (continued)
- [nongnu] elpa/csv2ledger 799beb345b 035/190: New function `c2l-has-header`., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 2531e81bcf 082/190: Add user option c2l-transaction-modify-function., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 81322ebde0 072/190: Use c2l--amount-p in c2l--has-header., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger bf995e11cb 080/190: Rename balancing account back to target account., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 521edc8471 081/190: Do not create c2l-base-account as a buffer-local variable., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger ea515e3ae6 074/190: Set default value of c2l-base-account to "Assets:Unknown"., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger c72b617d68 159/190: Fix typo in the README, ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 3a309c795a 139/190: Fix the README., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 0bcf56f4b8 140/190: Update the README., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger f299813350 146/190: Recognise amounts without cents in c2l--amount-p, ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 2b2f8267f2 161/190: Update README.,
ELPA Syncer <=
- [nongnu] elpa/csv2ledger 7a3c55377e 154/190: Small update to the README, ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 9b36538371 111/190: Update the README., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger ccb45be9dc 114/190: Add URL line to the file header., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 393b9d9688 043/190: New function: c2l-convert-buffer., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 40e1230600 059/190: Fix doc string of `c2l--csv-line-to-ledger`., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 5d813d7f09 189/190: Add note about c2l-read-account-matchers to the README, ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 7932657f9f 022/190: Move definitions of internal variables after defcustoms., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger cc83ffef1c 010/190: Rename `c2l-compile-account-regexes` to `c2l-compile-matcher-regexes`., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 73ef91df00 009/190: Turn variables into user options or internal variables., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 102890f078 103/190: Update the README., ELPA Syncer, 2024/06/03