From b97b48926cda985f53ffc44b4b9c382d1abe74b9 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 19 Jan 2023 07:03:31 -1000 Subject: [PATCH] ;doc: csv: try to clarify how CSV/hledger fields work: add examples --- hledger/hledger.m4.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index 79a7ed544..4ac48d953 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -3072,10 +3072,25 @@ Note the two kinds of field names mentioned here, and used only in hledger CSV r you can optionally name the CSV columns for easy reference, by writing arbitrary names in a `fields` list (since hledger doesn't yet automatically recognise column headings in a CSV file). + Eg: + ```csv + fields Transaction_Date, Transaction_Id, Net_Amount, Total_Amount + ``` 2. Special **hledger field names** (`HLEDGERFIELD` in these docs): you must set at least some of these to generate the hledger transaction from a CSV record, by writing them in a [`fields` list](#fields-list) or as the left hand side of a [field assignment](#field-assignment). + Eg: + ```csv + date %Transaction_Date + code %Transaction_Id + amount1 $ %Total_Amount + ``` + or (equivalently): + ```csv + fields date, code, , amount1 + currency $ + ``` Here are all the special hledger field names available, and what happens when you assign values to them: