From 3c22259047766ca42d550b42160fa333b6ecbfe9 Mon Sep 17 00:00:00 2001 From: Simon Michael Date: Thu, 19 Jan 2023 07:09:29 -1000 Subject: [PATCH] ;doc: csv: try to clarify how CSV/hledger fields work: tweak --- hledger/hledger.m4.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/hledger/hledger.m4.md b/hledger/hledger.m4.md index 4ac48d953..937ec4b14 100644 --- a/hledger/hledger.m4.md +++ b/hledger/hledger.m4.md @@ -3069,29 +3069,27 @@ becomes `1` when interpolated) Note the two kinds of field names mentioned here, and used only in hledger CSV rules files: 1. **CSV field names** (`CSVFIELD` in these docs): - 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: + you can optionally name the CSV columns for easy reference + (since hledger doesn't yet automatically recognise column headings in a CSV file), + by writing arbitrary names in a `fields` list: ```csv - fields Transaction_Date, Transaction_Id, Net_Amount, Total_Amount + fields Transaction_Date, Transaction_Id, Net_Amount, Total_Amount, Other_Field ``` 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: + by writing them as the left hand side of a [field assignment](#field-assignment): ```csv - date %Transaction_Date - code %Transaction_Id - amount1 $ %Total_Amount + date %Transaction_Date + code %Transaction_Id + amount1 $ %Total_Amount ``` - or (equivalently): + or directly in a [`fields` list](#fields-list): ```csv - fields date, code, , amount1 + fields date, code, , amount, currency $ ``` - + Here are all the special hledger field names available, and what happens when you assign values to them: ### date field