slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update documentation on separators

Browse Source
This commit is contained in:
Aleksandar Dimitrov 2020-01-05 22:29:57 +01:00 committed by Simon Michael
parent 3ead97975c
commit 3bf6ef9a8b
1 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
hledger-lib/hledger_csv.m4.md
View File

@ -40,6 +40,7 @@ these are described more fully below, after the examples:
[**`skip`**](#skip) skip one or more header lines or matched CSV records [**`skip`**](#skip) skip one or more header lines or matched CSV records
[**`fields`**](#fields) name CSV fields, assign them to hledger fields [**`fields`**](#fields) name CSV fields, assign them to hledger fields
[**field assignment**](#field-assignment) assign a value to one hledger field, with interpolation [**field assignment**](#field-assignment) assign a value to one hledger field, with interpolation
[**`separator`**](#separator) a custom field separator
[**`if`**](#if) apply some rules to matched CSV records [**`if`**](#if) apply some rules to matched CSV records
[**`end`**](#end) skip the remaining CSV records [**`end`**](#end) skip the remaining CSV records
[**`date-format`**](#date-format) describe the format of CSV dates [**`date-format`**](#date-format) describe the format of CSV dates
@ -405,7 +406,7 @@ Fields you don't care about can be left unnamed.
Currently there must be least two items (there must be at least one comma). Currently there must be least two items (there must be at least one comma).
Note, always use comma in the fields list, even if your CSV uses Note, always use comma in the fields list, even if your CSV uses
[another separator character](#other-separator-characters). [another separator character](#separator).
Here are the standard hledger field/pseudo-field names. Here are the standard hledger field/pseudo-field names.
For more about the transaction parts they refer to, see the manual for hledger's journal format. For more about the transaction parts they refer to, see the manual for hledger's journal format.
@ -474,6 +475,21 @@ becomes `1` when interpolated)
([#1051](https://github.com/simonmichael/hledger/issues/1051)). ([#1051](https://github.com/simonmichael/hledger/issues/1051)).
See TIPS below for more about referencing other fields. See TIPS below for more about referencing other fields.
## `separator`
You can use the `separator` directive to read other kinds of
character-separated data. Eg to read SSV (Semicolon Separated Values), use:
```
separator ;
```
The separator directive accepts exactly one single byte character as a
separator. To specify whitespace characters, you may use the special
words `TAB` or `SPACE`. Eg to read TSV (Tab Separated Values), use:
```
separator TAB
```
## `if` ## `if`
@ -661,23 +677,6 @@ When CSV values are enclosed in quotes, note:
- they must be double quotes (not single quotes) - they must be double quotes (not single quotes)
- spaces outside the quotes are [not allowed](https://stackoverflow.com/questions/4863852/space-before-quote-in-csv-field) - spaces outside the quotes are [not allowed](https://stackoverflow.com/questions/4863852/space-before-quote-in-csv-field)
## Other separator characters
You can use the `--separator 'CHAR'` command line option
(experimental) to read other kinds of character-separated data.
Eg to read SSV (Semicolon Separated Values), use:
```shell
$ hledger -f foo.tsv --separator ';' print
```
Note the semicolon is quoted because it's a
[special shell character](hledger.html#special-characters-in-arguments-and-queries).
To read TSV (Tab Separated Values), use:
```shell
$ hledger -f foo.tsv --separator ' ' print
```
Note, that's a real tab character in quotes, not `\t`.
## Reading multiple CSV files ## Reading multiple CSV files
If you use multiple `-f` options to read multiple CSV files at once, If you use multiple `-f` options to read multiple CSV files at once,