.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Catmandu::Exporter::Table 3pm"
.TH Catmandu::Exporter::Table 3pm "2023-02-11" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Catmandu::Exporter::Table \- ASCII/Markdown table exporter
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
With catmandu command line client:
.PP
.Vb 6
\&  echo \*(Aq{"one":"my","two":"table"} {"one":"is","two":"nice"}\*(Aq | \e 
\&  catmandu convert JSON \-\-multiline 1 to Table
\&  | one | two   |
\&  |\-\-\-\-\-|\-\-\-\-\-\-\-|
\&  | my  | table |
\&  | is  | nice  |
\&
\&  catmandu convert CSV to Table \-\-fields id,name \-\-columns ID,Name < sample.csv
\&  | ID | Name |
\&  |\-\-\-\-|\-\-\-\-\-\-|
\&  | 23 | foo  |
\&  | 42 | bar  |
\&  | 99 | doz  |
.Ve
.PP
In Perl scripts:
.PP
.Vb 6
\&  use Catmandu::Exporter::Table;
\&  my $exp = Catmandu::Exporter::Table\->new;
\&  $exp\->add({ title => "The Hobbit", author => "Tolkien" });
\&  $exp\->add({ title => "Where the Wild Things Are", author => "Sendak" });
\&  $exp\->add({ title => "One Thousand and One Nights" });
\&  $exp\->commit;
\&
\&  | author  | title                       |
\&  |\-\-\-\-\-\-\-\-\-|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
\&  | Tolkien | The Hobbit                  |
\&  | Sendak  | Where the Wild Things Are   |
\&  |         | One Thousand and One Nights |
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This Catmandu::Exporter exports data in tabular form, formatted in
MultiMarkdown syntax.
.PP
The output can be used for simple display, for instance to preview Excel files
on the command line. Use Pandoc <http://johnmacfarlane.net/pandoc/> too
further convert to other table formats, e.g. \f(CW\*(C`latex\*(C'\fR, \f(CW\*(C`html5\*(C'\fR, \f(CW\*(C`mediawiki\*(C'\fR:
.PP
.Vb 1
\&    catmandu convert XLS to Table < sheet.xls | pandoc \-t html5
.Ve
.PP
By default columns are sorted alphabetically by field name.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
Table output can be controlled with the options \f(CW\*(C`fields\*(C'\fR, \f(CW\*(C`columns\*(C'\fR,
\&\f(CW\*(C`widths\*(C'\fR, and \f(CW\*(C`condense\*(C'\fR as documented in Text::MarkdownTable.
.IP "file" 4
.IX Item "file"
.PD 0
.IP "fh" 4
.IX Item "fh"
.IP "encoding" 4
.IX Item "encoding"
.IP "fix" 4
.IX Item "fix"
.PD
Standard options of <Catmandu:Exporter>
.IP "condense" 4
.IX Item "condense"
Write table in condense format with unaligned columns.
.IP "fields" 4
.IX Item "fields"
Field names as comma-separated list or array reference.
.IP "columns" 4
.IX Item "columns"
Column names as comma-separated list or array reference. By default field
names are used as column names.
.IP "header" 4
.IX Item "header"
Include header lines. Enabled by default.
.IP "widths" 4
.IX Item "widths"
Column widths as comma-separated list or array references. Calculated from all
rows by default. Long cell values can get truncated with this option.
.IP "schema" 4
.IX Item "schema"
Supply fields and (optionally) columns in a \s-1JSON\s0 Table
Schema <http://dataprotocols.org/json-table-schema/> as \s-1JSON\s0 file or hash
reference having the following structure:
.Sp
.Vb 7
\&  {
\&    "fields: [
\&      { "name": "field\-name\-1", "title": "column title 1 (optional)" },
\&      { "name": "field\-name\-2", "title": "column title 2 (optional)" },
\&      ...
\&    ]
\&  }
.Ve
.SH "METHODS"
.IX Header "METHODS"
See Catmandu::Exporter
.SH "SEE ALSO"
.IX Header "SEE ALSO"
This module is based on Text::MarkdownTable.
.PP
Similar Catmandu Exporters for tabular data include
Catmandu::Exporter::CSV, Catmandu::Exporter::XLS, and
Catmandu::Exporter::XLSX.