[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/csv2ledger 102890f078 103/190: Update the README.
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/csv2ledger 102890f078 103/190: Update the README. |
Date: |
Sun, 2 Jun 2024 15:59:49 -0400 (EDT) |
branch: elpa/csv2ledger
commit 102890f078dec24490632b1df6b798db6e51335e
Author: Joost Kremers <joost.kremers@ipsoft.com>
Commit: Joost Kremers <joost.kremers@ipsoft.com>
Update the README.
---
README.md | 13 ++++++++++++-
1 file changed, 12 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index ac971e97a1..02ed4bc0f2 100644
--- a/README.md
+++ b/README.md
@@ -163,7 +163,18 @@ You may also notice that the transaction alist does not
contain a value for `tit
### Setting the amount ###
-As already mentioned above, a CSV file may contain the amount of a transaction
in a single column, or it may use separate columns for amounts debit and
amounts credit.
+As already mentioned above, a CSV file may contain the amount of a transaction
in a single column, or it may use separate columns for amounts debit and
amounts credit. The function that creates the actual ledger entry requires the
`amount` field to be present, however. Therefore, if there is no `amount` field
in `c2l-csv-columns`, `csv2ledger` assumes that `credit` and `debit` are
present. It does this by setting the variable `c2l-amount-function`. This
variable is similar to `c2l-title- [...]
+
+The variable `c2l-amount-function` is actually a user option, which means that
you can set it to a user-defined function if you like, which may be useful if
your CSV file is structured in some strange way that I haven't envisaged.
+
+One point to keep in mind: the amount in the debit field must be a negative
amount, i.e., it must have a minus sign. If this is not the case, the easiest
way to change this is in `c2l-field-modify-functions`, though in principle
`c2l-transaction-modify-function` and `c2l-amount-function` could be used as
well.
+
+
+### Creating the entry ###
+
+After all modification functions have been called, the resulting transaction
is passed to the function in `c2l-entry-function` . The default value of this
option is the function `c2l-compose-entry`, which creates entries in the form
shown above. If that format does not suit your needs, you can use a custom
function instead. It should take the transaction as an alist and return a
string that can be inserted into a ledger buffer.
+
+
TODO
- [nongnu] elpa/csv2ledger 2b2f8267f2 161/190: Update README., (continued)
- [nongnu] elpa/csv2ledger 2b2f8267f2 161/190: Update README., ELPA Syncer, 2024/06/03
- [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 <=
- [nongnu] elpa/csv2ledger b1872d7f83 108/190: Update doc string of c2l-transaction-modify-functions., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 8340839302 098/190: Add csv-mode to Package-Requires., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 6d46386b5e 096/190: Small README update., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 19ec18c197 104/190: Remove reference to `counterpart` from doc string of c2l-csv-columns., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 1417fcdbbb 087/190: Fix default value of c2l-csv-columns., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger a0a328df02 038/190: New function `c2l-convert-region`., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger f536bca1bf 040/190: New function `c2l-get-results-buffer`., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 93bd85b0e0 041/190: c2l-convert-region: Report number of converted entries., ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 09e02e84a5 036/190: Expand README.md, ELPA Syncer, 2024/06/03
- [nongnu] elpa/csv2ledger 4f7505922c 037/190: Update regex in `c2l-has-header`., ELPA Syncer, 2024/06/03