add documentation for from-tsv, from-xml

This commit is contained in:
Sebastian Jung 2019-11-30 13:38:52 +01:00 committed by Yehuda Katz
parent f68503fa21
commit cca6360bcc
2 changed files with 86 additions and 0 deletions

52
docs/commands/from-tsv.md Normal file
View File

@ -0,0 +1,52 @@
# from-tsv
Parse text as `.tsv` and create table.
Syntax: `from-tsv {flags}`
### Flags:
--headerless
don't treat the first row as column names
## Examples
Let's say we have the following file which is formatted like a `tsv` file:
```shell
> open elements.txt
Symbol Element
H Hydrogen
He Helium
Li Lithium
Be Beryllium
```
If we pass the output of the `open` command to `from-tsv` we get a correct formatted table:
```shell
> open elements.txt | from-tsv
━━━┯━━━━━━━━┯━━━━━━━━━━━
# │ Symbol │ Element
───┼────────┼───────────
0 │ H │ Hydrogen
1 │ He │ Helium
2 │ Li │ Lithium
3 │ Be │ Beryllium
━━━┷━━━━━━━━┷━━━━━━━━━━━
```
Using the `--headerless` flag has the following output:
```shell
> open elements.txt | from-tsv --headerless
━━━━┯━━━━━━━━━┯━━━━━━━━━━━
# │ Column1 │ Column2
────┼─────────┼───────────
0 │ Symbol │ Element
1 │ H │ Hydrogen
2 │ He │ Helium
3 │ Li │ Lithium
4 │ Be │ Beryllium
━━━━┷━━━━━━━━━┷━━━━━━━━━━━
```

34
docs/commands/from-xml.md Normal file
View File

@ -0,0 +1,34 @@
# from-xml
Parse text as `.xml` and create table. Use this when nushell cannot dertermine the input file extension.
Syntax: `from-xml`
## Examples
Let's say we've got a file in `xml` format but the file extension is different so Nu can't auto-format it:
```shell
> open world.txt
<?xml version="1.0" encoding="utf-8"?>
<world>
<continent>Africa</continent>
<continent>Antarctica</continent>
<continent>Asia</continent>
<continent>Australia</continent>
<continent>Europe</continent>
<continent>North America</continent>
<continent>South America</continent>
</world>
```
We can use `from-xml` to read the input like a `xml` file:
```shell
> open world.txt | from-xml
━━━━━━━━━━━━━━━━
world
────────────────
[table 7 rows]
━━━━━━━━━━━━━━━━
```